de.innovationgate.wgpublisher.webtml.portlet

Interface TMLPortletStateStorage

All Known Implementing Classes:

TMLPortletStateSessionStorage, TMLPortletStateTransientStorage

public interface TMLPortletStateStorage

A storage solution for portlet states

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.

Method Detail

getState

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

Retrieves the state for the given portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

disposeState

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

Removes the state of the addressed portlet from the storage

Parameters:

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

portletKey - Key of the portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

disposeChildState

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

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.

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

isStoreSessionVarsAtState

boolean isStoreSessionVarsAtState()

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.