com.webmethods.portal.service.portlet.info

Interface IPortletControllerInfo

public interface IPortletControllerInfo

Portlet controller descriptor.

The information is parsed from the portlet descriptor xml file.

<!-- controller tag defines portlet controller layouts and methods --> <controller beanSelfDestructLimit="-1" > <!-- layouts tag groups layouts --> <layouts> <!-- layout tag defines portlet layout The meaning of the various attributes are as follows: name layout logical name possible values: any valid java identifier implementation URI for this logical layout possible values: any valid URI of the layout (jsp) caption friendly name of the layout possible values: any text readonly whether or not the popup layout is readonly possible values: "true" - the popup layout is readonly "false" - the popup layout is fully functional default whether this layout is default one possible values: "true" - the layout is default "false" - the layout is not default --> <layout name="layout1" implementation="layout1" caption="Layout 1" readonly="false" default="true" /> ... </layouts> <!-- 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>

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_NONE Pre PCA portlet that have been converted to PCA automatically at load time
static String	TYPE_NONE_NAME
static int	TYPE_RESTFUL RESTful PCA implementation
static String	TYPE_RESTFUL_NAME
static int	TYPE_SESSION Original type of PCA that stores state on the session
static String	TYPE_SESSION_NAME

Method Summary

Modifier and Type	Method and Description
String	getBeanClassName() Returns the portlet controller bean implementation class that must implement IPortletControllerBean interface.
int	getBeanSelfDestructLimit() Returns portlet controller bean self destruction limit
IPortletLayoutInfo	getDefaultLayout() Returns the default layout info
IPortletLayoutInfo	getLayout(int index) Returns IPortletLayoutInfo for the layout with the given index
IPortletLayoutInfo	getLayout(String name) Returns IPortletLayoutInfo for the layout with the given name
IPortletLayoutInfo[]	getLayouts() Returns array of all portlet layouts
IPortletMethodInfo	getMethod(String name) Returns IPortletMethodInfo object for the method with the given name.
IPortletMethodInfo	getMethod(String name, String group) Deprecated.
IPortletMethodGroupInfo	getMethodGroup(String group) Deprecated.
IPortletMethodGroupInfo[]	getMethodGroups() Deprecated.
int	getType() Returns controller implementation type
boolean	hasLayout(String name) Checks whether the portlet controller has the given layout defined
void	setBeanClassName(String beanClassName) Sets class name for the portlet controller implementation class
void	setBeanSelfDestructLimit(int beanSelfDestructLimit) Sets a new bean self desctruction limit number.

Field Detail

TYPE_NONE

static final int TYPE_NONE

Pre PCA portlet that have been converted to PCA automatically at load time

See Also:

Constant Field Values

TYPE_NONE_NAME

static final String TYPE_NONE_NAME

See Also:

Constant Field Values

TYPE_SESSION

static final int TYPE_SESSION

Original type of PCA that stores state on the session

See Also:

Constant Field Values

TYPE_SESSION_NAME

static final String TYPE_SESSION_NAME

See Also:

Constant Field Values

TYPE_RESTFUL

static final int TYPE_RESTFUL

RESTful PCA implementation

See Also:

Constant Field Values

TYPE_RESTFUL_NAME

static final String TYPE_RESTFUL_NAME

See Also:

Constant Field Values

Method Detail

getBeanClassName

String getBeanClassName()

Returns the portlet controller bean implementation class that must implement IPortletControllerBean interface.

Returns:

class name

setBeanClassName

void setBeanClassName(String beanClassName)

Sets class name for the portlet controller implementation class

Parameters:

beanClassName - new bean class name

getBeanSelfDestructLimit

int getBeanSelfDestructLimit()

Returns portlet controller bean self destruction limit

Returns:

limit for bean self destruction

setBeanSelfDestructLimit

void setBeanSelfDestructLimit(int beanSelfDestructLimit)

Sets a new bean self desctruction limit number. This limit controls the number of requests that should go else where other than the portlet to clear the portlet controller bean state.

Parameters:

beanSelfDestructLimit - new value

getType

int getType()

Returns controller implementation type

Returns:

controller type

See Also:

TYPE_NONE, TYPE_SESSION, TYPE_RESTFUL

getLayouts

IPortletLayoutInfo[] getLayouts()

Returns array of all portlet layouts

Returns:

array of IPortletLayoutInfo

getMethodGroups

@Deprecated
IPortletMethodGroupInfo[] getMethodGroups()

Deprecated.

hasLayout

boolean hasLayout(String name)

Checks whether the portlet controller has the given layout defined

Parameters:

name - the layout name

Returns:

true if the layout is defined

getLayout

IPortletLayoutInfo getLayout(String name)

Returns IPortletLayoutInfo for the layout with the given name

Parameters:

name - the layout name

Returns:

LayoutInfo object for the layout

getLayout

IPortletLayoutInfo getLayout(int index)

Returns IPortletLayoutInfo for the layout with the given index

Parameters:

index - the layout index

Returns:

LayoutInfo object about the layout

getDefaultLayout

IPortletLayoutInfo getDefaultLayout()

Returns the default layout info

Returns:

LayoutInfo object about the default layout

getMethodGroup

@Deprecated
IPortletMethodGroupInfo getMethodGroup(String group)

Deprecated.

getMethod

IPortletMethodInfo getMethod(String name)

Returns IPortletMethodInfo object for the method with the given name.

Parameters:

name - the name of the method

Returns:

MethodInfo object

getMethod

@Deprecated
IPortletMethodInfo getMethod(String name,
                                         String group)

Deprecated.