|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletStateManager
This interface provides access to the state manager for portlets. See
PortletStateManagerService
for
further details on how to access the portlet state manager.
The following accessor factories can be obtained using the
getAccessorFactory()
method:
SelectionAccessorFactory
PortletAccessorFactory
PortletTargetAccessorFactory
SoloAccessorFactory
ThemeTemplateAccessorFactory
LocaleAccessorFactory
Method Summary | ||
---|---|---|
|
getAccessorFactory(java.lang.Class<T> cls)
Get a factory that generates an accessor for typed access on the state holder. |
|
PortletAccessor |
getPortletAccessor()
Gets a portlet accessor that operates on the request-specific state holder. |
|
PortletAccessor |
getPortletAccessor(StateHolder state)
Gets a portlet accessor for the given state holder. |
|
PortletAccessorController |
getPortletAccessorController(StateHolderController stateCtrl)
Gets a portlet controller that operates on the given state. |
|
PortletTargetAccessorController |
getPortletTargetAccessorController()
Returns a controller which allows for declaring a portlet as the target of an action or render link that encodes the given state document. |
|
PortletTargetAccessorController |
getPortletTargetAccessorController(StateHolderController state)
Returns a accessor controller which allows for declaring a portlet as the target of an action or render link that encodes the given state document. |
|
StateHolder |
getStateHolder()
Gets the current request-specific state holder. |
|
ResourceURLAccessor |
newResourceURL()
Deprecated. Use the corresponding method in URLFactory instead. |
|
EngineURL |
newURL(Constants.Clone type)
Deprecated. Use the corresponding method in URLFactory instead. |
|
EngineURL |
newURL(StateHolder state,
Constants.Clone type)
Deprecated. Use the corresponding method in URLFactory instead. |
|
EngineURL |
newURL(StateHolder state,
URLContext allowedContext,
Constants.Clone type)
Deprecated. Use the corresponding method in URLFactory instead. |
|
EngineURL |
newURL(URLContext allowedContext,
Constants.Clone type)
Deprecated. Use the corresponding method in URLFactory instead. |
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 |
---|
<T> T getAccessorFactory(java.lang.Class<T> cls) throws UnknownAccessorTypeException, CannotInstantiateAccessorException
getAccessorFactory
in interface StateManagerService
cls
- Class object for the accessor factory type (not for the implementation class of
the accessor!)
UnknownAccessorTypeException
- The class object does not refer to a valid factory
CannotInstantiateAccessorException
- The factory type has been recognized, but the factory could not be instantiatedPortletTargetAccessorController getPortletTargetAccessorController() throws StateNotWriteableException, StateNotInRequestException
null
.
StateNotWriteableException
- If a state holder can be associated with a request but the
state is read-only.
StateNotInRequestException
- If the request-specific state is not available.PortletTargetAccessorController getPortletTargetAccessorController(StateHolderController state)
state
- StateHolder
to operate on. Must not be
null
.
null
.PortletAccessor getPortletAccessor() throws StateNotInRequestException
null
.
StateNotInRequestException
- If the request-specific state holder is not available.PortletAccessor getPortletAccessor(StateHolder state)
state
- The state holder on which the portlet accessor should operate
on. Must not be null
.
null
.PortletAccessorController getPortletAccessorController(StateHolderController stateCtrl)
stateCtrl
- The writable state on which the accessor should operate on.
Must not be null
.
null
.StateHolder getStateHolder() throws StateNotInRequestException
StateHolder
returned by this method
must not be disposed as this is the request and no URL specific
instance.
null
.
StateNotInRequestException
- If the request-specific state holder is not available.ResourceURLAccessor newResourceURL() throws ResourceUrlException, StateNotInRequestException
URLFactory
instead.
StateNotInRequestException
- -
if no state could be associated with the request
ResourceUrlException
- -
if the URL accessor could not be initializedEngineURL newURL(Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException, StateNotInRequestException
URLFactory
instead.
type
- type of the clone operation to get a copy of the state holder
for the URL, may be null in which case a SMART_COPY will be
generated.
CannotCloneDocumentModelException
- -
if the state could not be cloned
CannotCreateDocumentException
- -
if a wrapper around the state could not be created
InvalidConstantException
- -
if the clone type is not supported
StateNotInRequestException
- -
if no state could be associated with the requestEngineURL newURL(StateHolder state, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException
URLFactory
instead.
state
- state of the current portlet window (must not be null)type
- type of the clone operation to get a copy of the state holder
for the URL, may be null in which case a SMART_COPY will be
generated.
CannotCloneDocumentModelException
- -
if the state could not be cloned
CannotCreateDocumentException
- -
if a wrapper around the state could not be created
InvalidConstantException
- -
if the clone type is not supportedEngineURL newURL(StateHolder state, URLContext allowedContext, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException
URLFactory
instead.
state
- state of the current portlet window (must not be null)allowedContext
- specifies what type of URLs may be generated. May be null to
not limit the URL generationtype
- type of the clone operation to get a copy of the state holder
for the URL, may be null in which case a SMART_COPY will be
generated.
CannotCloneDocumentModelException
- -
if the state could not be cloned
CannotCreateDocumentException
- -
if a wrapper around the state could not be created
InvalidConstantException
- -
if the clone type is not supportedEngineURL newURL(URLContext allowedContext, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException, StateNotInRequestException
URLFactory
instead.
type
- type of the clone operation to get a copy of the state holder
for the URL, may be null in which case a SMART_COPY will be
generated.allowedContext
- specifies what type of URLs may be generated. May be null to
not limit the URL generation
CannotCloneDocumentModelException
- -
if the state could not be cloned
CannotCreateDocumentException
- -
if a wrapper around the state could not be created
InvalidConstantException
- -
if the clone type is not supported
StateNotInRequestException
- -
if no state could be associated with the request
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |