com.ibm.portal.state.accessors.solo
Interface SoloAccessorFactory

All Superinterfaces:

AccessorFactory

public interface SoloAccessorFactory
extends AccessorFactory

Factory providing read-only as well as read-write accessors to Solo state information.
The so-called Solo state is a WebSphere Portal-specific window state for portlets. A portlet being in Solo is displayed "alone", i.e. all other portlets are faded out and in addition all navigation controls on the portal page are disabled. Solo state can be utilized to realize a modal dialog.

Since:

5.1

Method Summary

SoloAccessor	getSolo(Node root, DocumentModel model) Deprecated. since 6.0, use method getSoloAccessor(Node, DocumentModel) instead
SoloAccessor	getSolo(StateHolder state) Deprecated. since 6.0, use method getSoloAccessor(StateHolder) instead
SoloAccessor	getSoloAccessor(Node root, DocumentModel model) Provides an accessor that allows for reading Solo information from the navigational state using the given DocumentModel interface.
SoloAccessor	getSoloAccessor(StateHolder state) Provides an accessor that allows for reading Solo information from the navigational state using the given StateHolder interface.
SoloAccessorController	getSoloAccessorController(Node root, DocumentController model) Provides a controller that allows for reading and writing Solo information from /to the navigational state using the given DocumentController interface.
SoloAccessorController	getSoloAccessorController(StateHolderController state) Provides a controller that allows for reading and writing Solo information from /to the navigational state using the given StateHolderController interface.
SoloAccessorController	getSoloController(Node root, DocumentController model) Deprecated. since 6.0, use method getSoloAccessorController(Node, DocumentController) instead
SoloAccessorController	getSoloController(StateHolderController state) Deprecated. since 6.0, use method getSoloAccessorController(StateHolderController) instead

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

compact

Method Detail

getSoloAccessor

SoloAccessor getSoloAccessor(StateHolder state)

Provides an accessor that allows for reading Solo information from the navigational state using the given StateHolder interface.

Parameters:

state - State holder that contains the Solo information to be read. Must not be null.

Returns:

Read-only accessor to Solo information. Not null.

getSoloAccessor

SoloAccessor getSoloAccessor(Node root,
                             DocumentModel model)

Provides an accessor that allows for reading Solo information from the navigational state using the given DocumentModel interface.

Parameters:

root - Root node for Solo information. Must not be null.

model - State document model that contains the given root. Must not be null.

Returns:

Read-only accessor to Solo information. Not null.

getSoloAccessorController

SoloAccessorController getSoloAccessorController(StateHolderController state)

Provides a controller that allows for reading and writing Solo information from /to the navigational state using the given StateHolderController interface.

Parameters:

state - Controller which allows for modifiying navigational state. Must not be null.

Returns:

Read-write accessor to Solo information. Not null.

getSoloAccessorController

SoloAccessorController getSoloAccessorController(Node root,
                                                 DocumentController model)

Provides a controller that allows for reading and writing Solo information from /to the navigational state using the given DocumentController interface.

Parameters:

root - Root node for Solo information. Must not be null.

model - Controller which allows for modifiying the state document model. Must not be null.

Returns:

Read-write accessor to Solo information. Not null.

getSolo

SoloAccessor getSolo(StateHolder state)

Deprecated. since 6.0, use method getSoloAccessor(StateHolder) instead

Provides an accessor that allows for reading Solo information from the navigational state using the given StateHolder interface.

Parameters:

state - State holder that contains the Solo information to be read. Must not be null.

Returns:

Read-only accessor to Solo information. Not null.

getSolo

SoloAccessor getSolo(Node root,
                     DocumentModel model)

Deprecated. since 6.0, use method getSoloAccessor(Node, DocumentModel) instead

Provides an accessor that allows for reading Solo information from the navigational state using the given DocumentModel interface.

Parameters:

root - Root node for Solo information. Must not be null.

model - State document model that contains the given root. Must not be null.

Returns:

Read-only accessor to Solo information. Not null.

getSoloController

SoloAccessorController getSoloController(StateHolderController state)

Deprecated. since 6.0, use method getSoloAccessorController(StateHolderController) instead

Provides a controller that allows for reading and writing Solo information from /to the navigational state using the given StateHolderController interface.

Parameters:

state - Controller which allows for modifiying navigational state. Must not be null.

Returns:

Read-write accessor to Solo information. Not null.

getSoloController

SoloAccessorController getSoloController(Node root,
                                         DocumentController model)

Deprecated. since 6.0, use method getSoloAccessorController(Node, DocumentController) instead

Provides a controller that allows for reading and writing Solo information from /to the navigational state using the given DocumentController interface.

Parameters:

root - Root node for Solo information. Must not be null.

model - Controller which allows for modifiying the state document model. Must not be null.

Returns:

Read-write accessor to Solo information. Not null.