atg.markers.scenario
Class RemoveMarkersFromItem

java.lang.Object
  atg.process.action.ActionImpl
      atg.markers.scenario.MarkerAction
          atg.markers.scenario.RemoveMarkersFromItem

All Implemented Interfaces:

MarkerConstants, Action

Direct Known Subclasses:

RemoveMarkersFromProfile

public abstract class RemoveMarkersFromItem
extends MarkerAction
implements MarkerConstants

Scenario action class for removing markers from a repository item

Extend this class and to remove markers from any repository item.

See Also:

getItemToUse(atg.process.ProcessExecutionContext)

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.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

RemoveMarkersFromItem()

Method Summary

void	doAction(ProcessExecutionContext pContext) Adds a marker to the item.
protected java.lang.String	getData(ProcessExecutionContext pContext) Returns the data parameter.
protected abstract RepositoryItem	getItemToUse(ProcessExecutionContext pContext) This method is called by the evaluate method to provide the RepositoryItem that's used in the removeMarker API calls.
void	initialize(java.util.Map pParameters) Initializes the action with the given parameters.

Methods inherited from class atg.markers.scenario.MarkerAction

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

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

RemoveMarkersFromItem

public RemoveMarkersFromItem()

Method Detail

getItemToUse

protected abstract RepositoryItem getItemToUse(ProcessExecutionContext pContext)

This method is called by the evaluate method to provide the RepositoryItem that's used in the removeMarker API calls.

Parameters:

pContext - - the scenario execution context

Returns:

RepositoryItem - the repository item that contains the markers

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. This is probably because of a customized version of the action that doesn't allow it to be specified.
In that case, we set it to 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

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.

Specified by:

initialize in interface Action

Overrides:

initialize in class MarkerAction

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

doAction

public void doAction(ProcessExecutionContext pContext)
              throws ProcessException

Adds a marker to the item. Called by the executeAction method.

Specified by:

doAction in class MarkerAction

Throws:

ProcessException - if the action can not be executed