Overview  Package   Class  Tree  Serialized  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

All Superinterfaces:
AccessorFactory
public interface PortletAccessorFactory
extends AccessorFactory

Factory which provides a variety of accessors that allow to read /write portlet-related state information from /to a given state holder or document model.
The controllers may be used to create EngineURL s that modify the navigational state of portlets (e.g. portlet mode, window state, or render parameters). Just request a controller that operates on the state holder /document model that has been associated with the respective EngineURL.
Note that this factory provides accessors for IBM API-based portlets as well as for standard portlets.

Since:
5.1

Method Summary
 LegacyPortletAccessor getLegacyPortletAccessor(Node root, DocumentModel model)
          Provides a legacy accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentModel interface.
 LegacyPortletAccessor getLegacyPortletAccessor(ObjectID id, StateHolder state)
          Provides a legacy accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface.
 LegacyPortletAccessor getLegacyPortletAccessor(java.lang.String uniqueName, StateHolder state)
          Provides a legacy accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface.
 LegacyPortletAccessorController getLegacyPortletAccessorController(Node root, DocumentController model)
          Provides a legacy controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentController.
 LegacyPortletAccessorController getLegacyPortletAccessorController(ObjectID id, StateHolderController state)
          Provides a legacy controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController.
 LegacyPortletAccessorController getLegacyPortletAccessorController(java.lang.String uniqueName, StateHolderController state)
          Provides a legacy controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController.
 PortletAccessor getPortlet(Node root, DocumentModel model)
          Deprecated. since 6.0, use method getPortletAccessor(Node, DocumentModel) instead
 PortletAccessor getPortlet(ObjectID id, StateHolder state)
          Deprecated. since 6.0, use method getPortletAccessor(ObjectID, StateHolder) instead
 PortletAccessor getPortlet(java.lang.String uniqueName, StateHolder state)
          Deprecated. since 6.0, use method getPortletAccessor(String, StateHolder) instead
 PortletAccessor getPortletAccessor(Node root, DocumentModel model)
          Provides an accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentModel interface.
 PortletAccessor getPortletAccessor(ObjectID id, StateHolder state)
          Provides an accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface.
 PortletAccessor getPortletAccessor(java.lang.String uniqueName, StateHolder state)
          Provides an accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface.
 PortletAccessorController getPortletAccessorController(Node root, DocumentController model)
          Provides a controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentController.
 PortletAccessorController getPortletAccessorController(ObjectID id, StateHolderController state)
          Provides a controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController.
 PortletAccessorController getPortletAccessorController(java.lang.String uniqueName, StateHolderController state)
          Provides a controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController.
 PortletAccessorController getPortletController(Node root, DocumentController model)
          Deprecated. since 6.0, use method getPortletAccessorController(Node, StateHolderController) instead
 PortletAccessorController getPortletController(ObjectID id, StateHolderController state)
          Deprecated. since 6.0, use the method getPortletAccessorController(ObjectID, StateHolderController) instead.
 PortletAccessorController getPortletController(java.lang.String uniqueName, StateHolderController state)
          Deprecated. since 6.0, use method getPortletAccessorController(String, StateHolderController) instead
 PortletListAccessor getPortletListAccessor(Node root, DocumentModel model)
          Provides an accessor that allows for retrieving the list of portlets that are referenced in the navigational state using the given DocumentModel interface.
 PortletListAccessor getPortletListAccessor(StateHolder state)
          Provides an accessor that allows for retrieving the list of portlets that are referenced in the navigational state using the given StateHolder interface.
 PortletListAccessor getPortlets(Node root, DocumentModel model)
          Deprecated. since 6.0, use method getPortletListAccessor(Node, DocumentModel) instead
 PortletListAccessor getPortlets(StateHolder state)
          Deprecated. since 6.0, use method getPortletListAccessor(StateHolder) instead
 SharedStateAccessor getSharedStateAccessor(Node root, DocumentModel model)
          Provides an accessor that allows for reading the shared navigational state of a particular bucket (typically this includes shared render parameters).
 SharedStateAccessor getSharedStateAccessor(java.lang.String sharedStateID, StateHolder state)
          Provides an accessor that allows for reading the shared navigational state of a particular bucket (identified through a shared state id).
 SharedStateAccessorController getSharedStateAccessorController(Node root, DocumentController model)
          Provides a controller that allows for reading and writing the shared navigational state of a particular bucket (typically this includes shared render parameters).
 SharedStateAccessorController getSharedStateAccessorController(java.lang.String sharedStateID, StateHolderController state)
          Provides a controller that allows for reading and writing the shared navigational state of a particular bucket (identified through a shared state id).
 SharedStateListAccessor getSharedStateListAccessor(Node root, DocumentModel model)
          Provides an accessor that allows for retrieving the list of shared state buckets that are referenced in the navigational state using the given DocumentModel interface.
 SharedStateListAccessor getSharedStateListAccessor(StateHolder state)
          Provides an accessor that allows for retrieving the list of shared state buckets that are referenced in the navigational state using the given StateHolder interface.
 
Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory
compact
 

Method Detail

getPortletListAccessor

PortletListAccessor getPortletListAccessor(StateHolder state)
Provides an accessor that allows for retrieving the list of portlets that are referenced in the navigational state using the given StateHolder interface.

Parameters:
state - State holder that potentially contains portlet-specific navigational state. Must not be null.
Returns:
Read-only accessor to portlet-specific navigational state. Not null.

getPortletListAccessor

PortletListAccessor getPortletListAccessor(Node root,
                                           DocumentModel model)
Provides an accessor that allows for retrieving the list of portlets that are referenced in the navigational state using the given DocumentModel interface. The returned controller expects the information to be located in the subtree rooted at the given document node.

Parameters:
root - Root node for portlet-specific navigational state. Must not be null.
model - Model that contains the given root node. Must not be null.
Returns:
Read-only accessor to portlet-specific navigational state. Not null.

getPortletAccessor

PortletAccessor getPortletAccessor(ObjectID id,
                                   StateHolder state)
Provides an accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface. The portlet window is addressed via the given ObjectID.

Parameters:
id - ObjectID of the portlet window to access. Must not be null.
state - State holder that contains the navigational state that is associated with the addressed portlet window. Must not be null.
Returns:
Read-only accessor to the navigational state of a particular portlet window. Not null.

getPortletAccessor

PortletAccessor getPortletAccessor(java.lang.String uniqueName,
                                   StateHolder state)
                                   throws MissingUniqueNameException,
                                          UnknownUniqueNameException
Provides an accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface. The portlet window is addressed via the given String representing the unique name of the portlet window.

Parameters:
uniqueName - Unique name of the portlet window to access. Must not be null.
state - State holder that contains the navigational state that is associated with the addressed portlet window. Must not be null.
Returns:
Read-only accessor to the navigational state of a particular portlet window. Not null.
Throws:
UnknownUniqueNameException - If the given unique name cannot be mapped to the ObjectID of the portlet window.
MissingUniqueNameException - If the given unique name was either null or empty.

getPortletAccessor

PortletAccessor getPortletAccessor(Node root,
                                   DocumentModel model)
Provides an accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentModel interface. The returned accessor expects the navigational state information of the portlet window to be located in the subtree rooted at the given document node.

Parameters:
root - Root node of the subtree that holds the navigational state information of a particular portlet window. Must not be null.
model - Model that contains the given root. Must not be null.
Returns:
Read-only accessor to the portlet's state.

getLegacyPortletAccessor

LegacyPortletAccessor getLegacyPortletAccessor(ObjectID id,
                                               StateHolder state)
Provides a legacy accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface. The portlet window is addressed via the given ObjectID.

Parameters:
id - ObjectID of the portlet window to access. Must not be null.
state - State holder that contains the navigational state that is associated with the addressed portlet window. Must not be null.
Returns:
Read-only accessor to the navigational state of a particular portlet window. Not null.

getLegacyPortletAccessor

LegacyPortletAccessor getLegacyPortletAccessor(java.lang.String uniqueName,
                                               StateHolder state)
                                               throws MissingUniqueNameException,
                                                      UnknownUniqueNameException
Provides a legacy accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface. The portlet window is addressed via the given String representing the unique name of the portlet window.

Parameters:
uniqueName - Unique name of the portlet window to access. Must not be null.
state - State holder that contains the navigational state that is associated with the addressed portlet window. Must not be null.
Returns:
Read-only accessor to the navigational state of a particular portlet window. Not null.
Throws:
UnknownUniqueNameException - If the given unique name cannot be mapped to the ObjectID of the portlet window.
MissingUniqueNameException - If the given unique name was either null or empty.

getLegacyPortletAccessor

LegacyPortletAccessor getLegacyPortletAccessor(Node root,
                                               DocumentModel model)
Provides a legacy accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentModel interface. The returned accessor expects the navigational state information of the portlet window to be located in the subtree rooted at the given document node.

Parameters:
root - Root node of the subtree that holds the navigational state information of a particular portlet window. Must not be null.
model - Model that contains the given root. Must not be null.
Returns:
Read-only accessor to the navigational state of a particular portlet window. Not null.

getPortletAccessorController

PortletAccessorController getPortletAccessorController(ObjectID id,
                                                       StateHolderController state)
Provides a controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController. The portlet window is addressed via the given ObjectID.

Parameters:
id - ObjectID of the portlet window to access. Must not be null.
state - StateHolderController interface to the navigational state. Must not be null.
Returns:
Read-write accessor to the navigational state of a particular portlet window. Not null.

getPortletAccessorController

PortletAccessorController getPortletAccessorController(java.lang.String uniqueName,
                                                       StateHolderController state)
                                                       throws MissingUniqueNameException,
                                                              UnknownUniqueNameException
Provides a controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController. The portlet window is addressed via the given String representing the unique name of the portlet window.

Parameters:
uniqueName - Unique name of the portlet window to access. Must not be null.
state - StateHolderController interface to the navigational state. Must not be null.
Returns:
Read-write accessor to the navigational state of a particular portlet window. Not null.
Throws:
UnknownUniqueNameException - If the unique name could not be mapped to an ObjectID of a portlet window.
MissingUniqueNameException - If the unique name was either null or empty.

getPortletAccessorController

PortletAccessorController getPortletAccessorController(Node root,
                                                       DocumentController model)
Provides a controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentController. The returned controller assumes that the navigational state of the particular portlet window is located in the subtree rooted at the given document node.

Parameters:
root - Root node of the navigational state of a particular portlet window. Must not be null.
model - Controller interface to the state document containing the given root node. Must not be null.
Returns:
Read-write accessor to the navigational state of a particular portlet window. Not null.

getLegacyPortletAccessorController

LegacyPortletAccessorController getLegacyPortletAccessorController(ObjectID id,
                                                                   StateHolderController state)
Provides a legacy controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController. The portlet window is addressed via the given ObjectID.

Parameters:
id - ObjectID of the portlet window to access. Must not be null.
state - StateHolderController interface to the navigational state. Must not be null.
Returns:
Read-write accessor to the navigational state of a particular portlet window. Not null.

getLegacyPortletAccessorController

LegacyPortletAccessorController getLegacyPortletAccessorController(java.lang.String uniqueName,
                                                                   StateHolderController state)
                                                                   throws MissingUniqueNameException,
                                                                          UnknownUniqueNameException
Provides a legacy controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController. The portlet window is addressed via the given String representing the unique name of the portlet window.

Parameters:
uniqueName - Unique name of the portlet window to access. Must not be null.
state - StateHolderController interface to the navigational state. Must not be null.
Returns:
Read-write accessor to the navigational state of a particular portlet window. Not null.
Throws:
UnknownUniqueNameException - If the unique name could not be mapped to an ObjectID of a portlet window.
MissingUniqueNameException - If the unique name was either null or empty.

getLegacyPortletAccessorController

LegacyPortletAccessorController getLegacyPortletAccessorController(Node root,
                                                                   DocumentController model)
Provides a legacy controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentController. The returned controller assumes that the navigational state of the particular portlet window is located in the subtree rooted at the given document node.

Parameters:
root - Root node of the navigational state of a particular portlet window. Must not be null.
model - Controller interface to the state document containing the given root node. Must not be null.
Returns:
Read-write accessor to the navigational state of a particular portlet window. Not null.

getPortlets

PortletListAccessor getPortlets(StateHolder state)
Deprecated. since 6.0, use method getPortletListAccessor(StateHolder) instead

Provides an accessor that allows for retrieving the list of portlets that are referenced in the navigational state using the given StateHolder interface.

Parameters:
state - State holder that potentially contains portlet-specific navigational state. Must not be null.
Returns:
Read-only accessor to portlet-specific navigational state. Not null.

getPortlets

PortletListAccessor getPortlets(Node root,
                                DocumentModel model)
Deprecated. since 6.0, use method getPortletListAccessor(Node, DocumentModel) instead

Provides an accessor that allows for retrieving the list of portlets that are referenced in the navigational state using the given DocumentModel interface. The returned controller expects the information to be located in the subtree rooted at the given document node.

Parameters:
root - Root node for portlet-specific navigational state. Must not be null.
model - Model that contains the given root node. Must not be null.
Returns:
Read-only accessor to portlet-specific navigational state. Not null.

getPortlet

PortletAccessor getPortlet(ObjectID id,
                           StateHolder state)
Deprecated. since 6.0, use method getPortletAccessor(ObjectID, StateHolder) instead

Provides an accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface. The portlet window is addressed via the given ObjectID.

Parameters:
id - ObjectID of the portlet window to access. Must not be null.
state - State holder that contains the navigational state that is associated with the addressed portlet window. Must not be null.
Returns:
Read-only accessor to the navigational state of a particular portlet window. Not null.

getPortlet

PortletAccessor getPortlet(java.lang.String uniqueName,
                           StateHolder state)
                           throws MissingUniqueNameException,
                                  UnknownUniqueNameException
Deprecated. since 6.0, use method getPortletAccessor(String, StateHolder) instead

Provides an accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolder interface. The portlet window is addressed via the given String representing the unique name of the portlet window.

Parameters:
uniqueName - Unique name of the portlet window to access. Must not be null.
state - State holder that contains the navigational state that is associated with the addressed portlet window. Must not be null.
Returns:
Read-only accessor to the navigational state of a particular portlet window. Not null.
Throws:
UnknownUniqueNameException - If the given unique name cannot be mapped to the ObjectID of the portlet window.
MissingUniqueNameException - If the given unique name was either null or empty.

getPortlet

PortletAccessor getPortlet(Node root,
                           DocumentModel model)
Deprecated. since 6.0, use method getPortletAccessor(Node, DocumentModel) instead

Provides an accessor that allows for reading the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentModel interface. The returned accessor expects the navigational state information of the portlet window to be located in the subtree rooted at the given document node.

Parameters:
root - Root node of the subtree that holds the navigational state information of a particular portlet window. Must not be null.
model - Model that contains the given root. Must not be null.
Returns:
Read-only accessor to the portlet's state.

getPortletController

PortletAccessorController getPortletController(ObjectID id,
                                               StateHolderController state)
Deprecated. since 6.0, use the method getPortletAccessorController(ObjectID, StateHolderController) instead.

Provides a controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController. The portlet window is addressed via the given ObjectID.

Parameters:
id - ObjectID of the portlet window to access. Must not be null.
state - StateHolderController interface to the navigational state. Must not be null.
Returns:
Read-write accessor to the navigational state of a particular portlet window. Not null.

getPortletController

PortletAccessorController getPortletController(java.lang.String uniqueName,
                                               StateHolderController state)
                                               throws MissingUniqueNameException,
                                                      UnknownUniqueNameException
Deprecated. since 6.0, use method getPortletAccessorController(String, StateHolderController) instead

Provides a controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given StateHolderController. The portlet window is addressed via the given String representing the unique name of the portlet window.

Parameters:
uniqueName - Unique name of the portlet window to access. Must not be null.
state - StateHolderController interface to the navigational state. Must not be null.
Returns:
Read-write accessor to the navigational state of a particular portlet window. Not null.
Throws:
UnknownUniqueNameException - If the unique name could not be mapped to an ObjectID of a portlet window.
MissingUniqueNameException - If the unique name was either null or empty.

getPortletController

PortletAccessorController getPortletController(Node root,
                                               DocumentController model)
Deprecated. since 6.0, use method getPortletAccessorController(Node, StateHolderController) instead

Provides a controller that allows for reading and writing the navigational state of a particular portlet window (typically this includes portlet mode, window state, and render parameters) using the given DocumentController. The returned controller assumes that the navigational state of the particular portlet window is located in the subtree rooted at the given document node.

Parameters:
root - Root node of the navigational state of a particular portlet window. Must not be null.
model - Controller interface to the state document containing the given root node. Must not be null.
Returns:
Read-write accessor to the navigational state of a particular portlet window. Not null.

getSharedStateAccessor

SharedStateAccessor getSharedStateAccessor(java.lang.String sharedStateID,
                                           StateHolder state)
                                           throws MissingSharedStateIdException
Provides an accessor that allows for reading the shared navigational state of a particular bucket (identified through a shared state id). Typically this includes the shared render parameters). The shared state is addressed via the given String representing the unique identifier of the shared state. Use SharedStateAccessor#KEY_GLOBAL_SHARED_PARAMETERS to obtain the global shared state.

Parameters:
sharedStateID - A String representing the identifier of the shared state.
state - State holder that contains the navigational state that is associated with the addressed shared state. Must not be null.
Returns:
Read-only accessor to the shared navigational state of a particular bucket or the global shared navigational state. Returns null if the given identifier for the shared state is unknown, i. e. if the state holder object does not contain a shared state for the given sharedStateID.
Throws:
MissingSharedStateIdException - If the given shared state id was either null or emtpy.
Since:
6.1.0

getSharedStateAccessorController

SharedStateAccessorController getSharedStateAccessorController(java.lang.String sharedStateID,
                                                               StateHolderController state)
                                                               throws MissingSharedStateIdException
Provides a controller that allows for reading and writing the shared navigational state of a particular bucket (identified through a shared state id). given StateHolderController. The shared state is addressed via the given String representing the unique identifier of the shared state. Use SharedStateAccessor#KEY_GLOBAL_SHARED_PARAMETERS to obtain a modifiable version of the global shared state.

Parameters:
sharedStateID - A String representing the identifier of the shared state.
state - StateHolderController interface to the navigational state. Must not be null.
Returns:
Read-Write accessor to the shared navigational state of a particular bucket or the global shared navigational state. Returns null if the given identifier for the shared state could is unknown.
Throws:
MissingSharedStateIdException
Since:
6.1.0

getSharedStateAccessor

SharedStateAccessor getSharedStateAccessor(Node root,
                                           DocumentModel model)
Provides an accessor that allows for reading the shared navigational state of a particular bucket (typically this includes shared render parameters). using the given DocumentController. The returned accessor assumes that the shared navigational state of the particular bucket is located in the subtree rooted at the given document node.

Parameters:
root - Root node of the shared navigational state of a particular bucket. Must not be null.
model - Model that contains the given root. Must not be null.
Returns:
Read-only accessor to the portlet's state. Not null.

getSharedStateAccessorController

SharedStateAccessorController getSharedStateAccessorController(Node root,
                                                               DocumentController model)
Provides a controller that allows for reading and writing the shared navigational state of a particular bucket (typically this includes shared render parameters). using the given DocumentController. The returned controller assumes that the shared navigational state of the particular bucket is located in the subtree rooted at the given document node.

Parameters:
root - Root node of the shared navigational state of a particular bucket. Must not be null.
model - Controller interface to the state document containing the given root node. Must not be null.
Returns:
Read-write accessor to the shared navigational state of a particular bucket or the global shared navigational state. Not null.
Since:
6.1.0

getSharedStateListAccessor

SharedStateListAccessor getSharedStateListAccessor(StateHolder state)
Provides an accessor that allows for retrieving the list of shared state buckets that are referenced in the navigational state using the given StateHolder interface.

Parameters:
state - State holder that potentially contains shared state specific navigational state. Must not be null.
Returns:
Read-only accessor to shared state specific navigational state. Not null.
Since:
6.1.0

getSharedStateListAccessor

SharedStateListAccessor getSharedStateListAccessor(Node root,
                                                   DocumentModel model)
Provides an accessor that allows for retrieving the list of shared state buckets that are referenced in the navigational state using the given DocumentModel interface. The returned accessor expects the information to be located in the subtree rooted at the given document node.

Parameters:
root - Root node for shared state specific navigational state. Must not be null.
model - Model that contains the given root node. Must not be null.
Returns:
Read-only accessor to shared state specific navigational state. Not null.
Since:
6.1.0
Overview  Package   Class  Tree  Serialized  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD