|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NavigationShiftAccessorFactory
Factory interface which provides methods to obtain accessors to read /write
navigation shift information from /to a given state holder or document model.
The controllers may be used to create EngineURLs that modify the navigation
shift state of a navigation control. Just request a controller that operates
on the state holder /document model that has been associated with the
respective EngineURL.
Method Summary | |
---|---|
NavigationShiftAccessor |
getNavigationShift(Node root,
DocumentModel model)
Deprecated. since 6.0, use method getNavigationShiftAccessor(Node, DocumentModel) instead |
NavigationShiftAccessor |
getNavigationShift(ObjectID aNavigationNodeId,
StateHolder state)
Deprecated. since 6.0, use method getNavigationShiftAccessor(ObjectID, StateHolder) instead |
NavigationShiftAccessor |
getNavigationShiftAccessor(Node root,
DocumentModel model)
Returns an interface providing read access to navigation shift information which is placed at the given node in the given document model. |
NavigationShiftAccessor |
getNavigationShiftAccessor(ObjectID aNavigationNodeId,
StateHolder state)
Returns an interface providing read access to navigation shift information for a given navigation node. |
NavigationShiftAccessorController |
getNavigationShiftAccessorController(Node root,
DocumentController model)
Returns an interface providing read-write access to navigation shift information which is placed at the given node in the given document model. |
NavigationShiftAccessorController |
getNavigationShiftAccessorController(ObjectID navigationNodeId,
StateHolderController state)
Returns an interface providing read-write access to navigation shift information for a given navigation node. |
NavigationShiftAccessorController |
getNavigationShiftAccessorController(java.lang.String navigationNodeUniqueName,
StateHolderController state)
Returns an interface providing read-write access to navigation shift information for a given navigation node. |
NavigationShiftAccessorController |
getNavigationShiftController(Node root,
DocumentController model)
Deprecated. since 6.0, use method getNavigationShiftAccessorController(Node, DocumentController) instead |
NavigationShiftAccessorController |
getNavigationShiftController(ObjectID navigationNodeId,
StateHolderController state)
Deprecated. since 6.0, use method getNavigationShiftAccessorController(ObjectID, StateHolderController) instead |
NavigationShiftAccessorController |
getNavigationShiftController(java.lang.String navigationNodeUniqueName,
StateHolderController state)
Deprecated. since 6.0, use method getNavigationShiftAccessorController(String, StateHolderController) instead |
Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory |
---|
compact |
Method Detail |
---|
NavigationShiftAccessor getNavigationShiftAccessor(Node root, DocumentModel model)
root
- Node representing the root of navigation shift information
(must not be null
).model
- The state document model which contains root
(must not be null
).
null
.NavigationShiftAccessor getNavigationShiftAccessor(ObjectID aNavigationNodeId, StateHolder state)
aNavigationNodeId
- The ObjectID
of a navigation node (must not be
null
).state
- Read-only interface to untyped state document model (must not
be null
).
null
.NavigationShiftAccessorController getNavigationShiftAccessorController(Node root, DocumentController model)
root
- Node representing the root of navigation shift information
(must not be null
).model
- The modifiable state document model which contains
root
(must not be null
).
null
.NavigationShiftAccessorController getNavigationShiftAccessorController(ObjectID navigationNodeId, StateHolderController state)
navigationNodeId
- The ObjectID
of a navigation node (must not be
null
).state
- Read-write interface to untyped state document model (must not
be null
).
null
.NavigationShiftAccessorController getNavigationShiftAccessorController(java.lang.String navigationNodeUniqueName, StateHolderController state) throws MissingUniqueNameException, UnknownUniqueNameException
navigationNodeUniqueName
- The unique name of a navigation node (must not be
null
).state
- Read-write interface to untyped state document model (must not
be null
).
null.
- Throws:
UnknownUniqueNameException
- If the unique name cannot be mapped to an object ID.
MissingUniqueNameException
- If the unique name was null
or empty.
NavigationShiftAccessor getNavigationShift(Node root, DocumentModel model)
getNavigationShiftAccessor(Node, DocumentModel)
instead
root
- Node representing the root of navigation shift information
(must not be null
).model
- The state document model which contains root
(must not be null
).
null
.NavigationShiftAccessor getNavigationShift(ObjectID aNavigationNodeId, StateHolder state)
getNavigationShiftAccessor(ObjectID, StateHolder)
instead
aNavigationNodeId
- The ObjectID
of a navigation node (must not be
null
).state
- Read-only interface to untyped state document model (must not
be null
).
null
.NavigationShiftAccessorController getNavigationShiftController(Node root, DocumentController model)
getNavigationShiftAccessorController(Node, DocumentController)
instead
root
- Node representing the root of navigation shift information
(must not be null
).model
- The modifiable state document model which contains
root
(must not be null
).
null
.NavigationShiftAccessorController getNavigationShiftController(ObjectID navigationNodeId, StateHolderController state)
getNavigationShiftAccessorController(ObjectID, StateHolderController)
instead
navigationNodeId
- The ObjectID
of a navigation node (must not be
null
).state
- Read-write interface to untyped state document model (must not
be null
).
null
.NavigationShiftAccessorController getNavigationShiftController(java.lang.String navigationNodeUniqueName, StateHolderController state) throws MissingUniqueNameException, UnknownUniqueNameException
getNavigationShiftAccessorController(String, StateHolderController)
instead
navigationNodeUniqueName
- The unique name of a navigation node (must not be
null
).state
- Read-write interface to untyped state document model (must not
be null
).
null.
- Throws:
UnknownUniqueNameException
- If the unique name cannot be mapped to an object ID.
MissingUniqueNameException
- If the unique name was null
or empty.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |