atg.commerce.gifts
Class GiftlistShoppingCartQuantityDroplet

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.commerce.gifts.GiftlistShoppingCartQuantityDroplet

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class GiftlistShoppingCartQuantityDroplet
extends DynamoServlet

This servlet looks through handling instructions for a commerce item, it creates a map of giftlistId's and a sum of quantities for that giftlistId

This servlet is configurable using the properties file. For example: GiftlistShoppingCartQuantityDroplet.properties

 $class=atg.commerce.gifts.GiftlistShoppingCartQuantityDroplet
 $scope=request
 
 shoppingCart=/atg/commerce/ShoppingCart
 handlingInstructionManager=/atg/commerce/order/HandlingInstructionManager
 

The invocation of the droplet can then be invoked with the following parameters:

 <DROPLET bean="/atg/commerce/gifts/GiftlistShoppingCartQuantityDroplet">
 <PARAM NAME="commerceItemId" VALUE="param:commerceItemId">
 <PARAM NAME="order" VALUE="param:order">
 <OPARAM NAME="output">
 Output
 </OPARAM>
 <OPARAM NAME="error">
 Error
 </OPARAM>
 </DROPLET>
 

The required input parameters for this servlet are:

commerceItemId

The id of the commerce item

The following parameters are optional:

order

The order object

The output parameters for this servlet are:

giftlistId

The id of the gift list

quantity

The total quantity of for a gift item with different handling instructions

error

Any exception that may have occured while adding or removing list.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COUNT
static java.lang.String	ELEMENT
static ParameterName	ELEMENT_NAME
static ParameterName	EMPTY
static java.lang.String	ERRORMESSAGE The output parameter that includes the error message.
static java.lang.String	INDEX
static ParameterName	INDEX_NAME
static java.lang.String	KEY
static ParameterName	KEY_NAME
protected HandlingInstructionManager	mHandlingInstructionManager
protected static java.lang.String	MSG_EXCEPTION
protected static java.lang.String	MSG_NO_COMMERCE_ITEM_ID
static ParameterName	OUTPUT_END
static ParameterName	OUTPUT_START
static java.lang.String	SIZE

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.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

GiftlistShoppingCartQuantityDroplet()

Method Summary

HandlingInstructionManager	getHandlingInstructionManager() Returns property handlingInstructionManager
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".
protected void	setElementParameter(DynamoHttpServletRequest pReq, java.lang.String pElementName, java.lang.Object pValue) This method can be overridden by sub-classes to customize how the element parmeter is set.
void	setHandlingInstructionManager(HandlingInstructionManager pHandlingInstructionManager) Sets property handlingInstructionManager

Methods inherited from class atg.servlet.DynamoServlet

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

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, init, 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, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

INDEX

public static final java.lang.String INDEX

See Also:

Constant Field Values

COUNT

public static final java.lang.String COUNT

See Also:

Constant Field Values

SIZE

public static final java.lang.String SIZE

See Also:

Constant Field Values

OUTPUT_START

public static final ParameterName OUTPUT_START

OUTPUT_END

public static final ParameterName OUTPUT_END

EMPTY

public static final ParameterName EMPTY

ELEMENT_NAME

public static final ParameterName ELEMENT_NAME

INDEX_NAME

public static final ParameterName INDEX_NAME

KEY_NAME

public static final ParameterName KEY_NAME

ERRORMESSAGE

public static final java.lang.String ERRORMESSAGE

The output parameter that includes the error message.

See Also:

Constant Field Values

MSG_NO_COMMERCE_ITEM_ID

protected static final java.lang.String MSG_NO_COMMERCE_ITEM_ID

See Also:

Constant Field Values

MSG_EXCEPTION

protected static final java.lang.String MSG_EXCEPTION

See Also:

Constant Field Values

mHandlingInstructionManager

protected HandlingInstructionManager mHandlingInstructionManager

Constructor Detail

GiftlistShoppingCartQuantityDroplet

public GiftlistShoppingCartQuantityDroplet()

Method Detail

getHandlingInstructionManager

public HandlingInstructionManager getHandlingInstructionManager()

Returns property handlingInstructionManager

Returns:

returns property handlingInstructionManager

setHandlingInstructionManager

public void setHandlingInstructionManager(HandlingInstructionManager pHandlingInstructionManager)

Sets property handlingInstructionManager

Parameters:

pHandlingInstructionManager - the value to set for property handlingInstructionManager

setElementParameter

protected void setElementParameter(DynamoHttpServletRequest pReq,
                                   java.lang.String pElementName,
                                   java.lang.Object pValue)

This method can be overridden by sub-classes to customize how the element parmeter is set.

service

public void service(DynamoHttpServletRequest pRequest,
                    DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

Description copied from class: DynamoServlet

This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".

Overrides:

service in class DynamoServlet

Parameters:

pRequest - the request to be processed

pResponse - the response object for this request

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.