|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RenderEventResponse
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.
Method Summary | |
---|---|
ObjectID |
getObjectID()
Returns the ObjectID of the addressed portlet window. |
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[]). |
javax.portlet.PortletMode |
getPortletMode()
Returns the current portlet mode. |
javax.portlet.WindowState |
getWindowState()
Returns the current window state. |
void |
setDigest(java.lang.String digest)
Assigns a new digest |
void |
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 |
---|
ObjectID getObjectID()
ObjectID
of the addressed portlet window.
getObjectID
in interface Identifiable
null
java.util.Map<java.lang.String,java.lang.String[]> getParameters()
getParameters
in interface ParameterAccessor
getParameters
in interface ParameterAccessorController
null
but potentially the empty map.javax.portlet.PortletMode getPortletMode() throws InvalidPortletModeException
PortletMode
or the default portlet mode
'View'. Does not return null
.
InvalidPortletModeException
- - if the portlet mode found in the state holder is invalid
(e.g. if it cannot be converted to PortletMode
).javax.portlet.WindowState getWindowState() throws InvalidWindowStateException
WindowState
or the default window state
'Normal'. Does not return null
).
InvalidWindowStateException
- - if the window state found in the state holder is invalid
(e.g. if it cannot be converted to WindowState
).void setDigest(java.lang.String digest)
digest
- the new digest or null
void setPortletMode(javax.portlet.PortletMode mode)
mode
- New portlet mode (must not be null
).void setWindowState(javax.portlet.WindowState state)
state
- New window state (must not be null
).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |