|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectatg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.nucleus.TimedOperationService
atg.nucleus.servlet.ServletService
atg.nucleus.servlet.HttpServletService
atg.servlet.DynamoServlet
atg.commerce.catalog.comparison.ProductListContains
public class ProductListContains
A droplet that queries whether a ProductComparisonList contains a specified product, category, and sku. This droplet takes up to four parameters:
productList
. Specifies the
ProductComaprisonList object to examine. This can also be
specified as a property of the droplet, but only if the product
comparison list and the droplet have compatible scopes. A
globally scoped droplet should not try to refer to a session
scoped comparison list in its property-based configuration.
productID
- required. Specifies the repository
id of the product to look for in productList
categoryID
- Specifies the repository id of the
category to look for in productList
. If no value
is specified, the product's default parent category will be used.
skuID
- Specifies the repository id of the
sku to look for in productList
. If no value
is specified, the product's default sku will be used.
siteID
- Specifies the site id If no value
is specified, the site id will be taken from the current site context.
This droplet renders one of the following oparams:
true
. Rendered if the product comparison
list contains the specific product, category, and sku.
false
. Rendered if the product comparison
list does not contain the specified product, category, and sku.
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 |
SITE_ID
|
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.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 |
---|
public static java.lang.String CLASS_VERSION
public static final java.lang.String MY_RESOURCE_NAME
public static final ParameterName PRODUCT_LIST
public static final ParameterName PRODUCT_ID
public static final ParameterName CATEGORY_ID
public static final ParameterName SKU_ID
public static final ParameterName SITE_ID
public static final ParameterName CATALOG_KEY
public static final ParameterName TRUE
public static final ParameterName FALSE
Constructor Detail |
---|
public ProductListContains()
Method Detail |
---|
public void setProductList(ProductComparisonList pProductList)
productList
parameter.
public ProductComparisonList getProductList()
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
DynamoServlet
service
in class DynamoServlet
pRequest
- the request to be processedpResponse
- the response object for this request
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.public static java.lang.String getResourceBundleName()
public void setUserLocale(java.lang.String pUserLocale)
public java.lang.String getUserLocale()
protected java.util.Locale getLocale(DynamoHttpServletRequest pRequest)
userLocale
property if set, otherwise
returns the request locale from pRequest
if set, otherwise
returns the default server locale.
protected java.lang.String getUserMessage(java.lang.String pMessageKey, DynamoHttpServletRequest pRequest)
atg.core.util.getUserMsgResource
protected java.lang.String getUserMessage(java.lang.String pMessageKey, java.lang.Object[] args, DynamoHttpServletRequest pRequest)
atg.core.util.getUserMsgResource
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |