|
|||||||||
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.commerce.markers.scenario.RemoveMarkersFromOrder
public class RemoveMarkersFromOrder
Scenario action class for removing markers from an Order.
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.commerce.markers.OrderMarkerConstants |
---|
ORDER_MARKER_RESOURCE_NAME, ORDER_PROPERTY_NAME, sResourceBundle |
Constructor Summary | |
---|---|
RemoveMarkersFromOrder()
|
Method Summary | |
---|---|
void |
doAction(ProcessExecutionContext pContext)
Removes the marker(s) from the order. |
protected java.lang.String |
getData(ProcessExecutionContext pContext)
Returns the data parameter. |
protected Order |
getOrderToUse(ProcessExecutionContext pContext)
This method is called by the doAction method to return the Order that's used in the order marker manager API calls. |
void |
initialize(java.util.Map pParameters)
Verifies required parameters are provided |
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 RemoveMarkersFromOrder()
Method Detail |
---|
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
protected Order getOrderToUse(ProcessExecutionContext pContext)
The order is either extracted from the event or from the current session's shopping cart.
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 |