atg.projects.store.order
Class ShippingPromotionsDroplet

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

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 ShippingPromotionsDroplet
extends atg.servlet.DynamoServlet

This droplet aggregates shipping promotions from all order's shipping groups and returns the list of shipping promotions applied to the order.

Input parameters:

orderId

The id of the order to return shipping promotions for. Either orderId or order parameters should be specified

order

The Order object to return shipping promotions for. Either orderId or order parameters should be specified

Output parameters:

shippingPromotions

The list of shipping promotions applied to the order.

errorMsg

If an error occurred this will be the detailed error message for the user.

Open parameters:

output

Rendered when some shipping promotions are applied to the order.

empty

Rendered when there no shipping promotions in the order.

error

Rendered when some error occurred during droplet's execution.

Example of usage: <dsp:droplet name="ShippingPromotionsDroplet"> <dsp:param name="order" value="${order}"/> <dsp:oparam name="output"> <dsp:getvalueof var="shippingPromotions" param="shippingPromotions"/> </dsp:oparam> </dsp:droplet>

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/EStore/src/atg/projects/store/order/ShippingPromotionsDroplet.java#2 $$Change: 809701 $

Author:

ATG

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	EMPTY The open parameter that indicates that there were no results
static java.lang.String	ERROR The open parameter that indicates that there was an error
static java.lang.String	ERRORMESSAGE The output parameter that includes the error message.
protected static java.lang.String	MSG_NO_ORDER_PARAM_SPECIFIED
protected static java.lang.String	MSG_NO_SUCH_ORDER
static atg.nucleus.naming.ParameterName	ORDER The order parameter name
static atg.nucleus.naming.ParameterName	ORDERID The order ID parameter name
static java.lang.String	OUTPUT The open parameter that indicates that there is a result
static java.lang.String	SHIPPING_PROMOTIONS The parameter name for list of shipping promotions.

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

ShippingPromotionsDroplet()

Method Summary

protected java.lang.String	formatUserMessage(java.lang.String pResourceKey, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Retrieves a message from default resource bundle.
atg.commerce.order.OrderManager	getOrderManager() Returns property OrderManager
protected java.util.Set<atg.repository.RepositoryItem>	getOrderShippingPromotions(atg.commerce.order.Order pOrder) Returns set of shipping promotions applied to the given order.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	setOrderManager(atg.commerce.order.OrderManager pOrderManager) Sets property OrderManager

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

ORDERID

public static final atg.nucleus.naming.ParameterName ORDERID

The order ID parameter name

ORDER

public static final atg.nucleus.naming.ParameterName ORDER

The order parameter name

SHIPPING_PROMOTIONS

public static final java.lang.String SHIPPING_PROMOTIONS

The parameter name for list of shipping promotions.

See Also:

Constant Field Values

ERRORMESSAGE

public static final java.lang.String ERRORMESSAGE

The output parameter that includes the error message.

See Also:

Constant Field Values

ERROR

public static final java.lang.String ERROR

The open parameter that indicates that there was an error

See Also:

Constant Field Values

OUTPUT

public static final java.lang.String OUTPUT

The open parameter that indicates that there is a result

See Also:

Constant Field Values

EMPTY

public static final java.lang.String EMPTY

The open parameter that indicates that there were no results

See Also:

Constant Field Values

MSG_NO_SUCH_ORDER

protected static final java.lang.String MSG_NO_SUCH_ORDER

See Also:

Constant Field Values

MSG_NO_ORDER_PARAM_SPECIFIED

protected static final java.lang.String MSG_NO_ORDER_PARAM_SPECIFIED

See Also:

Constant Field Values

Constructor Detail

ShippingPromotionsDroplet

public ShippingPromotionsDroplet()

Method Detail

setOrderManager

public void setOrderManager(atg.commerce.order.OrderManager pOrderManager)

Sets property OrderManager

getOrderManager

public atg.commerce.order.OrderManager getOrderManager()

Returns property OrderManager

service

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

Overrides:

service in class atg.servlet.DynamoServlet

Throws:

javax.servlet.ServletException

java.io.IOException

getOrderShippingPromotions

protected java.util.Set<atg.repository.RepositoryItem> getOrderShippingPromotions(atg.commerce.order.Order pOrder)

Returns set of shipping promotions applied to the given order.

Parameters:

pOrder - - Order to retrieve shipping promotions from.

Returns:

Set of shipping promotions applied to the given order.

formatUserMessage

protected java.lang.String formatUserMessage(java.lang.String pResourceKey,
                                             atg.servlet.DynamoHttpServletRequest pRequest,
                                             atg.servlet.DynamoHttpServletResponse pResponse)

Retrieves a message from default resource bundle. Resource bundle is defined with RESOURCE_NAME field.

Parameters:

pResourceKey - - key to be searched within a resource bundle.

pRequest - - the HTTP request.

pResponse - - the HTTP response

Returns:

string obtained from the resource bundle.