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

All Superinterfaces:
Accessor, Disposable, ScreenTemplateAccessor

public interface ScreenTemplateAccessorController
extends ScreenTemplateAccessor

This accessor provides read-write access to the screen template. 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
 void setScreenTemplate(java.lang.String screenTemplate)
          Sets the given screen template as selected node into the state holder.
 
Methods inherited from interface com.ibm.portal.state.accessors.screentemplate.ScreenTemplateAccessor
getScreenTemplate
 
Methods inherited from interface com.ibm.portal.Disposable
dispose
 

Method Detail

setScreenTemplate

void setScreenTemplate(java.lang.String screenTemplate)
Sets the given screen template as selected node into the state holder. If the given screen template is unknown the default screen is chosen.

Parameters:
screenTemplate - The screen template which should be used during rendering (must not be null). The screen template must represent a screen that is supported by the portal..