com.ibm.portal.state
Interface PortletStateManagerController

All Superinterfaces:

Disposable, Identifiable, PortletStateManager, ServerContextProvider, StateManagerService

public interface PortletStateManagerController
extends PortletStateManager

This interface provides access to the StateManager for portlets. See PortletStateManagerService for further details on how to access the portlet state manager.

Since:

5.1

Method Summary

PortletAccessorController	getPortletAccessorController() Gets a portlet accessor controller that operates on the request-specific state holder.
StateHolderController	getStateHolderController() Gets a controller interface to the current request-specific state holder.

Methods inherited from interface com.ibm.portal.state.PortletStateManager

getAccessorFactory, getPortletAccessor, getPortletAccessor, getPortletAccessorController, getPortletTargetAccessorController, getPortletTargetAccessorController, getStateHolder, newResourceURL, newURL, newURL, newURL, newURL

Methods inherited from interface com.ibm.portal.state.service.StateManagerService

getServerContext, getURLFactory, getURLFactory

Methods inherited from interface com.ibm.portal.Disposable

dispose

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Method Detail

getPortletAccessorController

PortletAccessorController getPortletAccessorController()
                                                       throws StateNotInRequestException,
                                                              StateNotWriteableException

Gets a portlet accessor controller that operates on the request-specific state holder.

Returns:

Returns an accessor controller that allows for reading and writing portlet-specific state. Not null.

Throws:

StateNotInRequestException - If the request-specific state holder is not available.

StateNotWriteableException - If a state holder can be associated with a request but the state is read-only.

getStateHolderController

StateHolderController getStateHolderController()
                                               throws StateNotInRequestException,
                                                      StateNotWriteableException

Gets a controller interface to the current request-specific state holder.
NOTE: The StateHolderController returned by this method must not be disposed as this is the request and no URL specific instance.

Returns:

Controller interface to the request-specific state. Not null.

Throws:

StateNotInRequestException - If the request-specific state holder is not available.

StateNotWriteableException - If the request-specific state holder is read-only.