de.innovationgate.wgpublisher.so

Interface ScopeObjectContext

All Known Implementing Classes:

PortletScopeObjectContext

public interface ScopeObjectContext

A context for a scope object that provides binding to the scope objects environment

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.

Method Detail

transformStateToExtract

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

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

Parameters:

state - The original state

ref - TODO

ref - Reference of the object with changed state

Returns:

Transformed state.

Throws:

de.innovationgate.webgate.api.WGException

transformStateToInject

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

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.

Parameters:

state - The original state

ref - TODO

ref - Reference of the object with changed state

Returns:

Transformed state.

Throws:

de.innovationgate.webgate.api.WGException

beforeUsage

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

Called after the scope object has retrieved from the registry

Parameters:

so - The scope object

Throws:

de.innovationgate.webgate.api.WGException

afterUsage

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

Called after the scope object was used

Parameters:

so - The scope object

Throws:

de.innovationgate.webgate.api.WGException