IPortletControllerBean (server-common-api)

All Superinterfaces:

IPropertyBag

All Known Subinterfaces:

IPortletController
```
public interface IPortletControllerBean
extends IPropertyBag
```
Portlet controller bean is the state information for the portlet controller. It is stored per portlet instance in the user's session.

The portlet controller bean is available on the portlet bean via IPortletBean.getControllerBean(). If this method returns null the portlet controller is not configured in the portlet descriptor

The configuration of the portlet controller is done in the portlet descriptor. Please see IPortletControllerInfo for more details

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LAYOUT_PARAM` Parameter name for the portlet layout to render
`static String`	`METHOD_PARAM` Parameter name for the portlet method to invoke
`static String`	`PCB_KEY` Key for the portlet controller bean stored in the user session

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`cleanup(IContext context)` Cleanup procedure that handles state 'expiration'
`void`	`clear()` Clears the portlet controller state
`Throwable`	`getException()` Returns the current exception or null if there is no exception
`String`	`getLayout()` Returns the current layout during render request and last render layout during action request unless overwritten with `setLayout(String)`
`IPortletLayoutInfo`	`getLayoutInfo()` Returns current layout info
`IPortletMethodInfo`	`getMethodInfo()` Returns the requested method info.
`javax.portlet.PortletMode`	`getPortletMode()`
`String`	`getPrevLayout()` Returns the previous layout name
`String`	`getReturnUrl()` Returns the current return url.
`IThingID`	`getThingID()` Returns the portlet thing id
`javax.portlet.WindowState`	`getWindowState()`
`boolean`	`hasException()` Returns whether there is an exception currently set
`boolean`	`isMethodRequested()` Returns true if the portlet method invocation is requested
`void`	`setErrorLayout(String layout)` Sets the current error layout by its name
`void`	`setException(Throwable e)` Sets the exception object to show on the error page
`void`	`setLayout(String layout)` Sets a new layout by its name.
`void`	`setPortletMode(javax.portlet.PortletMode portletMode)`
`void`	`setReturnUrl(String returnUrl)` Sets a new return url.
`void`	`setThingID(IThingID portletThingID)` Sets the portlet instance thing id
`void`	`setWindowState(javax.portlet.WindowState windowState)`

Methods inherited from interface com.webmethods.rtl.util.obj.IPropertyBag
assignProperties, createCopy, getProperties, getProperty, load, load, load, save, save, setProperties, setProperty

- Field Detail
  - METHOD_PARAM
```
static final String METHOD_PARAM
```
    Parameter name for the portlet method to invoke
    
    See Also:
    
    Constant Field Values
  - LAYOUT_PARAM
```
static final String LAYOUT_PARAM
```
    Parameter name for the portlet layout to render
    
    See Also:
    
    Constant Field Values
  - PCB_KEY
```
static final String PCB_KEY
```
    Key for the portlet controller bean stored in the user session
- Method Detail
  - setThingID
```
void setThingID(IThingID portletThingID)
         throws PortalException
```
    Sets the portlet instance thing id
    
    Parameters:
    
    portletThingID - portlet thing id
    
    Throws:
    
    PortalException
  - getThingID
```
IThingID getThingID()
```
    Returns the portlet thing id
    
    Returns:
    
    thing id of the portlet being controlled
  - isMethodRequested
```
boolean isMethodRequested()
```
    Returns true if the portlet method invocation is requested
    
    Returns:
    
    true if the portlet controller is requiested to execute a portlet method
  - getMethodInfo
```
IPortletMethodInfo getMethodInfo()
                          throws PortalException
```
    Returns the requested method info. Only valid during action requests
    
    Returns:
    
    portlet method info or null
    
    Throws:
    
    PortalException
  - getLayoutInfo
```
IPortletLayoutInfo getLayoutInfo()
                          throws PortalException
```
    Returns current layout info
    
    Returns:
    
    current layout info object
    
    Throws:
    
    PortalException
  - getLayout
```
String getLayout()
```
    Returns the current layout during render request and last render layout during action request unless overwritten with setLayout(String)
    
    Returns:
    
    the current layout name
  - setLayout
```
void setLayout(String layout)
```
    Sets a new layout by its name. Only valid during action requst processing, i.e. inside PCA method implementation
    
    Parameters:
    
    layout - new layout name
  - getPrevLayout
```
String getPrevLayout()
```
    Returns the previous layout name
    
    Returns:
    
    the previous layout name if available, otherwise null
  - setErrorLayout
```
void setErrorLayout(String layout)
```
    Sets the current error layout by its name
    
    Parameters:
    
    layout - the layout name to display the portlet errors
  - setException
```
void setException(Throwable e)
```
    Sets the exception object to show on the error page
    
    Parameters:
    
    e - the exception object or null
  - getException
```
Throwable getException()
```
    Returns the current exception or null if there is no exception
    
    Returns:
    
    exception object or null
  - hasException
```
boolean hasException()
```
    Returns whether there is an exception currently set
    
    Returns:
    
    true if there is an exception object available
  - getReturnUrl
```
String getReturnUrl()
```
    Returns the current return url. The return url defines the redirection url for the user agent
    
    Returns:
    
    current return url
  - setReturnUrl
```
void setReturnUrl(String returnUrl)
```
    Sets a new return url. Only valid during action request processing inside PCA method implementation
    
    Parameters:
    
    returnUrl - url to use for the redirect
  - clear
```
void clear()
```
    Clears the portlet controller state
  - cleanup
```
boolean cleanup(IContext context)
```
    Cleanup procedure that handles state 'expiration'
    
    Parameters:
    
    context -
    
    Returns:
    
    true if the state is expired
  - setPortletMode
```
void setPortletMode(javax.portlet.PortletMode portletMode)
```
  - setWindowState
```
void setWindowState(javax.portlet.WindowState windowState)
```
  - getPortletMode
```
javax.portlet.PortletMode getPortletMode()
```
  - getWindowState
```
javax.portlet.WindowState getWindowState()
```

Interface IPortletControllerBean

Field Summary

Method Summary

Methods inherited from interface com.webmethods.rtl.util.obj.IPropertyBag

Field Detail

METHOD_PARAM

LAYOUT_PARAM

PCB_KEY

Method Detail

setThingID

getThingID

isMethodRequested

getMethodInfo

getLayoutInfo

getLayout

setLayout

getPrevLayout

setErrorLayout

setException

getException

hasException

getReturnUrl

setReturnUrl

clear

cleanup

setPortletMode

setWindowState

getPortletMode

getWindowState