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

All Superinterfaces:

Accessor, Disposable, Identifiable, PortletAccessor

All Known Subinterfaces:

LegacyPortletAccessorController

public interface PortletAccessorController
extends PortletAccessor

Interface providing write accessor methods which allow for modifying the state of the portlet (legacy or standard portlet) this accessor operates on. In particular, this controller allows to set render parameter, change the portlet mode, or change the window state.
Note: This API is not intended as a replacement for the URL generation of action and render 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:

5.1

Method Summary

java.util.Map<java.lang.String,java.lang.String[]>	getParameters() Returns a map of portlet parameters (String -> String[]).
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.state.accessors.portlet.PortletAccessor

getDigest, getPortletMode, getPortletMode, getWindowState, getWindowState

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

getParameters

java.util.Map<java.lang.String,java.lang.String[]> getParameters()

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

These parameters are prefilled with the portlet parameters encoded in the current state.

Specified by:

getParameters in interface PortletAccessor

Returns:

A modifiable map of render parameters. Does not return null.

setDigest

void setDigest(java.lang.String digest)

Assigns a new digest

Parameters:

digest - the new digest or null

Since:

8.0

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).