atg.process.action

Class ActionImpl

java.lang.Object

atg.process.action.ActionImpl

All Implemented Interfaces:

Action

Direct Known Subclasses:

AddItemToOrder, AverageOrderAction, ConvertAbandonedOrder, FilterSlot, LogPromotionInfo, MarkerAction, PromotionAction, ReanimateAbandonedOrder, RemovePromotionAction, SendObjectAsXML, SetLastUpdated

public abstract class ActionImpl
extends java.lang.Object
implements Action

An abstract base class which can be used by most process action implementations.

To implement a subclass of ActionImpl:

1. (Optional) If you want your action to be configurable, override the Action.configure method with action-specific configuration. This will typically also involve defining the corresponding action configuration class, which carries the information necessary to configure the action.
2. Override the Action.initialize method with action-specific parameter initialization. You can use the methods storeRequiredParameter and storeOptionalParameter in this class to validate and store parameter Expressions for later evaluation or retrieval. For example,

   
    public void initialize(Map pParameters)
      throws ProcessException
    {
      storeRequiredParameter(pParameters, PARAM_PATH, String.class);
      storeOptionalParameter(pParameters, PARAM_COUNT, Integer.class);
    }
    

3. Implement the executeAction method defined in this class to execute the action in a single process execution context. You can use the getParameterValue method to evaluate the parameter expressions. For example,

   
    protected void executeAction(ProcessExecutionContext pContext)
      throws ProcessException
    {
      // evaluate parameter expressions (note: count may be null)
      String path = (String) getParameterValue(PARAM_PATH, pContext);
      Integer count = (Integer) getParameterValue(PARAM_COUNT, pContext);      
    
      // execute the action using these parameter values
      ...
    }
    

4. (Optional) Override the getActionName method defined in this class to return the name of the action. The action name is used in the toString method. By default, the name of the Action class is used as the action name.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
ActionImpl()

Method Summary

Modifier and Type	Method and Description
void	configure(java.lang.Object pConfiguration) Configures the action using the given configuration object.
void	execute(ProcessExecutionContext pContext) Executes the action in the given process execution context.
void	execute(ProcessExecutionContext[] pContexts) Executes the action in each of the given process execution contexts.
protected abstract void	executeAction(ProcessExecutionContext pContext) Executes this action in the given single process execution context.
java.lang.String	getActionName() Returns the default name of the action.
protected Expression	getParameterExpression(java.lang.String pParameterName) Returns the given parameter Expression.
protected java.lang.Object	getParameterValue(java.lang.String pParameterName, ProcessExecutionContext pContext) Evaluates the given parameter Expression in the given context, and returns the value.
void	initialize(java.util.Map pParameters) Initializes the action with the given parameters.
protected void	storeOptionalParameter(java.util.Map pParameters, java.lang.String pParameterName, java.lang.Class pParameterValueType) Extracts an Expression with the given parameter name from the given parameter Map, and stores it for later retrieval.
protected void	storeRequiredMutableParameter(java.util.Map pParameters, java.lang.String pParameterName) Extracts a MutableExpression with the given parameter name from the given parameter Map, and stores it for later retrieval.
protected void	storeRequiredParameter(java.util.Map pParameters, java.lang.String pParameterName, java.lang.Class pParameterValueType) Extracts an Expression with the given parameter name from the given parameter Map, and stores it for later retrieval.
java.lang.String	toString() Returns the String representation of the Action.
java.lang.String	toString(java.lang.String pActionName) Returns the String representation of the Action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ActionImpl

public ActionImpl()

Method Detail

storeRequiredParameter

protected void storeRequiredParameter(java.util.Map pParameters,
                                      java.lang.String pParameterName,
                                      java.lang.Class pParameterValueType)
                               throws ProcessException

Extracts an Expression with the given parameter name from the given parameter Map, and stores it for later retrieval. If the Expression is constant, evaluates it and caches the constant value as well. The type of the constant value must match the given parameter value type.

Throws:

ProcessException - if no parameter by this name is found in the map, if the parameter value is not an Expression, or if the constant Expression has a value which does not match the given value type

storeOptionalParameter

protected void storeOptionalParameter(java.util.Map pParameters,
                                      java.lang.String pParameterName,
                                      java.lang.Class pParameterValueType)
                               throws ProcessException

Extracts an Expression with the given parameter name from the given parameter Map, and stores it for later retrieval. If the Expression is constant, evaluates it and caches the constant value as well. The type of the constant value must match the given parameter value type. If the parameter is not found in the map, does nothing.

Throws:

ProcessException - if the parameter value is not an Expression, or if the constant Expression has a value which does not match the given value type

storeRequiredMutableParameter

protected void storeRequiredMutableParameter(java.util.Map pParameters,
                                             java.lang.String pParameterName)
                                      throws ProcessException

Extracts a MutableExpression with the given parameter name from the given parameter Map, and stores it for later retrieval. No attempt is made to evaluate the expression.

Throws:

ProcessException - if no parameter by this name is found in the map, or if the parameter value is not a MutableExpression

getParameterExpression

protected Expression getParameterExpression(java.lang.String pParameterName)

Returns the given parameter Expression.

getParameterValue

protected java.lang.Object getParameterValue(java.lang.String pParameterName,
                                             ProcessExecutionContext pContext)
                                      throws ProcessException

Evaluates the given parameter Expression in the given context, and returns the value. The value's type must match the parameter value type passed in to storeRequiredParameter or storeOptionalParameter. If the parameter Expression is constant, returns the cached constant value. If there is no Expression stored for this parameter, or if the Expression evaluates to null, returns null.

Throws:

ProcessException - if the evaluated Expression has a value which does not match this parameter's value type

executeAction

protected abstract void executeAction(ProcessExecutionContext pContext)
                               throws ProcessException

Executes this action in the given single process execution context. Called by both of the execute methods.

Throws:

ProcessException - if the action can not be executed

configure

public void configure(java.lang.Object pConfiguration)
               throws ProcessException,
                      java.lang.UnsupportedOperationException

Configures the action using the given configuration object. The configuration object is typically a global Nucleus component which is configured with the information necessary for the action's operation.

This operation is optional. This default implementation throws an UnsupportedOperationException.

Specified by:

configure in interface Action

Throws:

ProcessException - if the action could not be configured - for example, because some of the required properties are missing from the configuration

java.lang.UnsupportedOperationException - if this action is not configurable

initialize

public void initialize(java.util.Map pParameters)
                throws ProcessException

Initializes the action with the given parameters. The keys in the parameter Map are the String parameter names; the values are the Expression objects representing parameter values.

This default implementation does nothing.

Specified by:

initialize in interface Action

Throws:

ProcessException - if the action could not be properly initialized - for example, if not all of the required parameters are present in the Map

See Also:

Expression

execute

public void execute(ProcessExecutionContext pContext)
             throws ActionException

Executes the action in the given process execution context. The context can be used to evaluate any parameter Expressions.

This default implementation calls executeAction. If that throws a ProcessException, this method throws a corresponding ActionException.

Specified by:

execute in interface Action

Throws:

ActionException - if the action failed when executed in this context; the process engine will catch the ActionException and respond based on the value of the action's error response, as specified in the ActionException itself and/or the action registry; for example, the engine may ignore the error and continue, or it may delete the process instance pointed to by the context and stop executing the process segment in this context

execute

public void execute(ProcessExecutionContext[] pContexts)
             throws ActionException

Executes the action in each of the given process execution contexts. Each context can be used to evaluate any parameter Expressions.

If an error occurs when executing the action in one of the given contexts, this method should still try to execute the action in the rest of the contexts before throwing an exception. In the end, an ActionException should be thrown with a FailedActionInfo entry for each failed process execution context.

This default implementation calls executeAction on each of the contexts. If any of these calls throw a ProcessException, all the errors are collected, and a single ActionException is thrown in the end.

Specified by:

execute in interface Action

Throws:

ActionException - if the action failed when executed in any of the given contexts; the process engine will catch the ActionException and, for each failed context, respond based on the value of the action's error response, as specified in the ActionException itself and/or the action registry; for example, the engine may ignore the error and continue, or it may delete the process instance pointed to by the context and stop executing the process segment in that context

toString

public java.lang.String toString()

Returns the String representation of the Action.

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.String pActionName)

Returns the String representation of the Action.

getActionName

public java.lang.String getActionName()

Returns the default name of the action.