|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletWindowStateParameterService
Service for easily obtaining, setting and removing parameters for a portlet window in respect of a navigational state. Through using this service a caller does not have to check for the context the navigational state and the portlet window are in. Typically this service obtains, sets or removes the parameters in respect of (multiple items may be applicable at once):
Method Summary | |
---|---|
ContentPage |
getContentPage()
Method that can be used to obtain the content page this service operates on. |
ObjectID |
getObjectID()
Returns the object ID of the portlet window object this service operates on. |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameters()
Method for obtaining the parameters for the current (implied) portlet window and the navigation state this service operates on. |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameters(StateHolder state)
Method for obtaining the parameters for the portlet window this service operates on. |
PortletWindow |
getPortletWindow()
Returns the current portlet window |
java.util.Set<javax.xml.namespace.QName> |
getPublicParameterNames()
Returns a set of the name of the public render parameters for the current portlet window. |
java.util.Map<java.lang.String,java.lang.String[]> |
getRenderParameters(StateHolder state)
Method for obtaining the parameters for the portlet window this service operates on. |
StateHolder |
getStateHolder()
Method that can be used to obtain the state holder this service operates on. |
boolean |
removeParameters(StateHolderController state,
java.util.Collection<java.lang.String> keys)
Removes the given parameters from the given state. |
void |
setParameters(StateHolderController state,
java.util.Map<java.lang.String,java.lang.String[]> parameters)
Sets the given parameters to the state for the portlet window this service operates on. |
void |
setRenderParameters(StateHolderController state,
java.util.Map<java.lang.String,java.lang.String[]> parameters)
Sets the given parameters to the state ( as private or public render parameters) for the portlet window this service operates on. |
Methods inherited from interface com.ibm.portal.state.service.parameters.BaseStateParameterService |
---|
getPublicParameters, getPublicParameters, getPublicParameters, getPublicParameters, getPublicRenderParameterResolver, removePublicParameters, setPublicParameters |
Methods inherited from interface com.ibm.portal.Disposable |
---|
dispose |
Method Detail |
---|
ContentPage getContentPage()
null
ObjectID getObjectID()
getObjectID
in interface Identifiable
null
Identifiable.getObjectID()
java.util.Map<java.lang.String,java.lang.String[]> getParameters() throws StateParameterException
PortletRequest.getParameterMap()
if the portlet
window would call this method within the portlet methods (e. g.
GenericPortlet.render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
).
StateParameterException
java.util.Map<java.lang.String,java.lang.String[]> getParameters(StateHolder state) throws StateParameterException
PortletRequest.getParameterMap()
if the
given portlet window would call this method within the portlet methods
(e. g.
GenericPortlet.render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
).
state
- The state the parameters should be read from. Must not be
null
.
StateParameterException
- If an exception occured while manipulating the parametersPortletWindow getPortletWindow()
null
java.util.Set<javax.xml.namespace.QName> getPublicParameterNames()
null
but may be emptyjava.util.Map<java.lang.String,java.lang.String[]> getRenderParameters(StateHolder state) throws StateParameterException
PortletRequest.getParameterMap()
if the
given portlet window would call this method within the portlet methods
(e. g.
GenericPortlet.render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
).
state
- The state the parameters should be read from. Must not be
null
.
StateParameterException
- If an exception occured while manipulating the parametersStateHolder getStateHolder()
getStateHolder
in interface BaseStateParameterService
boolean removeParameters(StateHolderController state, java.util.Collection<java.lang.String> keys) throws StateParameterException
state
- The state to modify, i. e. the state where the parameters have
to be removed. Must not be null
.keys
- A Collection of Strings representing the parameter keys which
should be removed by this service. Must not be
null
.
true
if the state changed as a result of the call
StateParameterException
- If an exception occured while manipulating the parametersvoid setParameters(StateHolderController state, java.util.Map<java.lang.String,java.lang.String[]> parameters) throws StateParameterException
state
- The state to modify, i. e. the state where the parameters have
to be added. Must not be null
.parameters
- The parameters which have to be added to the state. Must not
be null
. The map must not contain
null
keys. However null
values are
allowed and indicate that this parameter has to be deleted.
StateParameterException
- If an exception occured while manipulating the parametersvoid setRenderParameters(StateHolderController state, java.util.Map<java.lang.String,java.lang.String[]> parameters) throws StateParameterException
state
- The state to modify, i. e. the state where the parameters have
to be added. Must not be null
.parameters
- The render parameters which have to be added to the state.
Must not be null
. The map must not contain
null
keys. However null
values are
allowed and indicate that this parameter has to be deleted.
StateParameterException
- If an exception occured while manipulating the parameters
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |