public abstract class MarkerAction extends ActionImpl implements MarkerConstants
This class provides access to a configuration component of type MarkerConfiguration.
During initialization, the following action parameters are stored in the local parameter map.
PARAM_KEY
PARAM_VALUE
PARAM_DATA
PARAM_DUPMODE
PARAM_MARKER_ITEM_TYPE
PARAM_MARKED_ITEM_TYPE
Accessor methods are provided to return the parameters and configurable property values from the configuration component.
getKey(atg.process.ProcessExecutionContext)
,
getValue(atg.process.ProcessExecutionContext)
,
getData(atg.process.ProcessExecutionContext)
,
getDuplicationMode(atg.process.ProcessExecutionContext)
,
getExtendedProperties(atg.process.ProcessExecutionContext)
,
getMarkedItemType(atg.process.ProcessExecutionContext)
,
getMarkerItemType(atg.process.ProcessExecutionContext)
,
getMarkerPropertyName(atg.process.ProcessExecutionContext)
,
configure(java.lang.Object)
,
getMarkerConfiguration()
,
MarkerConfiguration
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected MarkerConfiguration |
mMarkerConfiguration
The MarkerConfiguration reference
|
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 and Description |
---|
MarkerAction() |
Modifier and Type | Method and Description |
---|---|
void |
configure(java.lang.Object pConfiguration)
The configuration object provides the reference to
the RepositoryMarkerManager and also the
default parameter values.
|
abstract void |
doAction(ProcessExecutionContext pContext)
This method is called by the executeAction method.
|
protected boolean |
doesParameterExist(java.lang.String pParameterName)
tests if a parameter has been provided.
|
protected void |
executeAction(ProcessExecutionContext pContext)
Ensures a transaction and calls the doAction method.
|
protected java.lang.String |
getData(ProcessExecutionContext pContext)
Returns the data parameter.
|
protected java.lang.String |
getDuplicationMode(ProcessExecutionContext pContext)
Returns the duplcationMode.
|
protected java.util.Map |
getExtendedProperties(ProcessExecutionContext pContext)
Called by the evaluate method to return the extendedProperties map
that is passed to the hasMarker method call.
|
protected java.lang.String |
getKey(ProcessExecutionContext pContext)
Returns the key parameter.
|
protected java.lang.String |
getMarkedItemType(ProcessExecutionContext pContext)
Returns the markedItemType.
|
protected MarkerConfiguration |
getMarkerConfiguration() |
protected java.lang.String |
getMarkerItemType(ProcessExecutionContext pContext)
Returns the markerItemType.
|
protected java.lang.String |
getMarkerPropertyName(ProcessExecutionContext pContext)
Returns the markerPropertyName.
|
protected java.lang.String |
getValue(ProcessExecutionContext pContext)
Returns the value parameter.
|
void |
initialize(java.util.Map pParameters)
Called by scenario manager to initialize the action
|
protected void |
setMarkerConfiguration(java.lang.Object pConfiguration) |
execute, execute, getActionName, getParameterExpression, getParameterValue, storeOptionalParameter, storeRequiredMutableParameter, storeRequiredParameter, toString, toString
public static java.lang.String CLASS_VERSION
protected MarkerConfiguration mMarkerConfiguration
protected MarkerConfiguration getMarkerConfiguration()
protected void setMarkerConfiguration(java.lang.Object pConfiguration) throws ProcessException
ProcessException
public void configure(java.lang.Object pConfiguration) throws ProcessException, java.lang.UnsupportedOperationException
configure
in interface Action
configure
in class ActionImpl
ProcessException
- if the action could not be configured
- for example, because some of the required properties are
missing from the configurationjava.lang.UnsupportedOperationException
- if this action is not
configurableMarkerConfiguration
public void initialize(java.util.Map pParameters) throws ProcessException
initialize
in interface Action
initialize
in class ActionImpl
ProcessException
- if the action could not be properly
initialized - for example, if not all of the required parameters
are present in the MapExpression
protected java.lang.String getKey(ProcessExecutionContext pContext) throws ProcessException
ProcessException
protected java.lang.String getValue(ProcessExecutionContext pContext) throws ProcessException
ProcessException
protected java.lang.String getData(ProcessExecutionContext pContext) throws ProcessException
ProcessException
protected boolean doesParameterExist(java.lang.String pParameterName)
protected java.lang.String getMarkerPropertyName(ProcessExecutionContext pContext) throws ProcessException
ProcessException
protected java.lang.String getMarkerItemType(ProcessExecutionContext pContext) throws ProcessException
ProcessException
protected java.lang.String getMarkedItemType(ProcessExecutionContext pContext) throws ProcessException
ProcessException
protected java.lang.String getDuplicationMode(ProcessExecutionContext pContext) throws ProcessException
ProcessException
protected java.util.Map getExtendedProperties(ProcessExecutionContext pContext) throws ProcessException
ProcessException
protected void executeAction(ProcessExecutionContext pContext) throws ProcessException
executeAction
in class ActionImpl
ProcessException
- if the action can not be executeddoAction(atg.process.ProcessExecutionContext)
public abstract void doAction(ProcessExecutionContext pContext) throws ProcessException
ProcessException
- if the action can not be executed