atg.commerce.catalog.comparison
Class ProductListContains

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.nucleus.TimedOperationService
              extended by atg.nucleus.servlet.ServletService
                  extended by atg.nucleus.servlet.HttpServletService
                      extended by atg.servlet.DynamoServlet
                          extended by atg.commerce.catalog.comparison.ProductListContains
All Implemented Interfaces:
NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class ProductListContains
extends DynamoServlet

A droplet that queries whether a ProductComparisonList contains a specified product, category, and sku. This droplet takes up to four parameters:

This droplet renders one of the following oparams:

See Also:
ProductComparisonList

Field Summary
static ParameterName CATALOG_KEY
           
static ParameterName CATEGORY_ID
           
static java.lang.String CLASS_VERSION
           
static ParameterName FALSE
           
static java.lang.String MY_RESOURCE_NAME
           
static ParameterName PRODUCT_ID
           
static ParameterName PRODUCT_LIST
           
static ParameterName SKU_ID
           
static ParameterName TRUE
           
 
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
ProductListContains()
           
 
Method Summary
protected  java.util.Locale getLocale(DynamoHttpServletRequest pRequest)
          Get the locale to use for user-visible error messages.
 ProductComparisonList getProductList()
          Get the default ProductComparisonList examined by this droplet.
static java.lang.String getResourceBundleName()
          Return the name of the resource bundle to use for this class.
 java.lang.String getUserLocale()
          Get the locale used to retreive user-visible error messages, if one has been set explicitly.
protected  java.lang.String getUserMessage(java.lang.String pMessageKey, DynamoHttpServletRequest pRequest)
          Return a message from a resource file, taking into account the locale used for user-visible messages.
protected  java.lang.String getUserMessage(java.lang.String pMessageKey, java.lang.Object[] args, DynamoHttpServletRequest pRequest)
          Return a message from a resource file, taking into account the locale used for user-visible messages.
 void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
          This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".
 void setProductList(ProductComparisonList pProductList)
          Set the default ProductComparisonList examined by this droplet.
 void setUserLocale(java.lang.String pUserLocale)
          Set the locale used to retreive user-visible error messages.
 
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

MY_RESOURCE_NAME

public static final java.lang.String MY_RESOURCE_NAME
See Also:
Constant Field Values

PRODUCT_LIST

public static final ParameterName PRODUCT_LIST

PRODUCT_ID

public static final ParameterName PRODUCT_ID

CATEGORY_ID

public static final ParameterName CATEGORY_ID

SKU_ID

public static final ParameterName SKU_ID

CATALOG_KEY

public static final ParameterName CATALOG_KEY

TRUE

public static final ParameterName TRUE

FALSE

public static final ParameterName FALSE
Constructor Detail

ProductListContains

public ProductListContains()
Method Detail

setProductList

public void setProductList(ProductComparisonList pProductList)
Set the default ProductComparisonList examined by this droplet. This property must be used cautiously -- the comparison list must exist at the same or higher scope than the droplet. For example, a session scoped droplet may refer to a session-scoped comparison list, but a globally scoped droplet must not do so. Instead, a globally scoped droplet should receive the product list on each call via the productList parameter.


getProductList

public ProductComparisonList getProductList()
Get the default ProductComparisonList examined by this droplet.


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.

getResourceBundleName

public static java.lang.String getResourceBundleName()
Return the name of the resource bundle to use for this class.


setUserLocale

public void setUserLocale(java.lang.String pUserLocale)
Set the locale used to retreive user-visible error messages. If not specified, the default behavior is to use the request locale if possible, or the server's default locale if no request locale has been specified.


getUserLocale

public java.lang.String getUserLocale()
Get the locale used to retreive user-visible error messages, if one has been set explicitly. If this method returns null, the default behavior is to use the request locale if present, or the server's default locale if not.


getLocale

protected java.util.Locale getLocale(DynamoHttpServletRequest pRequest)
Get the locale to use for user-visible error messages. Returns the locale specified by the userLocale property if set, otherwise returns the request locale from pRequest if set, otherwise returns the default server locale.


getUserMessage

protected java.lang.String getUserMessage(java.lang.String pMessageKey,
                                          DynamoHttpServletRequest pRequest)
Return a message from a resource file, taking into account the locale used for user-visible messages.

See Also:
atg.core.util.getUserMsgResource

getUserMessage

protected java.lang.String getUserMessage(java.lang.String pMessageKey,
                                          java.lang.Object[] args,
                                          DynamoHttpServletRequest pRequest)
Return a message from a resource file, taking into account the locale used for user-visible messages.

See Also:
atg.core.util.getUserMsgResource