de.innovationgate.wgpublisher.webtml.portlet

Class TMLPortletStateSessionStorage

java.lang.Object

de.innovationgate.wgpublisher.webtml.portlet.TMLPortletStateSessionStorage

All Implemented Interfaces:

TMLPortletStateStorage

public class TMLPortletStateSessionStorage
extends java.lang.Object
implements TMLPortletStateStorage

Constructor Summary

Constructors

Constructor and Description
TMLPortletStateSessionStorage(javax.servlet.http.HttpSession ses)

Method Summary

Methods

Modifier and Type	Method and Description
void	disposeChildState(java.lang.String appDb, java.lang.String portletKey, java.lang.String childName) Removes the state of a child portlet of addressed portlet from the storage, based on its name.
void	disposeState(java.lang.String appDb, java.lang.String portletKey) Removes the state of the addressed portlet from the storage
TMLPortletState	getState(TMLPortlet portlet) Retrieves the state for the given portlet
boolean	isStoreSessionVarsAtState() Returns if portlet states in this storage should store their session vars at the TMLPortletState object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TMLPortletStateSessionStorage

public TMLPortletStateSessionStorage(javax.servlet.http.HttpSession ses)

Method Detail

getState

public TMLPortletState getState(TMLPortlet portlet)
                         throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: TMLPortletStateStorage

Retrieves the state for the given portlet

Specified by:

getState in interface TMLPortletStateStorage

Throws:

de.innovationgate.webgate.api.WGAPIException

disposeState

public void disposeState(java.lang.String appDb,
                java.lang.String portletKey)

Description copied from interface: TMLPortletStateStorage

Removes the state of the addressed portlet from the storage

Specified by:

disposeState in interface TMLPortletStateStorage

Parameters:

appDb - App id of the portlet, like given from the portlet registry

portletKey - Key of the portlet

isStoreSessionVarsAtState

public boolean isStoreSessionVarsAtState()

Description copied from interface: TMLPortletStateStorage

Returns if portlet states in this storage should store their session vars at the TMLPortletState object. Otherwise they are stored at accompanying TMLFormProcessContext objects on the server.

Specified by:

isStoreSessionVarsAtState in interface TMLPortletStateStorage

disposeChildState

public void disposeChildState(java.lang.String appDb,
                     java.lang.String portletKey,
                     java.lang.String childName)
                       throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: TMLPortletStateStorage

Removes the state of a child portlet of addressed portlet from the storage, based on its name. This is an optional operations, only possible if the child name can be used to resolve its state. Implementations not supporting this should throw WGNotSupportedException.

Specified by:

disposeChildState in interface TMLPortletStateStorage

Parameters:

appDb - App id of the portlet, like given from the portlet registry

portletKey - Key of the parent portlet

childName - Name of the child portlet whose state is to be dropped

Throws:

de.innovationgate.webgate.api.WGAPIException