com.ibm.portal.state.accessors.portlet
Interface SharedStateAccessorController

All Superinterfaces:

Accessor, Disposable, SharedStateAccessor, SharedStateIdentifierProvider

public interface SharedStateAccessorController
extends SharedStateAccessor

Interface providing write accessor methods which allow for modifying the shared state of portlets this accessor operates on. In particular, this controller allows to set public render parameters of the currently selected bucket.

Note that public render parameters can be set and read through this accessor by any standard portlets. Though these parameters can neither be obtained or set through the portlet api (in particular javax.portal.PortletRequest#getParameterMap()) nor through the StateParameterService.

Note: This API is not intended as a replacement for the URL generation of action, render or resource links that are present in the Portlet API. Portlets should use this API only for use cases that are not addressed by the Portlet API, like generating links to other portlets.

Since:

6.1.0

See Also:

for read-only access to the shared state.

Field Summary

Fields inherited from interface com.ibm.portal.state.accessors.portlet.SharedStateAccessor

KEY_GLOBAL_PUBLIC_RENDER_PARAMETERS, PORTAL_PATH_INFO_LOCALPART, PORTAL_PATH_INFO_QNAME, PORTAL_PUBLIC_RENDER_PARAMETERS_URI, VALUE_ASSIGNED_PAGE_PUBLIC_RENDER_PARAMETERS, VALUE_PAGE_PUBLIC_RENDER_PARAMETERS

Method Summary

java.util.Map<javax.xml.namespace.QName,java.lang.String[]>

getParameters() Returns a map of public render parameters (String -> String[]).

Methods inherited from interface com.ibm.portal.state.accessors.portlet.SharedStateAccessor

getParameter, getParameter, getParameters, getParameters

Methods inherited from interface com.ibm.portal.state.accessors.portlet.SharedStateIdentifierProvider

getIdentifier

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

getParameters

java.util.Map<javax.xml.namespace.QName,java.lang.String[]> getParameters()

Returns a map of public render parameters (String -> String[]). It is guaranteed that this map is modifiable.

These parameters are prefilled with the public render parameters of the currently selected bucket encoded in the current state.

Specified by:

getParameters in interface SharedStateAccessor

Returns:

A modifiable map of public render parameters. If there are no public render parameters at all, an empty (but modifiable) map is returned. Does not return null.

See Also:

for read-only access to the public render parameters