atg.commerce.catalog.comparison
Class ProductListHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.commerce.catalog.comparison.ProductListHandler

All Implemented Interfaces:

DropletFormHandler, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class ProductListHandler
extends GenericFormHandler

A form handler that manages the contents of a ProductComparisonList.

See Also:

ProductComparisonList

Field Summary

static java.lang.String	CLASS_VERSION
static java.lang.String	MY_RESOURCE_NAME

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

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

ProductListHandler()

Method Summary

protected void	doAddProductList(ProductComparisonList pList, java.lang.String[] pProductIds, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Add all of the products specified by productIDList to the product comparison list, applying the optional category information in categoryID and the default sku for each product, if any.
void	doAddProductListAllSkus(ProductComparisonList pList, java.lang.String[] pProductIds, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Add all of the skus for all of the products specified by pProductIds to the product comparison list, applying the optional category information in categoryID and the default sku for each product, if any.
java.lang.String	getAddProductErrorURL() Get destination URL if errors occur while adding products to the list.
java.lang.String	getAddProductSuccessURL() Get destination URL for successfully adding products to the list.
java.lang.String	getCategoryID() Set the repository id of the product to add to or remove from the comparison list.
java.lang.String	getClearListErrorURL() Get destination URL if errors occur while clearing the comparison list.
java.lang.String	getClearListSuccessURL() Get destination URL for successfully clearing the comparison list.
int[]	getEntryIds() Get the list of entry id's that specify which entries are to be removed from the product comparison list when calling handleRemoveEntries.
protected java.util.Locale	getLocale(DynamoHttpServletRequest pRequest) Get the locale to use for user-visible error messages.
java.lang.String	getProductID() Get the repository id of the product to add to or remove from the comparison list.
java.lang.String[]	getProductIDList() Get the repository ids of the products to add to the comparison list when calling addProductList or addProductListAllSkus
ProductComparisonList	getProductList() Get the default ProductComparisonList managed by this form handler.
java.lang.String	getRefreshInventoryErrorURL() Get the destination URL if an error occurs refreshing inventory data in the comparison list.
java.lang.String	getRefreshInventorySuccessURL() Get the destination URL for successfully refreshing inventory data in the comparison list.
java.lang.String	getRemoveCategoryErrorURL() Get destination URL if errors occur while removing categories from the list.
java.lang.String	getRemoveCategorySuccessURL() Get destination URL for successfully removing categories from the list.
java.lang.String	getRemoveProductErrorURL() Get destination URL if errors occur while removing products from the list.
java.lang.String	getRemoveProductSuccessURL() Get destination URL for successfully removing products from the list.
java.lang.String	getRepositoryKey() Get the repository lookup key that is used to select an alternate catalog repository.
static java.lang.String	getResourceBundleName() Return the name of the resource bundle to use for this class.
java.lang.String	getSetProductListErrorURL() Get destination URL when errors occur calling setProductList or setProductListAllSkus.
java.lang.String	getSetProductListSuccessURL() Get destination URL when successfully calling setProductList or setProductListAllSkus.
java.lang.String	getSkuID() Set the repository id of the product to add to or remove from the comparison list.
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.
boolean	handleAddProduct(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Add the product specified by productID to the product comparison list, applying the optional category and sku information in categoryID and skuID.
boolean	handleAddProductAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Add all skus the product specified by productID to the product comparison list, applying the optional category information in categoryID.
boolean	handleAddProductList(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Add all of the products specified by productIDList to the product comparison list, applying the optional category information in categoryID and the default sku for each product, if any.
boolean	handleAddProductListAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Add all of the skus for all of the products specified by productIDList to the product comparison list, applying the optional category information in categoryID and the default sku for each product, if any.
boolean	handleCancel(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Reset the form handler by setting productID, categoryID, and skuID to null.
boolean	handleClearList(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Clear the product comparison list and redirect to clearListSuccessURL on success.
boolean	handleRefreshInventoryData(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Refresh all of the inventory data in the the product comparison list and redirect to refreshInventorySuccessURL, if set.
boolean	handleRemoveCategory(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Remove the all entries for the category specified by categoryID from the product comparison list.
boolean	handleRemoveEntries(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Remove list entries whose ids are specified in entryIds.
boolean	handleRemoveProduct(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Remove the product specified by productID from the product comparison list, applying the optional category and sku information in categoryID and skuID.
boolean	handleRemoveProductAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Remove the all entries for the product specified by productID from the product comparison list.
boolean	handleSetProductList(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Set the product comparison list to the products specified by productIDList, applying the optional category information in categoryID and the default sku for each product, if any.
boolean	handleSetProductListAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Set the product comparison list to contain all skus for all products specified by productIDList, applying the optional category information in categoryID and the default sku for each product, if any.
void	postAddProduct(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after adding a product to the list.
void	postAddProductAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after adding all skus for a product to the list.
void	postAddProductList(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after adding a set of products to the list.
void	postAddProductListAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after adding a set of skus to the list.
void	postClearList(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after clearing the product comparison list.
void	postRefreshInventoryData(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after refreshing inventory data in the product comparison list.
void	postRemoveCategory(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after removing all entries for a category from the list.
void	postRemoveEntries(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after removing a set of named entries from the list.
void	postRemoveProduct(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called justa after removing a product from the list.
void	postRemoveProductAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after removing all skus for a product from the list.
void	postSetProductList(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after setting the product list in handleSetProductList.
void	postSetProductListAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just after setting the product list in handleSetProductListAllSkus.
void	preAddProduct(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before adding a product to the list.
void	preAddProductAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before adding all skus for a product to the list.
void	preAddProductList(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before adding a set of products to the list.
void	preAddProductListAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before adding a set of skus to the list.
void	preClearList(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before clearing the product comparison list.
void	preRefreshInventoryData(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before refreshing inventory data in the product comparison list.
void	preRemoveCategory(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before removing all entries for a category from the list.
void	preRemoveEntries(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before removing a set of named entries from the list.
void	preRemoveProduct(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before removing a product from the list.
void	preRemoveProductAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before removing all skus for a product from the list.
void	preSetProductList(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before setting the product list in handleSetProductList.
void	preSetProductListAllSkus(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called just before setting the product list in handleSetProductListAllSkus.
void	setAddProductErrorURL(java.lang.String pAddProductErrorURL) Set destination URL if errors occur while adding products to the list.
void	setAddProductSuccessURL(java.lang.String pAddProductSuccessURL) Set destination URL for successfully adding products to the list.
void	setCategoryID(java.lang.String pCategoryID) Set the repository id of the product to add to or remove from the comparison list.
void	setClearListErrorURL(java.lang.String pClearListErrorURL) Set destination URL if errors occur while clearing the comparison list.
void	setClearListSuccessURL(java.lang.String pClearListSuccessURL) Set destination URL for successfully clearing the comparison list.
void	setEntryIds(int[] pEntryIds) Set the list of entry id's that specify which entries are to be removed from the product comparison list when calling handleRemoveEntries.
void	setProductID(java.lang.String pProductID) Set the repository id of the product to add to or remove from the comparison list.
void	setProductIDList(java.lang.String[] pProductIDList) Set the repository ids of the products to add to the comparison list when calling addProductList or addProductListAllSkus
void	setProductList(ProductComparisonList pProductList) Set the default ProductComparisonList managed by this form handler.
void	setRefreshInventoryErrorURL(java.lang.String pRefreshInventoryErrorURL) Set the destination URL if an error occurs refreshing inventory data in the comparison list.
void	setRefreshInventorySuccessURL(java.lang.String pRefreshInventorySuccessURL) Set the destination URL for successfully refreshing inventory data in the comparison list.
void	setRemoveCategoryErrorURL(java.lang.String pRemoveCategoryErrorURL) Set destination URL if errors occur while removing categories from the list.
void	setRemoveCategorySuccessURL(java.lang.String pRemoveCategorySuccessURL) Set destination URL for successfully removing categories from the list.
void	setRemoveProductErrorURL(java.lang.String pRemoveProductErrorURL) Set destination URL if errors occur while removing products from the list.
void	setRemoveProductSuccessURL(java.lang.String pRemoveProductSuccessURL) Set destination URL for successfully removing products from the list.
void	setRepositoryKey(java.lang.String pRepositoryKey) Set the repository lookup key that is used to select an alternate catalog repository.
void	setSetProductListErrorURL(java.lang.String pSetProductListErrorURL) Set destination URL when errors occur calling setProductList or setProductListAllSkus.
void	setSetProductListSuccessURL(java.lang.String pSetProductListSuccessURL) Set destination URL when successfully calling setProductList or setProductListAllSkus.
void	setSkuID(java.lang.String pSkuID) Set the repository id of the product to add to or remove from the comparison list.
void	setUserLocale(java.lang.String pUserLocale) Set the locale used to retreive user-visible error messages.

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

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

Constructor Detail

ProductListHandler

public ProductListHandler()

Method Detail

setProductList

public void setProductList(ProductComparisonList pProductList)

Set the default ProductComparisonList managed by this form handler.

getProductList

public ProductComparisonList getProductList()

Get the default ProductComparisonList managed by this form handler.

setProductID

public void setProductID(java.lang.String pProductID)

Set the repository id of the product to add to or remove from the comparison list.

getProductID

public java.lang.String getProductID()

Get the repository id of the product to add to or remove from the comparison list.

setProductIDList

public void setProductIDList(java.lang.String[] pProductIDList)

Set the repository ids of the products to add to the comparison list when calling addProductList or addProductListAllSkus

getProductIDList

public java.lang.String[] getProductIDList()

Get the repository ids of the products to add to the comparison list when calling addProductList or addProductListAllSkus

setCategoryID

public void setCategoryID(java.lang.String pCategoryID)

Set the repository id of the product to add to or remove from the comparison list. If null, the product's default parent category will be used, if one has been specified.

getCategoryID

public java.lang.String getCategoryID()

Set the repository id of the product to add to or remove from the comparison list.

setSkuID

public void setSkuID(java.lang.String pSkuID)

Set the repository id of the product to add to or remove from the comparison list. If null, the product's default sku will be used, if one has been specified.

getSkuID

public java.lang.String getSkuID()

Set the repository id of the product to add to or remove from the comparison list.

setRepositoryKey

public void setRepositoryKey(java.lang.String pRepositoryKey)

Set the repository lookup key that is used to select an alternate catalog repository. A value of null means use the default product catalog.

See Also:

CatalogTools

getRepositoryKey

public java.lang.String getRepositoryKey()

Get the repository lookup key that is used to select an alternate catalog repository.

setEntryIds

public void setEntryIds(int[] pEntryIds)

Set the list of entry id's that specify which entries are to be removed from the product comparison list when calling handleRemoveEntries.

getEntryIds

public int[] getEntryIds()

Get the list of entry id's that specify which entries are to be removed from the product comparison list when calling handleRemoveEntries.

setAddProductSuccessURL

public void setAddProductSuccessURL(java.lang.String pAddProductSuccessURL)

Set destination URL for successfully adding products to the list.

getAddProductSuccessURL

public java.lang.String getAddProductSuccessURL()

Get destination URL for successfully adding products to the list.

setAddProductErrorURL

public void setAddProductErrorURL(java.lang.String pAddProductErrorURL)

Set destination URL if errors occur while adding products to the list.

getAddProductErrorURL

public java.lang.String getAddProductErrorURL()

Get destination URL if errors occur while adding products to the list.

setSetProductListSuccessURL

public void setSetProductListSuccessURL(java.lang.String pSetProductListSuccessURL)

Set destination URL when successfully calling setProductList or setProductListAllSkus.

getSetProductListSuccessURL

public java.lang.String getSetProductListSuccessURL()

Get destination URL when successfully calling setProductList or setProductListAllSkus.

setSetProductListErrorURL

public void setSetProductListErrorURL(java.lang.String pSetProductListErrorURL)

Set destination URL when errors occur calling setProductList or setProductListAllSkus.

getSetProductListErrorURL

public java.lang.String getSetProductListErrorURL()

Get destination URL when errors occur calling setProductList or setProductListAllSkus.

setRemoveProductSuccessURL

public void setRemoveProductSuccessURL(java.lang.String pRemoveProductSuccessURL)

Set destination URL for successfully removing products from the list.

getRemoveProductSuccessURL

public java.lang.String getRemoveProductSuccessURL()

Get destination URL for successfully removing products from the list.

setRemoveProductErrorURL

public void setRemoveProductErrorURL(java.lang.String pRemoveProductErrorURL)

Set destination URL if errors occur while removing products from the list.

getRemoveProductErrorURL

public java.lang.String getRemoveProductErrorURL()

Get destination URL if errors occur while removing products from the list.

setRemoveCategorySuccessURL

public void setRemoveCategorySuccessURL(java.lang.String pRemoveCategorySuccessURL)

Set destination URL for successfully removing categories from the list.

getRemoveCategorySuccessURL

public java.lang.String getRemoveCategorySuccessURL()

Get destination URL for successfully removing categories from the list.

setRemoveCategoryErrorURL

public void setRemoveCategoryErrorURL(java.lang.String pRemoveCategoryErrorURL)

Set destination URL if errors occur while removing categories from the list.

getRemoveCategoryErrorURL

public java.lang.String getRemoveCategoryErrorURL()

Get destination URL if errors occur while removing categories from the list.

setClearListSuccessURL

public void setClearListSuccessURL(java.lang.String pClearListSuccessURL)

Set destination URL for successfully clearing the comparison list.

getClearListSuccessURL

public java.lang.String getClearListSuccessURL()

Get destination URL for successfully clearing the comparison list.

setClearListErrorURL

public void setClearListErrorURL(java.lang.String pClearListErrorURL)

Set destination URL if errors occur while clearing the comparison list.

getClearListErrorURL

public java.lang.String getClearListErrorURL()

Get destination URL if errors occur while clearing the comparison list.

setRefreshInventorySuccessURL

public void setRefreshInventorySuccessURL(java.lang.String pRefreshInventorySuccessURL)

Set the destination URL for successfully refreshing inventory data in the comparison list.

getRefreshInventorySuccessURL

public java.lang.String getRefreshInventorySuccessURL()

Get the destination URL for successfully refreshing inventory data in the comparison list.

setRefreshInventoryErrorURL

public void setRefreshInventoryErrorURL(java.lang.String pRefreshInventoryErrorURL)

Set the destination URL if an error occurs refreshing inventory data in the comparison list.

getRefreshInventoryErrorURL

public java.lang.String getRefreshInventoryErrorURL()

Get the destination URL if an error occurs refreshing inventory data in the comparison list.

handleAddProduct

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

Add the product specified by productID to the product comparison list, applying the optional category and sku information in categoryID and skuID.

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProductComparisonList.add()

preAddProduct

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

This method is called just before adding a product to the list.

Throws:

javax.servlet.ServletException

java.io.IOException

postAddProduct

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

This method is called just after adding a product to the list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleAddProductAllSkus

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

Add all skus the product specified by productID to the product comparison list, applying the optional category information in categoryID.

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProductComparisonList.addAllSkus()

preAddProductAllSkus

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

This method is called just before adding all skus for a product to the list.

Throws:

javax.servlet.ServletException

java.io.IOException

postAddProductAllSkus

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

This method is called just after adding all skus for a product to the list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleAddProductList

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

Add all of the products specified by productIDList to the product comparison list, applying the optional category information in categoryID and the default sku for each product, if any.

Throws:

javax.servlet.ServletException

java.io.IOException

preAddProductList

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

This method is called just before adding a set of products to the list.

Throws:

javax.servlet.ServletException

java.io.IOException

postAddProductList

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

This method is called just after adding a set of products to the list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleAddProductListAllSkus

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

Add all of the skus for all of the products specified by productIDList to the product comparison list, applying the optional category information in categoryID and the default sku for each product, if any.

Throws:

javax.servlet.ServletException

java.io.IOException

preAddProductListAllSkus

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

This method is called just before adding a set of skus to the list.

Throws:

javax.servlet.ServletException

java.io.IOException

postAddProductListAllSkus

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

This method is called just after adding a set of skus to the list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleSetProductList

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

Set the product comparison list to the products specified by productIDList, applying the optional category information in categoryID and the default sku for each product, if any. Any existing items are removed from the list before the items in productIDList are added.

Throws:

javax.servlet.ServletException

java.io.IOException

preSetProductList

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

This method is called just before setting the product list in handleSetProductList.

Throws:

javax.servlet.ServletException

java.io.IOException

postSetProductList

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

This method is called just after setting the product list in handleSetProductList.

Throws:

javax.servlet.ServletException

java.io.IOException

handleSetProductListAllSkus

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

Set the product comparison list to contain all skus for all products specified by productIDList, applying the optional category information in categoryID and the default sku for each product, if any. Any existing items are removed from the list before the items in productIDList are added.

Throws:

javax.servlet.ServletException

java.io.IOException

preSetProductListAllSkus

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

This method is called just before setting the product list in handleSetProductListAllSkus.

Throws:

javax.servlet.ServletException

java.io.IOException

postSetProductListAllSkus

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

This method is called just after setting the product list in handleSetProductListAllSkus.

Throws:

javax.servlet.ServletException

java.io.IOException

doAddProductList

protected void doAddProductList(ProductComparisonList pList,
                                java.lang.String[] pProductIds,
                                DynamoHttpServletRequest pRequest,
                                DynamoHttpServletResponse pResponse)
                         throws javax.servlet.ServletException,
                                java.io.IOException

Add all of the products specified by productIDList to the product comparison list, applying the optional category information in categoryID and the default sku for each product, if any.

Throws:

javax.servlet.ServletException

java.io.IOException

doAddProductListAllSkus

public void doAddProductListAllSkus(ProductComparisonList pList,
                                    java.lang.String[] pProductIds,
                                    DynamoHttpServletRequest pRequest,
                                    DynamoHttpServletResponse pResponse)
                             throws javax.servlet.ServletException,
                                    java.io.IOException

Add all of the skus for all of the products specified by pProductIds to the product comparison list, applying the optional category information in categoryID and the default sku for each product, if any.

Throws:

javax.servlet.ServletException

java.io.IOException

handleRemoveProduct

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

Remove the product specified by productID from the product comparison list, applying the optional category and sku information in categoryID and skuID.

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProductComparisonList.remove()

preRemoveProduct

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

This method is called just before removing a product from the list.

Throws:

javax.servlet.ServletException

java.io.IOException

postRemoveProduct

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

This method is called justa after removing a product from the list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleRemoveProductAllSkus

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

Remove the all entries for the product specified by productID from the product comparison list.

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProductComparisonList.removeAllSkus()

preRemoveProductAllSkus

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

This method is called just before removing all skus for a product from the list.

Throws:

javax.servlet.ServletException

java.io.IOException

postRemoveProductAllSkus

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

This method is called just after removing all skus for a product from the list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleRemoveCategory

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

Remove the all entries for the category specified by categoryID from the product comparison list.

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProductComparisonList.removeCategory()

preRemoveCategory

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

This method is called just before removing all entries for a category from the list.

Throws:

javax.servlet.ServletException

java.io.IOException

postRemoveCategory

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

This method is called just after removing all entries for a category from the list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleRemoveEntries

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

Remove list entries whose ids are specified in entryIds.

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ProductComparisonList.remove()

preRemoveEntries

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

This method is called just before removing a set of named entries from the list.

Throws:

javax.servlet.ServletException

java.io.IOException

postRemoveEntries

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

This method is called just after removing a set of named entries from the list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleClearList

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

Clear the product comparison list and redirect to clearListSuccessURL on success.

Throws:

javax.servlet.ServletException

java.io.IOException

preClearList

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

This method is called just before clearing the product comparison list.

Throws:

javax.servlet.ServletException

java.io.IOException

postClearList

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

This method is called just after clearing the product comparison list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleRefreshInventoryData

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

Refresh all of the inventory data in the the product comparison list and redirect to refreshInventorySuccessURL, if set.

Throws:

javax.servlet.ServletException

java.io.IOException

preRefreshInventoryData

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

This method is called just before refreshing inventory data in the product comparison list.

Throws:

javax.servlet.ServletException

java.io.IOException

postRefreshInventoryData

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

This method is called just after refreshing inventory data in the product comparison list.

Throws:

javax.servlet.ServletException

java.io.IOException

handleCancel

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

Reset the form handler by setting productID, categoryID, and skuID to null.

Overrides:

handleCancel in class GenericFormHandler

Throws:

javax.servlet.ServletException

java.io.IOException

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