|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletAccessor
Interface providing read-only accessor methods which allow for inspecting
state information related to the portlet this accessor operates on, in
particular portlet mode, window state, and render parameters.
Note that this accessor is suitable for legacy portlets as well as standard
portlets.
Any implementation of this interface should ensure that also the return types
(e.g. the render parameter map) are not modifiable.
Method Summary | |
---|---|
java.lang.String |
getDigest()
Returns a string that represents a hash over the representation of the portlet window for its current navigational state. |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameters()
Returns a map of portlet parameters (String -> String[]). |
javax.portlet.PortletMode |
getPortletMode()
Returns the current portlet mode. |
javax.portlet.PortletMode |
getPortletMode(javax.portlet.PortletMode defaultMode)
Returns the current portlet mode. |
javax.portlet.WindowState |
getWindowState()
Returns the current window state. |
javax.portlet.WindowState |
getWindowState(javax.portlet.WindowState defaultState)
Returns the current window state. |
Methods inherited from interface com.ibm.portal.Identifiable |
---|
getObjectID |
Methods inherited from interface com.ibm.portal.Disposable |
---|
dispose |
Method Detail |
---|
java.lang.String getDigest()
null
if the
digest could not be computedjava.util.Map<java.lang.String,java.lang.String[]> getParameters()
null
.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.PortletMode getPortletMode(javax.portlet.PortletMode defaultMode) throws InvalidPortletModeException
defaultMode
- the mode returned if no portlet-state is set explicitly in the
state object
PortletMode
or the default portlet mode.
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
).javax.portlet.WindowState getWindowState(javax.portlet.WindowState defaultState) throws InvalidWindowStateException
defaultState
- the state returned if no window-state is set explicitly in the
state object
WindowState
or the default window. 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
).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |