Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.resolver.portlet
Interface RenderEventResponse
- All Superinterfaces:
- DigestProvider, Identifiable, ParameterAccessor, ParameterAccessorController
public interface RenderEventResponse- extends Identifiable, ParameterAccessorController, DigestProvider
Represents the state of the portlet window that has registered for the render event. The Identifiable interface refers to the ObjectID of the portlet window and the ParameterAccessorController to the private render parameters of the portlet window.
- Since:
- 6.1.0
Method Summary ObjectID getObjectID()
Return the ObjectID of the addressed portlet window.java.util.Map<java.lang.String,java.lang.String[]> getParameters()
Return a map of private and public render parameters of the addressed portlet window (String -> String[]).javax.portlet.PortletMode getPortletMode()
Return the current portlet mode.javax.portlet.WindowState getWindowState()
Return the current window state.void setDigest(java.lang.String digest)
Assigns a new digestvoid setPortletMode(javax.portlet.PortletMode mode)
Assigns a new portlet mode.void setWindowState(javax.portlet.WindowState state)
Assigns a new window state.
Methods inherited from interface com.ibm.portal.resolver.accessors.url.ParameterAccessorController addParameter, addParameters, removeParameter, setParameter, setParameters
Methods inherited from interface com.ibm.portal.resolver.accessors.url.ParameterAccessor getParameter, getParameter, getParameters, getParameters
Methods inherited from interface com.ibm.portal.resolver.accessors.DigestProvider getDigest
Method Detail getObjectID
ObjectID getObjectID()
- Returns the ObjectID of the addressed portlet window.
- Specified by:
- getObjectID in interface Identifiable
- Returns:
- the ObjectID of the portlet window, this can never be null
getParameters
java.util.Map<java.lang.String,java.lang.String[]> getParameters()
- Returns a map of private and public render parameters of the addressed portlet window (String -> String[]). It is guaranteed that this map is modifiable.
- Specified by:
- getParameters in interface ParameterAccessor
- Specified by:
- getParameters in interface ParameterAccessorController
- Returns:
- A modifiable map of parameters. Does not return null but potentially the empty map.
getPortletMode
javax.portlet.PortletMode getPortletMode() throws InvalidPortletModeException
- Returns the current portlet mode. If there is no portlet mode information in the state holder, the portlet mode 'View' will be returned.
- Returns:
- The current PortletMode or the default portlet mode 'View'. Does not return null.
- Throws:
- InvalidPortletModeException - - if the portlet mode found in the state holder is invalid (e.g. if it cannot be converted to PortletMode).
getWindowState
javax.portlet.WindowState getWindowState() throws InvalidWindowStateException
- Returns the current window state. If there is no window state information in the state holder, the window state 'Normal' will be returned.
- Returns:
- The current WindowState or the default window state 'Normal'. Does not return null).
- Throws:
- InvalidWindowStateException - - if the window state found in the state holder is invalid (e.g. if it cannot be converted to WindowState).
setDigest
void setDigest(java.lang.String digest)
- Assigns a new digest
- Parameters:
- digest - the new digest or null
- Since:
- 8.5
setPortletMode
void setPortletMode(javax.portlet.PortletMode mode)
- Assigns a new portlet mode.
- Parameters:
- mode - New portlet mode (must not be null).
setWindowState
void setWindowState(javax.portlet.WindowState state)
- Assigns a new window state.
- Parameters:
- state - New window state (must not be null).
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD