atg.projects.store.droplet
Class RemovedItemCheck

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.projects.store.droplet.RemovedItemCheck

All Implemented Interfaces:

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

public class RemovedItemCheck
extends atg.servlet.DynamoServlet

This droplet takes an order, retrieves it's List of commerce items and checks if any 'removed' items exist. If a removed item is found and the invalidateOrder is set to true, the order will be invalidated.

Input Paramaters:

• invalidateOrder (optional) - Flag (true/false) that indicates that the order should be invalidated if a removed item is found.

Open Parameters:

• true - Serviced when a removed item is found in the order.
• false - Serviced when a removed item is NOT found in the order.

Example:

   <dsp:droplet bean="/atg/store/droplet/RemovedItemsCheck"> 
       <dsp:param name="invalidateOrder" value="true">
       
       <dsp:oparam name="true">
           <dsp:droplet name="RepriceOrderDroplet">
               <dsp:param name="pricingOp" value="ORDER_SUBTOTAL"/>
           </dsp:droplet>
       </dsp:oparam>  
   </dsp:droplet>
   

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/EStore/src/atg/projects/store/droplet/RemovedItemCheck.java#3 $$Change: 794752 $

Author:

David Stewart

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static atg.nucleus.naming.ParameterName	INVALIDATE_ORDER invalidateOrder parameter name.
static atg.nucleus.naming.ParameterName	OPARAM_OUTPUT_FALSE The oparam name rendered once if no items in the order are found to be removed.
static atg.nucleus.naming.ParameterName	OPARAM_OUTPUT_TRUE The oparam name rendered once if an item in the order is found to be removed.

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

RemovedItemCheck()

Method Summary

atg.commerce.order.OrderHolder	getShoppingCart() Returns property ShoppingCart.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method takes an order, retrieves it's List of commerce items and checks if any 'removed' items exist.
void	setShoppingCart(atg.commerce.order.OrderHolder pShoppingCart) Sets property ShoppingCart.

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

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

INVALIDATE_ORDER

public static final atg.nucleus.naming.ParameterName INVALIDATE_ORDER

invalidateOrder parameter name.

OPARAM_OUTPUT_TRUE

public static final atg.nucleus.naming.ParameterName OPARAM_OUTPUT_TRUE

The oparam name rendered once if an item in the order is found to be removed.

OPARAM_OUTPUT_FALSE

public static final atg.nucleus.naming.ParameterName OPARAM_OUTPUT_FALSE

The oparam name rendered once if no items in the order are found to be removed.

Constructor Detail

RemovedItemCheck

public RemovedItemCheck()

Method Detail

setShoppingCart

public void setShoppingCart(atg.commerce.order.OrderHolder pShoppingCart)

Sets property ShoppingCart.

Parameters:

pShoppingCart - an OrderHolder value

getShoppingCart

public atg.commerce.order.OrderHolder getShoppingCart()

Returns property ShoppingCart.

Returns:

an OrderHolder value

service

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

This method takes an order, retrieves it's List of commerce items and checks if any 'removed' items exist. If a removed item is found and the invalidateOrder is set to true, the order will be invalidated.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - - DynamoHttpSevletRequest.

pResponse - - DynamoHttpServletResponse.

Throws:

javax.servlet.ServletException - - if an error occurs.

java.io.IOException - - if an error occurs.