atg.commerce.markers.droplet

Class RemoveMarkersFromOrder

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.nucleus.TimedOperationService

atg.nucleus.servlet.ServletService

atg.nucleus.servlet.HttpServletService

atg.servlet.DynamoServlet

atg.markers.droplet.MarkerDroplet

atg.commerce.markers.droplet.OrderMarkerDroplet

atg.commerce.markers.droplet.RemoveMarkersFromOrder

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, MarkerConstants, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class RemoveMarkersFromOrder
extends OrderMarkerDroplet

This droplet will remove a marker item from an an order.

An extended property map can be provided either by droplet input param or by extending the getExtendedProperties method.

Input params:

order

(optional) The order to be used in the marker operation. If this param is not provided the shopping cart's current order is used.

key

(optional)The marker's key.

value

(optional)The marker's value.

data

(optional)The markers data.

markerPropertyName

(optional) The property name on the item that contains the collection of markers. Specifying this value overrides the default value configured in the Droplet.

extendedProperties

(optional) A map of extended property names and values

Output parameters:

errorMsg

The error message describing a failure.

markerCount

The number of markers removed.

Open params:

output

Rendered upon successful completion.

error

Rendered if an error occurs.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.commerce.markers.droplet.OrderMarkerDroplet

mOrderMarkerManager, mShoppingCartPath, ORDER_PARAM

Fields inherited from class atg.markers.droplet.MarkerDroplet

DATA_PARAM, DUPLICATION_MODE_PARAM, EMPTY_OPARAM, ERROR_MSG_PARAM, ERROR_OPARAM, FALSE_OPARAM, ITEM_ID_PARAM, ITEM_PARAM, KEY_PARAM, MARKED_ITEM_TYPE_PARAM, MARKER_COUNT, MARKER_ELEMENT, MARKER_EXTPROPS_PARAM, MARKER_ITEM_TYPE_PARAM, MARKER_MANAGER_PARAM, MARKER_PROPERTY_NAME_PARAM, MARKERS_ELEMENT, mRepositoryMarkerManager, mTransactionManager, OUTPUT_OPARAM, TRUE_OPARAM, VALUE_PARAM

Fields inherited from class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
RemoveMarkersFromOrder()

Method Summary

Modifier and Type	Method and Description
java.lang.String	doService(DynamoHttpServletRequest req, DynamoHttpServletResponse res) This method will remove markers from the order provided.

Methods inherited from class atg.commerce.markers.droplet.OrderMarkerDroplet

findCurrentOrder, getOrder, getOrderMarkerManager, getShoppingCartPath, setOrderMarkerManager, setShoppingCartPath, validateInput

Methods inherited from class atg.markers.droplet.MarkerDroplet

getANY_VALUE, getData, getDefaultDuplicationMode, getDefaultMarkedItemType, getDefaultMarkerItemType, getDefaultMarkerPropertyName, getDuplicationMode, getExtendedProperties, getItem, getItemId, getKey, getMarkedItemType, getMarkerItemType, getMarkerManager, getMarkerPropertyName, getRepositoryMarkerManager, getTransactionManager, getValue, service, setDefaultDuplicationMode, setDefaultMarkedItemType, setDefaultMarkerItemType, setDefaultMarkerPropertyName, setRepositoryMarkerManager, setTransactionManager

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

RemoveMarkersFromOrder

public RemoveMarkersFromOrder()

Method Detail

doService

public java.lang.String doService(DynamoHttpServletRequest req,
                                  DynamoHttpServletResponse res)
                           throws MarkerException,
                                  javax.servlet.ServletException,
                                  java.io.IOException

This method will remove markers from the order provided.

After removing the markers, orderManager's updateOrder pipeline process is executed.

Specified by:

doService in class MarkerDroplet

Returns:

String - the oparam name to render after successful completion of this method.

Throws:

MarkerException

javax.servlet.ServletException

java.io.IOException

See Also:

MarkerDroplet.OUTPUT_OPARAM