atg.markers.scenario

Class AddMarkerToItem

java.lang.Object

atg.process.action.ActionImpl

atg.markers.scenario.MarkerAction

atg.markers.scenario.AddMarkerToItem

All Implemented Interfaces:

MarkerConstants, Action

Direct Known Subclasses:

AddMarkerToProfile

public abstract class AddMarkerToItem
extends MarkerAction
implements MarkerConstants

Scenario action class for adding a marker to a repository item

Extend this class and to create an action that adds a marker to a repository item.

Extensions must implement the getItemToUse method that returns the repositor item to be marked.

See Also:

getItemToUse(atg.process.ProcessExecutionContext)

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.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
AddMarkerToItem()

Method Summary

Modifier and Type	Method and Description
void	doAction(ProcessExecutionContext pContext) Adds a marker to the item.
protected abstract RepositoryItem	getItemToUse(ProcessExecutionContext pContext) This method is called by the doAction method to return the RepositoryItem that's used in the RepositoryMarkerManager addMarker API calls.
void	initialize(java.util.Map pParameters) verifies required parameters are provided

Methods inherited from class atg.markers.scenario.MarkerAction

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

AddMarkerToItem

public AddMarkerToItem()

Method Detail

getItemToUse

protected abstract RepositoryItem getItemToUse(ProcessExecutionContext pContext)

This method is called by the doAction method to return the RepositoryItem that's used in the RepositoryMarkerManager addMarker API calls.

See Also:

RepositoryMarkerManager.addMarkerToItem(atg.repository.MutableRepositoryItem, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map, java.lang.String)

initialize

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

verifies required parameters are provided

Required parameters: PARAM_KEY

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

Adds a marker to the item.

Specified by:

doAction in class MarkerAction

Throws:

ProcessException - if the action can not be executed