|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletAccessorFactory
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.
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 |
---|
PortletListAccessor getPortletListAccessor(StateHolder state)
StateHolder
interface.
state
- State holder that potentially contains portlet-specific
navigational state. Must not be null
.
null
.PortletListAccessor getPortletListAccessor(Node root, DocumentModel model)
DocumentModel
interface. The returned controller expects
the information to be located in the subtree rooted at the given document
node.
root
- Root node for portlet-specific navigational state. Must not be
null
.model
- Model that contains the given root node. Must not be
null
.
null
.PortletAccessor getPortletAccessor(ObjectID id, StateHolder state)
StateHolder
interface. The portlet window is addressed via the given
ObjectID
.
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
.
null
.PortletAccessor getPortletAccessor(java.lang.String uniqueName, StateHolder state) throws MissingUniqueNameException, UnknownUniqueNameException
StateHolder
interface. The portlet window is addressed via the given
String
representing the unique name of the portlet window.
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
.
null
.
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.PortletAccessor getPortletAccessor(Node root, DocumentModel model)
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.
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
.
LegacyPortletAccessor getLegacyPortletAccessor(ObjectID id, StateHolder state)
StateHolder
interface. The portlet window is addressed via
the given ObjectID
.
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
.
null
.LegacyPortletAccessor getLegacyPortletAccessor(java.lang.String uniqueName, StateHolder state) throws MissingUniqueNameException, UnknownUniqueNameException
StateHolder
interface. The portlet window is addressed via
the given String
representing the unique name of the
portlet window.
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
.
null
.
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.LegacyPortletAccessor getLegacyPortletAccessor(Node root, DocumentModel model)
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.
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
.
null
.PortletAccessorController getPortletAccessorController(ObjectID id, StateHolderController state)
StateHolderController
. The portlet window is
addressed via the given ObjectID
.
id
- ObjectID
of the portlet window to access. Must
not be null
.state
- StateHolderController
interface to the
navigational state. Must not be null
.
null
.PortletAccessorController getPortletAccessorController(java.lang.String uniqueName, StateHolderController state) throws MissingUniqueNameException, UnknownUniqueNameException
StateHolderController
. The portlet window is
addressed via the given String
representing the unique
name of the portlet window.
uniqueName
- Unique name of the portlet window to access. Must not be
null
.state
- StateHolderController
interface to the
navigational state. Must not be null
.
null
.
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.PortletAccessorController getPortletAccessorController(Node root, DocumentController model)
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.
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
.
null
.LegacyPortletAccessorController getLegacyPortletAccessorController(ObjectID id, StateHolderController state)
StateHolderController
. The portlet window is
addressed via the given ObjectID
.
id
- ObjectID
of the portlet window to access. Must
not be null
.state
- StateHolderController
interface to the
navigational state. Must not be null
.
null
.LegacyPortletAccessorController getLegacyPortletAccessorController(java.lang.String uniqueName, StateHolderController state) throws MissingUniqueNameException, UnknownUniqueNameException
StateHolderController
. The portlet window is
addressed via the given String
representing the unique
name of the portlet window.
uniqueName
- Unique name of the portlet window to access. Must not be
null
.state
- StateHolderController
interface to the
navigational state. Must not be null
.
null
.
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.LegacyPortletAccessorController getLegacyPortletAccessorController(Node root, DocumentController model)
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.
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
.
null
.PortletListAccessor getPortlets(StateHolder state)
getPortletListAccessor(StateHolder)
instead
StateHolder
interface.
state
- State holder that potentially contains portlet-specific
navigational state. Must not be null
.
null
.PortletListAccessor getPortlets(Node root, DocumentModel model)
getPortletListAccessor(Node, DocumentModel)
instead
DocumentModel
interface. The returned controller expects
the information to be located in the subtree rooted at the given document
node.
root
- Root node for portlet-specific navigational state. Must not be
null
.model
- Model that contains the given root node. Must not be
null
.
null
.PortletAccessor getPortlet(ObjectID id, StateHolder state)
getPortletAccessor(ObjectID, StateHolder)
instead
StateHolder
interface. The portlet window is addressed via the given ObjectID
.
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
.
null
.PortletAccessor getPortlet(java.lang.String uniqueName, StateHolder state) throws MissingUniqueNameException, UnknownUniqueNameException
getPortletAccessor(String, StateHolder)
instead
StateHolder
interface. The portlet window is addressed via the given
String
representing the unique name of the portlet window.
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
.
null
.
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.PortletAccessor getPortlet(Node root, DocumentModel model)
getPortletAccessor(Node, DocumentModel)
instead
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.
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
.
PortletAccessorController getPortletController(ObjectID id, StateHolderController state)
getPortletAccessorController(ObjectID, StateHolderController)
instead.
StateHolderController
. The portlet window is
addressed via the given ObjectID
.
id
- ObjectID
of the portlet window to access. Must
not be null
.state
- StateHolderController
interface to the
navigational state. Must not be null
.
null
.PortletAccessorController getPortletController(java.lang.String uniqueName, StateHolderController state) throws MissingUniqueNameException, UnknownUniqueNameException
getPortletAccessorController(String, StateHolderController)
instead
StateHolderController
. The portlet window is
addressed via the given String
representing the unique
name of the portlet window.
uniqueName
- Unique name of the portlet window to access. Must not be
null
.state
- StateHolderController
interface to the
navigational state. Must not be null
.
null
.
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.PortletAccessorController getPortletController(Node root, DocumentController model)
getPortletAccessorController(Node, StateHolderController)
instead
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.
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
.
null
.SharedStateAccessor getSharedStateAccessor(java.lang.String sharedStateID, StateHolder state) throws MissingSharedStateIdException
String
representing the unique
identifier of the shared state. Use
SharedStateAccessor#KEY_GLOBAL_SHARED_PARAMETERS
to obtain the
global shared state.
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
.
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
.
MissingSharedStateIdException
- If the given shared state id was either null
or
emtpy.SharedStateAccessorController getSharedStateAccessorController(java.lang.String sharedStateID, StateHolderController state) throws MissingSharedStateIdException
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.
sharedStateID
- A String
representing the identifier of the shared state.state
- StateHolderController
interface to the navigational state. Must
not be null
.
null
if the given identifier
for the shared state could is unknown.
MissingSharedStateIdException
SharedStateAccessor getSharedStateAccessor(Node root, DocumentModel model)
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.
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
.
null
.SharedStateAccessorController getSharedStateAccessorController(Node root, DocumentController model)
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.
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
.
null
.SharedStateListAccessor getSharedStateListAccessor(StateHolder state)
StateHolder
interface.
state
- State holder that potentially contains shared state specific
navigational state. Must not be null
.
null
.SharedStateListAccessor getSharedStateListAccessor(Node root, DocumentModel model)
DocumentModel
interface. The returned accessor expects
the information to be located in the subtree rooted at the given document
node.
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
.
null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |