de.innovationgate.wgpublisher.webtml.portlet

Class PortletScopeObjectContext

java.lang.Object

de.innovationgate.wgpublisher.webtml.portlet.PortletScopeObjectContext

All Implemented Interfaces:

ScopeObjectContext

public class PortletScopeObjectContext
extends java.lang.Object
implements ScopeObjectContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PORTLETITEM_CONFIGPROPNAMES

Constructor Summary

Constructors

Constructor and Description
PortletScopeObjectContext(TMLPortlet portlet)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterUsage(ScopeObjectRegistry.ScopeObject so) Called after the scope object was used
void	beforeUsage(ScopeObjectRegistry.ScopeObject so) Called after the scope object has retrieved from the registry
com.google.gson.JsonObject	transformStateToExtract(com.google.gson.JsonObject state, DesignResourceReference ref) Called after extracting state from the scope object, so the scope can optionally do some transformation before setting the state to the registry.
com.google.gson.JsonObject	transformStateToInject(com.google.gson.JsonObject state, DesignResourceReference ref) Called before injecting state to the scope object, so the scope can optionally do some transformation before setting it to the object.

Methods inherited from class java.lang.Object

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

Field Detail

PORTLETITEM_CONFIGPROPNAMES

public static final java.lang.String PORTLETITEM_CONFIGPROPNAMES

See Also:

Constant Field Values

Constructor Detail

PortletScopeObjectContext

public PortletScopeObjectContext(TMLPortlet portlet)

Method Detail

transformStateToExtract

public com.google.gson.JsonObject transformStateToExtract(com.google.gson.JsonObject state,
                                                 DesignResourceReference ref)
                                                   throws de.innovationgate.webgate.api.WGException

Description copied from interface: ScopeObjectContext

Called after extracting state from the scope object, so the scope can optionally do some transformation before setting the state to the registry.

Specified by:

transformStateToExtract in interface ScopeObjectContext

Parameters:

state - The original state

ref - TODO

Returns:

Transformed state.

Throws:

de.innovationgate.webgate.api.WGException

transformStateToInject

public com.google.gson.JsonObject transformStateToInject(com.google.gson.JsonObject state,
                                                DesignResourceReference ref)
                                                  throws de.innovationgate.webgate.api.WGException

Description copied from interface: ScopeObjectContext

Called before injecting state to the scope object, so the scope can optionally do some transformation before setting it to the object. As the given state is the original from the registry this method should not directly modify it but modify and return a clone of it.

Specified by:

transformStateToInject in interface ScopeObjectContext

Parameters:

state - The original state

ref - TODO

Returns:

Transformed state.

Throws:

de.innovationgate.webgate.api.WGException

beforeUsage

public void beforeUsage(ScopeObjectRegistry.ScopeObject so)
                 throws de.innovationgate.webgate.api.WGException

Description copied from interface: ScopeObjectContext

Called after the scope object has retrieved from the registry

Specified by:

beforeUsage in interface ScopeObjectContext

Parameters:

so - The scope object

Throws:

de.innovationgate.webgate.api.WGException

afterUsage

public void afterUsage(ScopeObjectRegistry.ScopeObject so)
                throws de.innovationgate.webgate.api.WGException

Description copied from interface: ScopeObjectContext

Called after the scope object was used

Specified by:

afterUsage in interface ScopeObjectContext

Parameters:

so - The scope object

Throws:

de.innovationgate.webgate.api.WGException