com.ibm.portal.state.accessors.statepartition
Interface StatePartitionAccessorFactory

All Superinterfaces:

AccessorFactory

public interface StatePartitionAccessorFactory
extends AccessorFactory

Factory to create state partition accessors. A state partition is required if state should be scoped to a specific browser windows. If state is to be store in the session, the state partition information should be used to scope this information. Links that open new browser windows (e.g. via javascript) should create new state partitions for these windows.

Since:

5.1

Method Summary

StatePartitionAccessor	getStatePartitionAccessor(Node node, DocumentModel model) Returns an interface providing read access to state partition information.
StatePartitionAccessor	getStatePartitionAccessor(StateHolder state) Returns an interface providing read access to state partition information
StatePartitionAccessorController	getStatePartitionAccessorController(Node node, DocumentController model) Returns an interface providing read-write access to state partition information.
StatePartitionAccessorController	getStatePartitionAccessorController(StateHolderController state) Returns an interface providing read-write access to state partition information.

Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory

compact

Method Detail

getStatePartitionAccessor

StatePartitionAccessor getStatePartitionAccessor(StateHolder state)

Returns an interface providing read access to state partition information

Parameters:

state - Read-only interface to untyped state document model. Must not be null.

Returns:

Typed read-only interface to state partition information.

getStatePartitionAccessor

StatePartitionAccessor getStatePartitionAccessor(Node node,
                                                 DocumentModel model)

Returns an interface providing read access to state partition information.

Parameters:

node - Node representing the state partition information in the state document. Must not be null.

model - The document model which contains node. Must not be null.

Returns:

Typed read-only interface to state partition information.

getStatePartitionAccessorController

StatePartitionAccessorController getStatePartitionAccessorController(StateHolderController state)

Returns an interface providing read-write access to state partition information.

Parameters:

state - Read-write interface to untyped state document model. Must not be null.

Returns:

Typed read-write interface to state partition information.

getStatePartitionAccessorController

StatePartitionAccessorController getStatePartitionAccessorController(Node node,
                                                                     DocumentController model)

Returns an interface providing read-write access to state partition information.

Parameters:

node - Node representing the state partition information in the state document. Must not be null.

model - The document model which contains node. Must not be null.

Returns:

Typed read-write interface to state partition information.