atg.markers.bp.scenario
Class RemoveBusinessProcessStage

java.lang.Object
  atg.process.action.ActionImpl
      atg.markers.scenario.MarkerAction
          atg.markers.bp.scenario.BusinessProcessStageAction
              atg.markers.bp.scenario.RemoveBusinessProcessStage

All Implemented Interfaces:

BusinessProcessConstants, MarkerConstants, Action

public class RemoveBusinessProcessStage
extends BusinessProcessStageAction

This action can be used to remove business process markers that match the business process name and stage.

Field Summary

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

RemoveBusinessProcessStage()

Method Summary

protected void	doBusinessProcessStageAction(ProcessExecutionContext pContext, java.lang.String pBusinessProcessName, java.lang.String pBusinessProcessStage) Removes the business process markers.
protected java.lang.String	getData(ProcessExecutionContext pContext) Returns the data parameter.

Methods inherited from class atg.markers.bp.scenario.BusinessProcessStageAction

doAction, initialize, setMarkerConfiguration

Methods inherited from class atg.markers.scenario.MarkerAction

configure, doesParameterExist, executeAction, 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

RemoveBusinessProcessStage

public RemoveBusinessProcessStage()

Method Detail

getData

protected java.lang.String getData(ProcessExecutionContext pContext)
                            throws ProcessException

Returns the data parameter.

If the data parameter is not an available parameter it means the UI did not allow the user to specify it. In that case, we set it to MarkerConstants.ANY_VALUE for the comparison. The data param is identified in the parameter map by the key PARAM_DATA

Overrides:

getData in class MarkerAction

Returns:

String the data

Throws:

ProcessException

doBusinessProcessStageAction

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

Removes the business process markers.

Specified by:

doBusinessProcessStageAction in class BusinessProcessStageAction

Parameters:

pBusinessProcessName - the business process name.

pBusinessProcessStage - the business process stage

Throws:

ProcessException

See Also:

atg.markers.bp.BusinessProcessMarker#removeBusinessProcessStage