com.webmethods.portal.service.portlet.info

Interface IPortletMethodInfo

public interface IPortletMethodInfo

Metadata for the portlet controller method.

<!-- controller tag defines portlet controller layouts and methods --> <controller beanSelfDestructLimit="-1" > <!-- this methods tag groups methods for webapplication access --> <methods> <!-- method tag defines portlet method The meaning of the various attributes are as follows: name the name of the method. This name must be exactly the same as the name of the java method on the portlet bean possible values: any valid java identifier caption friendly method name which may be used in the UI possible values: any text layout default layout for this method. possible values: valid portlet layout defined using layout tag errorLayout default error layout for this method. possible values: valid portlet layout defined using layout tag clearState whether this method clear the portlet controller session bean state possible values: "false" - the method does not clear the session state after its done "before" - the method clears the session state before the invocation "after" - the method clears not clear the session state after the invocation --> <method name="method1" caption="Method 1" layout="layout1" errorlayout="layout1" clearState="after" /> ... </methods> ... </controller>

See Also:

IPortletControllerInfo

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLEAR_STATE_AFTER
static String	CLEAR_STATE_BEFORE
static String	CLEAR_STATE_BOTH
static String	METHOD_CANCEL
static String	METHOD_RETURN
static String	METHOD_VOID

Method Summary

Modifier and Type	Method and Description
boolean	clearStateAfter() Returns whether the state of the portlet controller bean needs to be cleared right after the method invocation.
boolean	clearStateBefore() Returns true if the session state must be cleared before the method invocation and the parameters are loaded into the session bean
String	getCaption() Returns the method friendly name
IPortletLayoutInfo	getDefaultErrorLayout() Returns the method default error layout.
IPortletLayoutInfo	getDefaultLayout() Returns the default layout for this method.
String	getImplementation() Returns method implementation
Method	getMethod() Returns java reflection object for the portlet method.
String	getName() Returns the method name
String[]	getParamNames() Deprecated.
IPortletMethodParamInfo[]	getParams() Deprecated.
Class<?>[]	getParamTypes() Deprecated.
boolean	hasDefaultErrorLayout() Returns whether the mathod has default error layout
boolean	hasDefaultLayout() Returns whether the method has a default layout
boolean	hasImplementation() Returns whether the method has the implemenation
boolean	isAxsrft() True if this method requires an anti-cross-site-request-forgery token.
void	setAxsrft(boolean axsrft) True if this method requires an anti-cross-site-request-forgery token.
void	setCaption(String caption) Sets the method new caption
void	setClearState(String clearState) Sets the method clear state behavior
void	setErrorLayout(String errorLayout) Sets the method new error layout
void	setImplementation(String implementation) Sets the implementation method name for the portlet controller method.
void	setLayout(String layout) Sets the method new default layout
void	setName(String name) Sets the method name

Field Detail

METHOD_RETURN

static final String METHOD_RETURN

See Also:

Constant Field Values

METHOD_CANCEL

static final String METHOD_CANCEL

See Also:

Constant Field Values

METHOD_VOID

static final String METHOD_VOID

See Also:

Constant Field Values

CLEAR_STATE_BEFORE

static final String CLEAR_STATE_BEFORE

See Also:

Constant Field Values

CLEAR_STATE_AFTER

static final String CLEAR_STATE_AFTER

See Also:

Constant Field Values

CLEAR_STATE_BOTH

static final String CLEAR_STATE_BOTH

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the method name

Returns:

the method name

getDefaultLayout

IPortletLayoutInfo getDefaultLayout()

Returns the default layout for this method. This layout will be rendered right after the method invocation if it's not set programatically or using the portlet controller request parameters.

Returns:

the layout info of the default

See Also:

IPortletControllerBean.setLayout(java.lang.String)

hasDefaultLayout

boolean hasDefaultLayout()

Returns whether the method has a default layout

Returns:

true if the method has a default layout

getDefaultErrorLayout

IPortletLayoutInfo getDefaultErrorLayout()

Returns the method default error layout. This layout will be rendered if the method invocation throws an exception. The error layout can be set programatically or using the portlet controller request parameters.

Returns:

layout info

See Also:

IPortletControllerBean.setErrorLayout(java.lang.String)

hasDefaultErrorLayout

boolean hasDefaultErrorLayout()

Returns whether the mathod has default error layout

Returns:

true if the method has default error layout

clearStateBefore

boolean clearStateBefore()

Returns true if the session state must be cleared before the method invocation and the parameters are loaded into the session bean

Returns:

true if the state needs to be cleared before the method execution

clearStateAfter

boolean clearStateAfter()

Returns whether the state of the portlet controller bean needs to be cleared right after the method invocation.

Returns:

true if the state of the portlet controller bean needs to be cleared.

setName

void setName(String name)

Sets the method name

Parameters:

name - new method name

setLayout

void setLayout(String layout)

Sets the method new default layout

Parameters:

layout - new layout name

setErrorLayout

void setErrorLayout(String errorLayout)

Sets the method new error layout

Parameters:

errorLayout - new error layout

setClearState

void setClearState(String clearState)

Sets the method clear state behavior

Parameters:

clearState - new behavior

See Also:

CLEAR_STATE_AFTER, CLEAR_STATE_BEFORE, CLEAR_STATE_BOTH

getCaption

String getCaption()

Returns the method friendly name

Returns:

method caption

setCaption

void setCaption(String caption)

Sets the method new caption

Parameters:

caption - new caption

getParams

@Deprecated
IPortletMethodParamInfo[] getParams()

Deprecated.

getParamNames

@Deprecated
String[] getParamNames()

Deprecated.

getParamTypes

@Deprecated
Class<?>[] getParamTypes()
                              throws ClassNotFoundException

Deprecated.

Throws:

ClassNotFoundException

setImplementation

void setImplementation(String implementation)

Sets the implementation method name for the portlet controller method. Commonly this is the same as getName() and means the name of the method of the IPortletBean implementation class.

Parameters:

implementation - the implementation

getImplementation

String getImplementation()

Returns method implementation

Returns:

implementation for the method

See Also:

setImplementation(java.lang.String)

hasImplementation

boolean hasImplementation()

Returns whether the method has the implemenation

Returns:

false if the method has no implementation

isAxsrft

boolean isAxsrft()

True if this method requires an anti-cross-site-request-forgery token.

setAxsrft

void setAxsrft(boolean axsrft)

True if this method requires an anti-cross-site-request-forgery token.

getMethod

Method getMethod()
          throws ClassNotFoundException,
                 NoSuchMethodException

Returns java reflection object for the portlet method. This object is used to call the portlet method. The method name is identified by the getImplementation().

Returns:

java reflection method object

Throws:

ClassNotFoundException

NoSuchMethodException