com.ibm.portal.state.accessors.screentemplate
Interface ScreenTemplateAccessorFactory

All Superinterfaces:

AccessorFactory

public interface ScreenTemplateAccessorFactory
extends AccessorFactory

Factory interface providing accessors that allow for reading as well as writing screen template information from /to a given state holder or document model.
A screen template is a name for a screen used to generate parts of a portal page during portal rendering.
WebSphere Portal provides a set of default screen templates including "Home" (default), "Login", and "Error". Custom screen templates can also be defined and added to the portal system.

Since:

5.1

Method Summary

ScreenTemplateAccessor	getScreenTemplateAccessor(Node root, DocumentModel model) Get a read-only interface to the screen template.
ScreenTemplateAccessor	getScreenTemplateAccessor(StateHolder state) Get a read-only interface to the screen template.
ScreenTemplateAccessorController	getScreenTemplateAccessorController(Node root, DocumentController model) Returns a controller that allows to modify the screen template.
ScreenTemplateAccessorController	getScreenTemplateAccessorController(StateHolderController state) Returns a controller that allows to modify the screen template.
boolean	removeScreenTemplate(Node node, DocumentController model) Removes the screen template information from the given document model.
boolean	removeScreenTemplate(StateHolderController state) Removes the screen template information from the given state.

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

compact

Method Detail

removeScreenTemplate

boolean removeScreenTemplate(StateHolderController state)

Removes the screen template information from the given state. This is equivalent to setting the default screen "Home".

Parameters:

state - the State holder that should be modified. Must not be null.

Returns:

true if removed, false if not found.

removeScreenTemplate

boolean removeScreenTemplate(Node node,
                             DocumentController model)

Removes the screen template information from the given document model. This is equivalent to setting the default screen "Home".

Parameters:

node - The node to remove, holding the screen template information. Must not be null.

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

Returns:

true if removed, false if not found.

getScreenTemplateAccessor

ScreenTemplateAccessor getScreenTemplateAccessor(StateHolder state)

Get a read-only interface to the screen template. The returned accessor will read from the given state holder.

Parameters:

state - State holder that contains the screen template information. Must not be null.

Returns:

Read-only accessor to the screen template.

getScreenTemplateAccessor

ScreenTemplateAccessor getScreenTemplateAccessor(Node root,
                                                 DocumentModel model)

Get a read-only interface to the screen template. The returned accessor will read the screen template information from the given node being part of the given document model.

Parameters:

root - Root node for screen template information (must not be null).

model - Model that contains the node root (must not be null).

Returns:

Read-only accessor to the screen template.

getScreenTemplateAccessorController

ScreenTemplateAccessorController getScreenTemplateAccessorController(StateHolderController state)

Returns a controller that allows to modify the screen template. The controller will operate on the given state holder.

Parameters:

state - Modifiable state holder to operate on.

Returns:

Read-write accessor to the screen template.

getScreenTemplateAccessorController

ScreenTemplateAccessorController getScreenTemplateAccessorController(Node root,
                                                                     DocumentController model)

Returns a controller that allows to modify the screen template. The controller will operate on the given node being part of the given document model.

Parameters:

root - Root node for screen template information (must not be null).

model - Modifiable document model that contains root (must not be null).

Returns:

Read-write accessor to the screen template.