com.ibm.portal.state.accessors.themetemplate
Interface ThemeTemplateAccessorFactory

All Superinterfaces:

AccessorFactory

public interface ThemeTemplateAccessorFactory
extends AccessorFactory

Factory interface providing theme template accessors in order to manipulate theme template information. NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

Since:

5.1

Method Summary

ThemeTemplateAccessor	getThemeTemplateAccessor(javax.servlet.http.HttpServletRequest request) Get a read-only interface to the theme template from the request.
ThemeTemplateAccessor	getThemeTemplateAccessor(Node root, DocumentModel model) Get a read-only interface to theme template information under the assumption that the given root forms the root of theme template information.
ThemeTemplateAccessor	getThemeTemplateAccessor(StateHolder state) Get a read-only interface to the theme template in the state holder.
ThemeTemplateAccessorController	getThemeTemplateAccessorController(Node root, DocumentController model) Gets a controller to modify theme template information theme template.
ThemeTemplateAccessorController	getThemeTemplateAccessorController(StateHolderController state) Gets a controller to modify theme template information.

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

compact

Method Detail

getThemeTemplateAccessor

ThemeTemplateAccessor getThemeTemplateAccessor(javax.servlet.http.HttpServletRequest request)

Get a read-only interface to the theme template from the request.

Parameters:

request - http servlet request to get the theme template from

Returns:

Read-only accessor to the theme template.

getThemeTemplateAccessor

ThemeTemplateAccessor getThemeTemplateAccessor(StateHolder state)

Get a read-only interface to the theme template in the state holder. Does not return null.

Parameters:

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

Returns:

Read-only accessor to the theme template.

getThemeTemplateAccessor

ThemeTemplateAccessor getThemeTemplateAccessor(Node root,
                                               DocumentModel model)

Get a read-only interface to theme template information under the assumption that the given root forms the root of theme template information. Does not return null.

Parameters:

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

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

Returns:

Read-only accessor to the theme template

getThemeTemplateAccessorController

ThemeTemplateAccessorController getThemeTemplateAccessorController(StateHolderController state)

Gets a controller to modify theme template information.

Parameters:

state - Modifiable state document (must not be null).

Returns:

Read-write accessor to theme template information.

getThemeTemplateAccessorController

ThemeTemplateAccessorController getThemeTemplateAccessorController(Node root,
                                                                   DocumentController model)

Gets a controller to modify theme template information theme template. Assumes that the given root forms the root of theme template information in the document.

Parameters:

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

model - Model that contains the root (must not be nullk)

Returns:

Read-write accessor to theme template information.