atg.commerce.markers.scenario
Class RemoveAllMarkersFromOrder

java.lang.Object
  atg.process.action.ActionImpl
      atg.markers.scenario.MarkerAction
          atg.commerce.markers.scenario.RemoveAllMarkersFromOrder

All Implemented Interfaces:

OrderMarkerConstants, MarkerConstants, Action

public class RemoveAllMarkersFromOrder
extends MarkerAction
implements OrderMarkerConstants

Scenario action class for removing all 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

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

RemoveAllMarkersFromOrder()

Method Summary

void	doAction(ProcessExecutionContext pContext) Removes the marker(s) from the order.
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, 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

RemoveAllMarkersFromOrder

public RemoveAllMarkersFromOrder()

Method Detail

getOrderToUse

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.

The order is either extracted from the event or from the current session's shopping cart.

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

Removes the marker(s) from the order.

Specified by:

doAction in class MarkerAction

Throws:

ProcessException - if the action can not be executed