de.innovationgate.wgpublisher.webtml.actions

Class TMLAction

java.lang.Object

de.innovationgate.wgpublisher.webtml.actions.TMLAction

All Implemented Interfaces:

java.io.Serializable

public class TMLAction
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TMLAction.DefaultAction

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,TMLAction.DefaultAction>	_defaultActions
static java.lang.String	CUSTOMACTION
static java.lang.String	DEFAULTACTION_ATTACH
static java.lang.String	DEFAULTACTION_CALLMCMETHOD
static java.lang.String	DEFAULTACTION_CALLPCMETHOD
static java.lang.String	DEFAULTACTION_FIREEVENT
static java.lang.String	DEFAULTACTION_HDBSTORE
static java.lang.String	DEFAULTACTION_INCVAR
static java.lang.String	DEFAULTACTION_LOGIN
static java.lang.String	DEFAULTACTION_REFRESH
static java.lang.String	DEFAULTACTION_REMOVE
static java.lang.String	DEFAULTACTION_RESET
static java.lang.String	DEFAULTACTION_SETPSESSIONVAR
static java.lang.String	DEFAULTACTION_SETPVAR
static java.lang.String	DEFAULTACTION_SETSESSIONVAR
static java.lang.String	DEFAULTACTION_SETVAR
static java.lang.String	DEFAULTACTION_STORE
static int	FLAG_DEBOUNCED
static java.lang.String	OBJ_ACTION_PARAMS
static int	ORIGIN_DEFAULT The action is a default action
static int	ORIGIN_SCRIPT_MODULE The action is defined by a TMLScript module
static int	ORIGIN_TML The action is defined on a WebTML page, either inline or via

Constructor Summary

Constructors

Constructor and Description
TMLAction()
TMLAction(java.lang.String defaultActionName) Constructor for default actions.
TMLAction(java.lang.String code, boolean master, boolean async, boolean debounce, int origin)

Method Summary

Methods

Modifier and Type	Method and Description
static TMLAction	buildActionFromScriptModule(de.innovationgate.webgate.api.WGCSSJSModule mod)
static TMLAction	buildActionFromScriptModule(de.innovationgate.webgate.api.WGCSSJSModule mod, ObjectStrategy defaultObjectStrategy)
void	calledWithSequenceId(java.lang.String sequenceId)
TMLActionLink	createActionLink(java.util.Map<java.lang.String,java.lang.Object> namedParams, java.util.List<java.lang.Object> unnamedParams, TMLContext context)
TMLDesignContext	createContextDelegate(TMLContext context, TMLDesignContext baseContext)
TMLDesignContext	createDesignContext(TMLContext context, TMLDesignContext baseContext)
static java.lang.Boolean	defaultActionAttach(TMLContext context)
static java.lang.Object	defaultActionCallMCMethod(TMLAction action, TMLContext context, DesignResourceReference definitionModule, java.util.Map<java.lang.String,java.lang.Object> namedParams, java.util.List<java.lang.Object> unnamedParams, java.util.Map<java.lang.String,java.lang.Object> objects)
static java.lang.Object	defaultActionCallPCMethod(TMLAction action, TMLContext context, java.util.Map<java.lang.String,java.lang.Object> namedParams, java.util.List<java.lang.Object> unnamedParams, java.util.Map<java.lang.String,java.lang.Object> objects)
static java.lang.Boolean	defaultActionHDBStore(TMLContext context, java.util.List<java.lang.Object> params)
static java.lang.Object	defaultActionIncVar(TMLContext context, java.util.List<java.lang.Object> params)
static java.lang.Boolean	defaultActionRefresh(TMLContext context)
static java.lang.Boolean	defaultActionReset(TMLContext context)
static java.lang.Object	defaultActionSetPortetSessionVar(TMLContext context, java.util.List<java.lang.Object> params)
static java.lang.Object	defaultActionSetPortletVar(TMLContext context, java.util.List<java.lang.Object> params)
static java.lang.Object	defaultActionSetSessionVar(TMLContext context, java.util.List<java.lang.Object> params)
static java.lang.Object	defaultActionSetVar(TMLContext context, java.util.List<java.lang.Object> params)
static java.lang.Boolean	defaultActionStore(TMLContext context, java.util.List<java.lang.Object> params)
java.lang.String	getCode() Returns the code.
static TMLAction.DefaultAction	getDefaultAction(TMLAction action)
java.lang.String	getDescription()
DesignResourceReference	getDesignReference()
java.lang.String	getID()
java.lang.Integer	getKey() Returns the key. hashcode from all properties
java.lang.String	getModuleDatabase()
java.util.Date	getModuleDate()
java.lang.String	getModuleName()
java.lang.String	getObjectName()
ObjectStrategy	getObjectStrategy()
int	getOrigin()
java.lang.String	getQualifier()
int	getTimeout()
java.lang.String	getType()
boolean	isAsync()
boolean	isDebounce()
boolean	isDefaultAction()
boolean	isMaster()
boolean	sequenceIdAlreadyUsed(java.lang.String sequenceId)
void	setAsync(boolean b)
void	setCode(java.lang.String string)
void	setDebounce(boolean debounce)
void	setDesignReference(DesignResourceReference designReference)
void	setID(java.lang.String id)
void	setMaster(boolean b)
void	setModuleDate(java.util.Date moduleDate)
void	setObjectName(java.lang.String objectName)
void	setObjectStrategy(ObjectStrategy objectStrategy)
void	setQualifier(java.lang.String qualifier)
void	setTimeout(int timeout)
void	setType(java.lang.String type)
boolean	upToDate(TMLContext context) Tests if this action definition is up-to-date.

Methods inherited from class java.lang.Object

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

Field Detail

ORIGIN_TML

public static final int ORIGIN_TML

The action is defined on a WebTML page, either inline or via

See Also:

Constant Field Values

ORIGIN_SCRIPT_MODULE

public static final int ORIGIN_SCRIPT_MODULE

The action is defined by a TMLScript module

See Also:

Constant Field Values

ORIGIN_DEFAULT

public static final int ORIGIN_DEFAULT

The action is a default action

See Also:

Constant Field Values

DEFAULTACTION_RESET

public static final java.lang.String DEFAULTACTION_RESET

See Also:

Constant Field Values

DEFAULTACTION_REFRESH

public static final java.lang.String DEFAULTACTION_REFRESH

See Also:

Constant Field Values

DEFAULTACTION_STORE

public static final java.lang.String DEFAULTACTION_STORE

See Also:

Constant Field Values

DEFAULTACTION_REMOVE

public static final java.lang.String DEFAULTACTION_REMOVE

See Also:

Constant Field Values

DEFAULTACTION_ATTACH

public static final java.lang.String DEFAULTACTION_ATTACH

See Also:

Constant Field Values

DEFAULTACTION_LOGIN

public static final java.lang.String DEFAULTACTION_LOGIN

See Also:

Constant Field Values

DEFAULTACTION_SETSESSIONVAR

public static final java.lang.String DEFAULTACTION_SETSESSIONVAR

See Also:

Constant Field Values

DEFAULTACTION_SETPSESSIONVAR

public static final java.lang.String DEFAULTACTION_SETPSESSIONVAR

See Also:

Constant Field Values

DEFAULTACTION_SETVAR

public static final java.lang.String DEFAULTACTION_SETVAR

See Also:

Constant Field Values

DEFAULTACTION_SETPVAR

public static final java.lang.String DEFAULTACTION_SETPVAR

See Also:

Constant Field Values

DEFAULTACTION_HDBSTORE

public static final java.lang.String DEFAULTACTION_HDBSTORE

See Also:

Constant Field Values

DEFAULTACTION_INCVAR

public static final java.lang.String DEFAULTACTION_INCVAR

See Also:

Constant Field Values

DEFAULTACTION_FIREEVENT

public static final java.lang.String DEFAULTACTION_FIREEVENT

See Also:

Constant Field Values

DEFAULTACTION_CALLPCMETHOD

public static final java.lang.String DEFAULTACTION_CALLPCMETHOD

See Also:

Constant Field Values

DEFAULTACTION_CALLMCMETHOD

public static final java.lang.String DEFAULTACTION_CALLMCMETHOD

See Also:

Constant Field Values

FLAG_DEBOUNCED

public static final int FLAG_DEBOUNCED

See Also:

Constant Field Values

_defaultActions

public static java.util.Map<java.lang.String,TMLAction.DefaultAction> _defaultActions

CUSTOMACTION

public static final java.lang.String CUSTOMACTION

See Also:

Constant Field Values

OBJ_ACTION_PARAMS

public static final java.lang.String OBJ_ACTION_PARAMS

See Also:

Constant Field Values

Constructor Detail

TMLAction

public TMLAction()

TMLAction

public TMLAction(java.lang.String code,
         boolean master,
         boolean async,
         boolean debounce,
         int origin)

TMLAction

public TMLAction(java.lang.String defaultActionName)

Constructor for default actions.

Parameters:

defaultActionName - The name of the default action, already stripped of the $ qualifier

Method Detail

getDesignReference

public DesignResourceReference getDesignReference()

setDesignReference

public void setDesignReference(DesignResourceReference designReference)

defaultActionCallMCMethod

public static java.lang.Object defaultActionCallMCMethod(TMLAction action,
                                         TMLContext context,
                                         DesignResourceReference definitionModule,
                                         java.util.Map<java.lang.String,java.lang.Object> namedParams,
                                         java.util.List<java.lang.Object> unnamedParams,
                                         java.util.Map<java.lang.String,java.lang.Object> objects)
                                                  throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

defaultActionCallPCMethod

public static java.lang.Object defaultActionCallPCMethod(TMLAction action,
                                         TMLContext context,
                                         java.util.Map<java.lang.String,java.lang.Object> namedParams,
                                         java.util.List<java.lang.Object> unnamedParams,
                                         java.util.Map<java.lang.String,java.lang.Object> objects)
                                                  throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

defaultActionSetSessionVar

public static java.lang.Object defaultActionSetSessionVar(TMLContext context,
                                          java.util.List<java.lang.Object> params)
                                                   throws TMLException

Throws:

TMLException

defaultActionSetPortetSessionVar

public static java.lang.Object defaultActionSetPortetSessionVar(TMLContext context,
                                                java.util.List<java.lang.Object> params)
                                                         throws TMLException,
                                                                de.innovationgate.webgate.api.WGAPIException

Throws:

TMLException

de.innovationgate.webgate.api.WGAPIException

defaultActionSetVar

public static java.lang.Object defaultActionSetVar(TMLContext context,
                                   java.util.List<java.lang.Object> params)
                                            throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

defaultActionIncVar

public static java.lang.Object defaultActionIncVar(TMLContext context,
                                   java.util.List<java.lang.Object> params)
                                            throws TMLException,
                                                   de.innovationgate.webgate.api.WGAPIException

Throws:

TMLException

de.innovationgate.webgate.api.WGAPIException

defaultActionSetPortletVar

public static java.lang.Object defaultActionSetPortletVar(TMLContext context,
                                          java.util.List<java.lang.Object> params)
                                                   throws TMLException,
                                                          de.innovationgate.webgate.api.WGAPIException

Throws:

TMLException

de.innovationgate.webgate.api.WGAPIException

isDefaultAction

public boolean isDefaultAction()

getCode

public java.lang.String getCode()

Returns the code.

Returns:

String

getKey

public java.lang.Integer getKey()

Returns the key. hashcode from all properties

Returns:

Integer

defaultActionAttach

public static java.lang.Boolean defaultActionAttach(TMLContext context)
                                             throws de.innovationgate.webgate.api.WGAPIException,
                                                    java.io.IOException,
                                                    TMLException

Throws:

de.innovationgate.webgate.api.WGAPIException

java.io.IOException

TMLException

defaultActionRefresh

public static java.lang.Boolean defaultActionRefresh(TMLContext context)
                                              throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

defaultActionStore

public static java.lang.Boolean defaultActionStore(TMLContext context,
                                   java.util.List<java.lang.Object> params)
                                            throws de.innovationgate.webgate.api.WGException,
                                                   java.io.IOException,
                                                   de.innovationgate.webgate.api.WGIllegalStateException

Parameters:

context -

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGIllegalStateException

de.innovationgate.webgate.api.WGException

defaultActionHDBStore

public static java.lang.Boolean defaultActionHDBStore(TMLContext context,
                                      java.util.List<java.lang.Object> params)
                                               throws de.innovationgate.webgate.api.WGException,
                                                      java.io.IOException,
                                                      de.innovationgate.webgate.api.WGIllegalStateException,
                                                      TMLScriptException

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

de.innovationgate.webgate.api.WGIllegalStateException

TMLScriptException

defaultActionReset

public static java.lang.Boolean defaultActionReset(TMLContext context)
                                            throws TMLException,
                                                   de.innovationgate.webgate.api.WGAPIException

Throws:

TMLException

de.innovationgate.webgate.api.WGAPIException

isAsync

public boolean isAsync()

isMaster

public boolean isMaster()

Returns:

setAsync

public void setAsync(boolean b)

Parameters:

b -

setCode

public void setCode(java.lang.String string)

Parameters:

string -

setMaster

public void setMaster(boolean b)

Parameters:

b -

createActionLink

public TMLActionLink createActionLink(java.util.Map<java.lang.String,java.lang.Object> namedParams,
                             java.util.List<java.lang.Object> unnamedParams,
                             TMLContext context)
                               throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

isDebounce

public boolean isDebounce()

setDebounce

public void setDebounce(boolean debounce)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

sequenceIdAlreadyUsed

public boolean sequenceIdAlreadyUsed(java.lang.String sequenceId)

calledWithSequenceId

public void calledWithSequenceId(java.lang.String sequenceId)

getDefaultAction

public static TMLAction.DefaultAction getDefaultAction(TMLAction action)

getModuleName

public java.lang.String getModuleName()

Returns:

Returns the moduleName.

getModuleDatabase

public java.lang.String getModuleDatabase()

Returns:

Returns the moduleDatabase.

getID

public java.lang.String getID()

Returns:

Returns the iD.

setID

public void setID(java.lang.String id)

Parameters:

id - The iD to set.

getModuleDate

public java.util.Date getModuleDate()

Returns:

Returns the moduleDate.

setModuleDate

public void setModuleDate(java.util.Date moduleDate)

Parameters:

moduleDate - The moduleDate to set.

upToDate

public boolean upToDate(TMLContext context)

Tests if this action definition is up-to-date. This only applies to actions that base on TMLScript modules, which might have been updated.

Parameters:

context - A context that this method needs to test for up-to-date-ness

Returns:

true, if the action definition is up-to-date, false (surprise) if not

buildActionFromScriptModule

public static TMLAction buildActionFromScriptModule(de.innovationgate.webgate.api.WGCSSJSModule mod)
                                             throws TMLActionException,
                                                    de.innovationgate.webgate.api.WGAPIException

Throws:

TMLActionException

de.innovationgate.webgate.api.WGAPIException

buildActionFromScriptModule

public static TMLAction buildActionFromScriptModule(de.innovationgate.webgate.api.WGCSSJSModule mod,
                                    ObjectStrategy defaultObjectStrategy)
                                             throws TMLActionException,
                                                    de.innovationgate.webgate.api.WGAPIException

Throws:

TMLActionException

de.innovationgate.webgate.api.WGAPIException

getOrigin

public int getOrigin()

getDescription

public java.lang.String getDescription()

createContextDelegate

public TMLDesignContext createContextDelegate(TMLContext context,
                                     TMLDesignContext baseContext)
                                       throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

createDesignContext

public TMLDesignContext createDesignContext(TMLContext context,
                                   TMLDesignContext baseContext)
                                     throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getObjectStrategy

public ObjectStrategy getObjectStrategy()

setObjectStrategy

public void setObjectStrategy(ObjectStrategy objectStrategy)

getQualifier

public java.lang.String getQualifier()

setQualifier

public void setQualifier(java.lang.String qualifier)

getObjectName

public java.lang.String getObjectName()

setObjectName

public void setObjectName(java.lang.String objectName)