atg.commerce.promotion
Class ClosenessQualifierDroplet

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

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 ClosenessQualifierDroplet
extends DynamoServlet

This droplet consolidates all of the different types of closenessQualifiers (item, order, shipping, tax) of the current order into a single List and returns it in an output parameter. The page developer can also specify a single type of closenessQualifier to be returned.

Input parameters:

type

The type of closenessQualifier to be returned. Possible values: "item", "order", "shipping", "tax", or "all". If null or "all", all closenessQualifiers will be returned.

elementName

The name of the output parameter to return the closenessQualifiers in. If null, the closenessQualifiers will be returned in an "element" output parameter. be returned.

order

The order to return the closenessQualifiers from. If null, the droplet will resolve "shoppingCartPath", and return the current order from that component.

Output parameters:

closenessQualifiers

If "elementName" is null, this will hold the requested closenessQualifiers.

errorMsg

If there is an error in the processing, this parameter will hold the error message string.

Open parameters:

output

If there are closenessQualifiers returned, this open parameter will be rendered.

empty

This will be rendered if no closenessQualifiers exist in the current order

error

This will be rendered if errors occur during processing.

Field Summary

static java.lang.String	ALL_TYPE
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CLOSENESS_QUALIFIERS
static ParameterName	ELEMENT_NAME
static ParameterName	EMPTY
static java.lang.String	ERROR
static ParameterName	ERROR_OPARAM
static java.lang.String	ITEM_TYPE
static java.lang.String	ORDER
static java.lang.String	ORDER_TYPE
static ParameterName	OUTPUT
static java.lang.String	SHIPPING_TYPE
static java.lang.String	TAX_TYPE
static ParameterName	TYPE

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

ClosenessQualifierDroplet()

Method Summary

PromotionUpsellTools	getPromotionUpsellTools()
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Compiles the closenessQualifiers requested, and renders the appropriate open parameters.
void	setPromotionUpsellTools(PromotionUpsellTools pPromotionUpsellTools) The tools component for closenessQualifiers

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

TYPE

public static final ParameterName TYPE

ELEMENT_NAME

public static final ParameterName ELEMENT_NAME

EMPTY

public static final ParameterName EMPTY

OUTPUT

public static final ParameterName OUTPUT

ERROR_OPARAM

public static final ParameterName ERROR_OPARAM

ERROR

public static final java.lang.String ERROR

See Also:

Constant Field Values

CLOSENESS_QUALIFIERS

public static final java.lang.String CLOSENESS_QUALIFIERS

See Also:

Constant Field Values

ITEM_TYPE

public static final java.lang.String ITEM_TYPE

See Also:

Constant Field Values

ORDER_TYPE

public static final java.lang.String ORDER_TYPE

See Also:

Constant Field Values

SHIPPING_TYPE

public static final java.lang.String SHIPPING_TYPE

See Also:

Constant Field Values

TAX_TYPE

public static final java.lang.String TAX_TYPE

See Also:

Constant Field Values

ALL_TYPE

public static final java.lang.String ALL_TYPE

See Also:

Constant Field Values

ORDER

public static final java.lang.String ORDER

See Also:

Constant Field Values

Constructor Detail

ClosenessQualifierDroplet

public ClosenessQualifierDroplet()

Method Detail

setPromotionUpsellTools

public void setPromotionUpsellTools(PromotionUpsellTools pPromotionUpsellTools)

The tools component for closenessQualifiers

Parameters:

pPromotionUpsellTools - the tools component for closenessQualifiers

getPromotionUpsellTools

public PromotionUpsellTools getPromotionUpsellTools()

Returns:

The tools component for closenessQualifiers

service

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

Compiles the closenessQualifiers requested, and renders the appropriate open parameters.

Overrides:

service in class DynamoServlet

Parameters:

pRequest - the current request

pResponse - the current response

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.