|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.process.action.ActionImpl atg.markers.scenario.MarkerAction atg.markers.scenario.AddMarkerToItem
public abstract class AddMarkerToItem
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.
getItemToUse(atg.process.ProcessExecutionContext)
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.markers.scenario.MarkerAction |
---|
mMarkerConfiguration |
Constructor Summary | |
---|---|
AddMarkerToItem()
|
Method Summary | |
---|---|
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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public AddMarkerToItem()
Method Detail |
---|
protected abstract RepositoryItem getItemToUse(ProcessExecutionContext pContext)
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)
public void initialize(java.util.Map pParameters) throws ProcessException
Required parameters: PARAM_KEY
initialize
in interface Action
initialize
in class MarkerAction
ProcessException
- if key is no providedExpression
public void doAction(ProcessExecutionContext pContext) throws ProcessException
doAction
in class MarkerAction
ProcessException
- if the action can not be executed
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |