atg.markers.scenario
Class RemoveAllMarkersFromItem

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

All Implemented Interfaces:

MarkerConstants, Action

Direct Known Subclasses:

RemoveAllMarkersFromProfile

public abstract class RemoveAllMarkersFromItem
extends MarkerAction
implements MarkerConstants

Scenario action class for removing all the markers from a repository item.

Extend this class to create actions that remove all markers from a 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

RemoveAllMarkersFromItem()

Method Summary

void	doAction(ProcessExecutionContext pContext) Removes all markers from the item.
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.

Methods inherited from class atg.markers.scenario.MarkerAction

configure, doesParameterExist, executeAction, getData, getDuplicationMode, getExtendedProperties, getKey, getMarkedItemType, getMarkerConfiguration, getMarkerItemType, getMarkerPropertyName, getValue, initialize, 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

RemoveAllMarkersFromItem

public RemoveAllMarkersFromItem()

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

doAction

public void doAction(ProcessExecutionContext pContext)
              throws ProcessException

Removes all markers from the item. Called by the executeAction method.

Specified by:

doAction in class MarkerAction

Throws:

ProcessException - if the action can not be executed