atg.markers.bp.scenario

Class BusinessProcessStageAction

java.lang.Object

atg.process.action.ActionImpl

atg.markers.scenario.MarkerAction

atg.markers.bp.scenario.BusinessProcessStageAction

All Implemented Interfaces:

BusinessProcessConstants, MarkerConstants, Action

Direct Known Subclasses:

AddBusinessProcessStage, RemoveBusinessProcessStage

public abstract class BusinessProcessStageAction
extends MarkerAction
implements BusinessProcessConstants

Base class for implementing a business process scenario action.

Field Summary

Fields

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

Fields inherited from class atg.markers.scenario.MarkerAction

mMarkerConfiguration

Fields inherited from interface atg.markers.bp.BusinessProcessConstants

BUSINESS_PROCESS_RESOURCE_NAME, sBusinessProcessResourceBundle

Fields inherited from interface atg.markers.MarkerConstants

ALLOW_DUPLICATES, ANY_VALUE, DEFAULT_MARKER_ID_PROPERTY_NAME, DEFAULT_MARKER_ITEM_TYPE, DEFAULT_MARKER_PROPERTY_NAME, DEFAULT_MARKER_SORT_PROPERTY_NAME, MARKER_CREATIONDATE_PROPERTY_NAME, MARKER_DATA_PROPERTY_NAME, MARKER_DUPLICATIONMODE_PROPERTY_NAME, MARKER_KEY_PROPERTY_NAME, MARKER_OWNER_PROPERTY_NAME, MARKER_RESOURCE_NAME, MARKER_VALUE_PROPERTY_NAME, NO_DUPLICATES, PARAM_DATA, PARAM_DUPMODE, PARAM_EXTENDED_PROPERTIES, PARAM_ITEM, PARAM_ITEM_ID, PARAM_KEY, PARAM_MARKED_ITEM_TYPE, PARAM_MARKER_ITEM_TYPE, PARAM_MARKER_MANAGER, PARAM_MARKER_PROPERTY_NAME, PARAM_VALUE, REPLACE_DUPLICATES, sResourceBundle

Constructor Summary

Constructors

Constructor and Description
BusinessProcessStageAction()

Method Summary

Modifier and Type	Method and Description
void	doAction(ProcessExecutionContext pContext) Called by MarkerAction executeAction to do the business process stage marker processing.
protected abstract void	doBusinessProcessStageAction(ProcessExecutionContext pContext, java.lang.String pBusinessProcessName, java.lang.String pBusinessProcessStage) Called by doAction to perform the business process marker action processing.
void	initialize(java.util.Map pParameters) verifies required parameters are provided
protected void	setMarkerConfiguration(java.lang.Object pConfiguration)

Methods inherited from class atg.markers.scenario.MarkerAction

configure, doesParameterExist, executeAction, getData, getDuplicationMode, getExtendedProperties, getKey, getMarkedItemType, getMarkerConfiguration, getMarkerItemType, getMarkerPropertyName, getValue

Methods inherited from class atg.process.action.ActionImpl

execute, execute, getActionName, getParameterExpression, getParameterValue, storeOptionalParameter, storeRequiredMutableParameter, storeRequiredParameter, toString, toString

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

BusinessProcessStageAction

public BusinessProcessStageAction()

Method Detail

setMarkerConfiguration

protected void setMarkerConfiguration(java.lang.Object pConfiguration)
                               throws ProcessException

Overrides:

setMarkerConfiguration in class MarkerAction

Throws:

ProcessException

initialize

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

verifies required parameters are provided

Required parameters:

PARAM_KEY

this parameter is used as the business process name

PARAM_VALUE

this parameter is used as the business process stage name

Specified by:

initialize in interface Action

Overrides:

initialize in class MarkerAction

Throws:

ProcessException - if key is no provided

See Also:

Expression

doAction

public void doAction(ProcessExecutionContext pContext)
              throws ProcessException

Called by MarkerAction executeAction to do the business process stage marker processing.

Specified by:

doAction in class MarkerAction

Throws:

ProcessException - if the action can not be executed

doBusinessProcessStageAction

protected abstract void doBusinessProcessStageAction(ProcessExecutionContext pContext,
                                                     java.lang.String pBusinessProcessName,
                                                     java.lang.String pBusinessProcessStage)
                                              throws ProcessException

Called by doAction to perform the business process marker action processing.

Parameters:

pBusinessProcessName - the business process name.

pBusiniessProcessStage - the business process stage

Throws:

ProcessException