|
|||||||||
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.RemoveMarkersFromItem
public abstract class RemoveMarkersFromItem
Scenario action class for removing markers from a repository item
Extend this class and to remove markers from any repository item.
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 | |
---|---|
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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public RemoveMarkersFromItem()
Method Detail |
---|
protected abstract RepositoryItem getItemToUse(ProcessExecutionContext pContext)
pContext
- - the scenario execution context
protected java.lang.String getData(ProcessExecutionContext pContext) throws ProcessException
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
getData
in class MarkerAction
ProcessException
public void initialize(java.util.Map pParameters) throws ProcessException
initialize
in interface Action
initialize
in class MarkerAction
ProcessException
- if the action could not be properly
initialized - for example, if not all of the required parameters
are present in the MapExpression
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 |