atg.commerce.csr.gifts

Class CSRGiftlistFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.droplet.TransactionalFormHandler

atg.commerce.gifts.GiftlistFormHandler

atg.commerce.csr.gifts.CSRGiftlistFormHandler

All Implemented Interfaces:

atg.commerce.util.PipelineErrorHandler, atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.droplet.DropletFormHandler, 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, java.util.EventListener

public class CSRGiftlistFormHandler
extends atg.commerce.gifts.GiftlistFormHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CATALOG_REF_ID_ATTRIBUTE_NAME
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	ENVRESOURCES
protected static java.lang.String	EVENT_NAME_ATTRIBUTE_NAME
protected CSRAgentTools	mCSRAgentTools
protected atg.svc.agent.environment.EnvironmentTools	mEnvironmentTools
protected atg.nucleus.naming.ComponentName	mGiftlistUIStatePath
protected atg.web.messaging.MessageTools	mMessageTools
protected java.util.List	mPropertyUpdates

Fields inherited from class atg.commerce.gifts.GiftlistFormHandler

dateUtil, LOCALE_PARAM, mEnableSecurity, MSG_ERROR_ADDING_TO_GIFTLIST, MSG_ERROR_DELETING_GIFTLIST, MSG_ERROR_NO_SUCH_GIFTLIST, MSG_ERROR_REMOVING_RROM_GIFTLIST, MSG_ERROR_SAVING_GIFTLIST, MSG_ERROR_UPDATING_GIFTLIST_ITEMS, MSG_INVALID_EVENT_DATE, MSG_INVALID_GIFTLIST_QUANTITY, MSG_INVALID_GIFTLIST_QUANTITY_WITH_FRACTION, MSG_INVALID_QUANTITY, MSG_NO_GIFTLIST_TO_MODIFY, MSG_NO_ITEM_FOUND, MSG_NO_ITEMS_TO_ADD, MSG_NO_SKU_WITH_ID, MSG_QUANTITY_LESSTHAN_OR_EQUALTO_ZERO, MSG_QUANTITY_WITH_FRACTION_LESSTHAN_OR_EQUALTO_ZERO, MY_RESOURCE_NAME, QUANTITY_NOT_VALID, sResourceBundle

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

Constructors

Constructor and Description
CSRGiftlistFormHandler()

Method Summary

Modifier and Type	Method and Description
protected java.util.List	createPropertyUpdates(atg.repository.RepositoryItem pGiftlist) Creates the list of PropertyUpdate objects which are included in the GiftlistEvent generated when a gift list is updated.
java.lang.String	getCatalogRefIdPropertyName() Returns the CatalogRefIdPropertyName property.
CSRAgentTools	getCSRAgentTools() Returns CSRAgentTools component
atg.svc.agent.environment.EnvironmentTools	getEnvironmentTools() Returns the EnvironmentTools component
java.util.List	getGiftItemEvents() Returns property GiftListEvents
java.lang.String	getGiftItemId() Returns property giftItemId.
java.lang.String	getGiftlistUIStatePath() Returns property GiftlistUIStatePath
atg.web.messaging.MessageTools	getMessageTools() Returns the MessageTools component
atg.core.util.ContactInfo	getNewAddress() Returns property newAddress.
java.lang.String	getProductIdPropertyName() Returns the ProductIdPropertyName property.
atg.commerce.profile.CommerceProfileTools	getProfileTools() Returns profile tools component
protected java.lang.String[]	getPropertiesToRecord() Returns the array of Giftlist property names that will be checked for an update and recorded in the ticket activity and audit repository.
java.util.List	getPropertyUpdates() Returns the PropertyUpdate objects which are included in the GiftlistEvent.
long	getQuantity(java.lang.String pCatalogRefId, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
java.lang.String	getRemoveItemFromGiftlistErrorURL() Returns property RemoveItemFromGiftlistErrorURL
protected java.util.Locale	getUserLocale() This method gets the current Locale
boolean	handleRemoveItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) handleRemoveItemFromGiftlist
void	postAddItemToGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just after an item has been added to a giftlist
void	postDeleteGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just after a giftlist is deleted
void	postRemoveItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just after an item has been removed from a giftlist
void	postUpdateGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) The extension generates the AgentEvent for the update.
void	postUpdateGiftlistItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just after items in giftlist are updated If no form errors exist the AgentEvents returned by getGiftItemEvents() are sent.
void	preDeleteGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just before giftlist is deleted
void	preRemoveItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just before an removed from a giftlist
void	preSaveGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Operation called just before giftlist is saved
void	preUpdateGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This extension is used to auto-populate the newAddressName property when a new address is being created.
void	preUpdateGiftlistItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This extension generates a {@link GiftItemEvent) for each gift item quantity that was updated and for each removed gift item.
void	removeItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Removes the given giftlistItem from the given giftlist.
java.lang.String	saveGiftlist(java.lang.String pProfileId) Calls the manager class to create a gift list in the repository and adds it to the current profile.
void	setCatalogRefIdPropertyName(java.lang.String pCatalogRefIdPropertyName) Sets the value of the CatalogRefIdPropertyName property.
void	setCSRAgentTools(CSRAgentTools pAgentTools) Sets the CSRAgentTools component.
void	setEnvironmentTools(atg.svc.agent.environment.EnvironmentTools pEnvironmentTools) Sets the EnvironmentTools component
void	setGiftItemEvents(java.util.List pGiftItemEvents) Sets property GiftItemEvents
void	setGiftItemId(java.lang.String pGiftItemId) Sets property giftItemId.
void	setGiftlistUIStatePath(java.lang.String pGiftlistUIStatePath) Sets property GiftlistUIStatePath
void	setMessageTools(atg.web.messaging.MessageTools pMessageTools) Sets the MessageTools component
void	setProductIdPropertyName(java.lang.String pProductIdPropertyName) Set the value of the ProductIdPropertyName property.
void	setProfileTools(atg.commerce.profile.CommerceProfileTools pProfileTools) Sets the profile tools component.
void	setPropertyUpdates(java.util.List pPropertyUpdates)
void	setRemoveItemFromGiftlistErrorURL(java.lang.String pRemoveItemFromGiftlistErrorURL) Sets property RemoveItemFromGiftlistErrorURL
void	updateGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This extension is used to first generate the PropertyUpdate objects that detail the before and after values of the updated properties.

Methods inherited from class atg.commerce.gifts.GiftlistFormHandler

addFormException, addItemToGiftlist, checkGiftlistAccess, createGiftlist, createNewShippingAddress, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, generatePropertyPath, getAddItemToGiftlistErrorURL, getAddItemToGiftlistSuccessURL, getAddresses, getCatalogRefIds, getCatalogTools, getComments, getCreateGiftlistErrorURL, getCreateGiftlistSuccessURL, getDate, getDates, getDefaultLocale, getDeleteGiftlistErrorURL, getDeleteGiftlistSuccessURL, getDescription, getEventDate, getEventName, getEventType, getEventTypes, getGeneralFailureURL, getGeneralSuccessURL, getGiftlistId, getGiftlistManager, getGiftlistRepository, getInstructions, getIsNewAddress, getIsPublic, getIsPublished, getItemIds, getItemRemovedFromOrderEventType, getMonth, getMonths, getMoveItemsFromCartErrorURL, getMoveItemsFromCartSuccessURL, getNewAddressName, getOrder, getOrderManager, getPipelineManager, getProductId, getProfile, getQuantity, getQuantityWithFraction, getQuantityWithFraction, getRemoveGiftitemIds, getSaveGiftlistErrorURL, getSaveGiftlistSuccessURL, getShippingAddressId, getShoppingCart, getSiteId, getSpecialInstructions, getUpdateGiftlistErrorURL, getUpdateGiftlistItemsErrorURL, getUpdateGiftlistItemsSuccessURL, getUpdateGiftlistSuccessURL, getUserLocale, getYear, getYears, handleAddItemToGiftlist, handleCreateGiftlist, handleDeleteGiftlist, handleMoveItemsFromCart, handlePipelineError, handleSaveGiftlist, handleUpdateGiftlist, handleUpdateGiftlistItems, isEnableSecurity, isSendItemRemovedMessages, isUseRequestLocale, moveItemsFromCart, postCreateGiftlist, postMoveItemsFromCart, postSaveGiftlist, preAddItemToGiftlist, preCreateGiftlist, preMoveItemsFromCart, processException, processPipelineErrors, sendScenarioEvent, sendScenarioEvent, sendScenarioEvent, setAddItemToGiftlistErrorURL, setAddItemToGiftlistSuccessURL, setCatalogRefIds, setCatalogTools, setComments, setCreateGiftlistErrorURL, setCreateGiftlistSuccessURL, setDate, setDefaultLocale, setDeleteGiftlistErrorURL, setDeleteGiftlistSuccessURL, setDescription, setEnableSecurity, setEventDate, setEventName, setEventType, setGeneralFailureURL, setGeneralSuccessURL, setGiftlistId, setGiftlistManager, setGiftlistRepository, setInstructions, setIsNewAddress, setIsPublic, setIsPublished, setItemIds, setItemRemovedFromOrderEventType, setMonth, setMoveItemsFromCartErrorURL, setMoveItemsFromCartSuccessURL, setNewAddress, setNewAddressName, setOrderManager, setPipelineManager, setProductId, setProfile, setQuantity, setQuantityWithFraction, setRemoveGiftitemIds, setSaveGiftlistErrorURL, setSaveGiftlistSuccessURL, setSendItemRemovedMessages, setShippingAddressId, setShoppingCart, setSiteId, setSpecialInstructions, setUpdateGiftlistErrorURL, setUpdateGiftlistItemsErrorURL, setUpdateGiftlistItemsSuccessURL, setUpdateGiftlistSuccessURL, setUseRequestLocale, setYear, updateEventDate, updateGiftlistItems, updateOrder, updateOrder, validateGiftlistId

Methods inherited from class atg.droplet.TransactionalFormHandler

afterSet, beforeSet, checkFormRedirect, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, isTransactionMarkedAsRollback, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, 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, clearAbsoluteNameAndContext, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, isStartServiceComplete, 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, toString

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

EVENT_NAME_ATTRIBUTE_NAME

protected static final java.lang.String EVENT_NAME_ATTRIBUTE_NAME

See Also:

Constant Field Values

CATALOG_REF_ID_ATTRIBUTE_NAME

protected static final java.lang.String CATALOG_REF_ID_ATTRIBUTE_NAME

See Also:

Constant Field Values

ENVRESOURCES

public static final java.lang.String ENVRESOURCES

See Also:

Constant Field Values

mMessageTools

protected atg.web.messaging.MessageTools mMessageTools

mEnvironmentTools

protected atg.svc.agent.environment.EnvironmentTools mEnvironmentTools

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

mGiftlistUIStatePath

protected atg.nucleus.naming.ComponentName mGiftlistUIStatePath

mPropertyUpdates

protected java.util.List mPropertyUpdates

Constructor Detail

CSRGiftlistFormHandler

public CSRGiftlistFormHandler()

Method Detail

getMessageTools

public atg.web.messaging.MessageTools getMessageTools()

Returns the MessageTools component

If the mMessageTools is null, then EnvironmentTools#getMessageTools() sets mMessageTools.

Returns:

MessageTools

See Also:

EnvironmentTools.getMessageTools()

setMessageTools

public void setMessageTools(atg.web.messaging.MessageTools pMessageTools)

Sets the MessageTools component

getEnvironmentTools

public atg.svc.agent.environment.EnvironmentTools getEnvironmentTools()

Returns the EnvironmentTools component

Returns:

EnvironmentTools

setEnvironmentTools

public void setEnvironmentTools(atg.svc.agent.environment.EnvironmentTools pEnvironmentTools)

Sets the EnvironmentTools component

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pAgentTools)

Sets the CSRAgentTools component.

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Returns CSRAgentTools component

Returns:

The CSRAgentTools component.

getNewAddress

public atg.core.util.ContactInfo getNewAddress()

Returns property newAddress.

Overrides:

getNewAddress in class atg.commerce.gifts.GiftlistFormHandler

Returns:

The value of the property newAddress.

setProfileTools

public void setProfileTools(atg.commerce.profile.CommerceProfileTools pProfileTools)

Sets the profile tools component.

Overrides:

setProfileTools in class atg.commerce.gifts.GiftlistFormHandler

getProfileTools

public atg.commerce.profile.CommerceProfileTools getProfileTools()

Returns profile tools component

Overrides:

getProfileTools in class atg.commerce.gifts.GiftlistFormHandler

Returns:

The profile tools component.

setGiftItemId

public void setGiftItemId(java.lang.String pGiftItemId)

Sets property giftItemId.

Parameters:

pGiftItemId - The property to store the giftItemId

getGiftItemId

public java.lang.String getGiftItemId()

Returns property giftItemId.

Returns:

The value of the property giftItemId.

setRemoveItemFromGiftlistErrorURL

public void setRemoveItemFromGiftlistErrorURL(java.lang.String pRemoveItemFromGiftlistErrorURL)

Sets property RemoveItemFromGiftlistErrorURL

Parameters:

pRemoveItemFromGiftlistErrorURL - The property to store the error URL for removeItemFromGiftlist.

getRemoveItemFromGiftlistErrorURL

public java.lang.String getRemoveItemFromGiftlistErrorURL()

Returns property RemoveItemFromGiftlistErrorURL

Returns:

The value of the property RemoveItemFromGiftlistErrorURL

setGiftItemEvents

public void setGiftItemEvents(java.util.List pGiftItemEvents)

Sets property GiftItemEvents

This property is used when doing updates to gift items in a gift list to store the GiftItemEvents that are created in the pre-X method and sent in the post-X method. The events are generated in the pre-X method so the before values of the gift items needed for the events, such as quantity desired, can be captured and sent after the update is complete.

Parameters:

pGiftItemEvents -

getGiftItemEvents

public java.util.List getGiftItemEvents()

Returns property GiftListEvents

Returns:

The value of the property GiftListEvents

getCatalogRefIdPropertyName

public java.lang.String getCatalogRefIdPropertyName()

Returns the CatalogRefIdPropertyName property.

Returns:

the value of the CatalogRefIdPropertyName property.

setCatalogRefIdPropertyName

public void setCatalogRefIdPropertyName(java.lang.String pCatalogRefIdPropertyName)

Sets the value of the CatalogRefIdPropertyName property.

Parameters:

pCatalogRefIdPropertyName -

getProductIdPropertyName

public java.lang.String getProductIdPropertyName()

Returns the ProductIdPropertyName property.

Returns:

the value of the ProductIdPropertyName property.

setProductIdPropertyName

public void setProductIdPropertyName(java.lang.String pProductIdPropertyName)

Set the value of the ProductIdPropertyName property.

Parameters:

pProductIdPropertyName -

setGiftlistUIStatePath

public void setGiftlistUIStatePath(java.lang.String pGiftlistUIStatePath)

Sets property GiftlistUIStatePath

Parameters:

pGiftlistUIStatePath - path to the profile nucleus component. Usually /atg/commerce/custsvc/gifts/GiftlistUIState

getGiftlistUIStatePath

public java.lang.String getGiftlistUIStatePath()

Returns property GiftlistUIStatePath

handleRemoveItemFromGiftlist

public boolean handleRemoveItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest,
                                            atg.servlet.DynamoHttpServletResponse pResponse)
                                     throws javax.servlet.ServletException,
                                            java.io.IOException,
                                            atg.commerce.CommerceException

handleRemoveItemFromGiftlist

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if successful, false otherwise.

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

atg.commerce.CommerceException - if there was an error with Commerce

removeItemFromGiftlist

public void removeItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest,
                                   atg.servlet.DynamoHttpServletResponse pResponse)
                            throws atg.commerce.CommerceException,
                                   atg.repository.RepositoryException,
                                   javax.servlet.ServletException,
                                   java.io.IOException

Removes the given giftlistItem from the given giftlist.

Throws:

atg.commerce.CommerceException - if there were any errors removing item from giftlist.

atg.repository.RepositoryException - if an error occurs accessing the repository

java.io.IOException

javax.servlet.ServletException

preRemoveItemFromGiftlist

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

Operation called just before an removed from a giftlist

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

postRemoveItemFromGiftlist

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

Operation called just after an item has been removed from a giftlist

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

saveGiftlist

public java.lang.String saveGiftlist(java.lang.String pProfileId)
                              throws atg.commerce.CommerceException,
                                     atg.commerce.gifts.InvalidDateException

Calls the manager class to create a gift list in the repository and adds it to the current profile. Fires the agent event to indicated a new gift list has been created. Returns the newly created gift list id.

Overrides:

saveGiftlist in class atg.commerce.gifts.GiftlistFormHandler

Parameters:

pProfileId - the profile Id

Returns:

the Id of the gift list

Throws:

atg.commerce.gifts.InvalidDateException - thrown when an invalid date has been entered for a gift list

atg.commerce.CommerceException - if there was an error with Commerce

preSaveGiftlist

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

Operation called just before giftlist is saved

Overrides:

preSaveGiftlist in class atg.commerce.gifts.GiftlistFormHandler

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

createPropertyUpdates

protected java.util.List createPropertyUpdates(atg.repository.RepositoryItem pGiftlist)

Creates the list of PropertyUpdate objects which are included in the GiftlistEvent generated when a gift list is updated.

Parameters:

pGiftlist -

getPropertiesToRecord

protected java.lang.String[] getPropertiesToRecord()

Returns the array of Giftlist property names that will be checked for an update and recorded in the ticket activity and audit repository.

getPropertyUpdates

public java.util.List getPropertyUpdates()

Returns the PropertyUpdate objects which are included in the GiftlistEvent.

They are created by {@link #preUpdateGiftlist(DynamoHttpServletRequest, DynamoHttpServletResponse) and sent by {@link #postUpdateGiftlist(DynamoHttpServletRequest, DynamoHttpServletResponse)

setPropertyUpdates

public void setPropertyUpdates(java.util.List pPropertyUpdates)

preUpdateGiftlist

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

This extension is used to auto-populate the newAddressName property when a new address is being created.

Overrides:

preUpdateGiftlist in class atg.commerce.gifts.GiftlistFormHandler

Throws:

javax.servlet.ServletException

java.io.IOException

updateGiftlist

public void updateGiftlist(atg.servlet.DynamoHttpServletRequest pRequest,
                           atg.servlet.DynamoHttpServletResponse pResponse)
                    throws atg.commerce.gifts.InvalidDateException,
                           atg.commerce.CommerceException

This extension is used to first generate the PropertyUpdate objects that detail the before and after values of the updated properties. These objects are attached to the GiftlistEvent that's generated for the update. The update objects are created just before applying the updates because the before values are needed.

The PropertyUpdates are saved in the setPropertyUpdates(List) property

Overrides:

updateGiftlist in class atg.commerce.gifts.GiftlistFormHandler

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

atg.commerce.gifts.InvalidDateException

atg.commerce.CommerceException

postUpdateGiftlist

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

The extension generates the AgentEvent for the update.

Overrides:

postUpdateGiftlist in class atg.commerce.gifts.GiftlistFormHandler

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

preDeleteGiftlist

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

Operation called just before giftlist is deleted

Overrides:

preDeleteGiftlist in class atg.commerce.gifts.GiftlistFormHandler

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

postDeleteGiftlist

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

Operation called just after a giftlist is deleted

Overrides:

postDeleteGiftlist in class atg.commerce.gifts.GiftlistFormHandler

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

postAddItemToGiftlist

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

Operation called just after an item has been added to a giftlist

Overrides:

postAddItemToGiftlist in class atg.commerce.gifts.GiftlistFormHandler

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

preUpdateGiftlistItems

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

This extension generates a GiftItemEvent) for each gift item quantity that was updated and for each removed gift item.

The events are generated here so that the current quantity values can be captured. They are not sent until {@link #postUpdateGiftlistItems(DynamoHttpServletRequest, DynamoHttpServletResponse)}

Overrides:

preUpdateGiftlistItems in class atg.commerce.gifts.GiftlistFormHandler

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

getQuantity

public long getQuantity(java.lang.String pCatalogRefId,
                        atg.servlet.DynamoHttpServletRequest pRequest,
                        atg.servlet.DynamoHttpServletResponse pResponse)
                 throws javax.servlet.ServletException,
                        java.io.IOException,
                        java.lang.NumberFormatException

Overrides:

getQuantity in class atg.commerce.gifts.GiftlistFormHandler

Throws:

javax.servlet.ServletException

java.io.IOException

java.lang.NumberFormatException

postUpdateGiftlistItems

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

Operation called just after items in giftlist are updated If no form errors exist the AgentEvents returned by getGiftItemEvents() are sent.

Overrides:

postUpdateGiftlistItems in class atg.commerce.gifts.GiftlistFormHandler

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

getUserLocale

protected java.util.Locale getUserLocale()

This method gets the current Locale

Returns:

the current Locale