public class CSRGiftlistFormHandler
extends atg.commerce.gifts.GiftlistFormHandler
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.web.messaging.MessageTools |
mMessageTools |
protected java.util.List |
mPropertyUpdates |
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_NO_GIFTLIST_TO_MODIFY, MSG_NO_ITEM_FOUND, MSG_NO_ITEMS_TO_ADD, MSG_NO_SKU_WITH_ID, MSG_QUANTITY_LESSTHAN_OR_EQUALTO_ZERO, MY_RESOURCE_NAME, QUANTITY_NOT_VALID, sResourceBundle
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
Constructor and Description |
---|
CSRGiftlistFormHandler() |
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. |
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.
|
atg.web.messaging.MessageTools |
getMessageTools()
Returns the MessageTools component
|
atg.core.util.ContactInfo |
getNewAddress()
Returns property newAddress.
|
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 . |
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 |
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 |
setMessageTools(atg.web.messaging.MessageTools pMessageTools)
Sets the MessageTools component
|
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. |
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, getQuantity, 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, 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, setRemoveGiftitemIds, setSaveGiftlistErrorURL, setSaveGiftlistSuccessURL, setSendItemRemovedMessages, setShippingAddressId, setShoppingCart, setSiteId, setSpecialInstructions, setUpdateGiftlistErrorURL, setUpdateGiftlistItemsErrorURL, setUpdateGiftlistItemsSuccessURL, setUpdateGiftlistSuccessURL, setUseRequestLocale, setYear, updateEventDate, updateGiftlistItems, updateOrder, validateGiftlistId
afterSet, beforeSet, checkFormRedirect, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, isTransactionMarkedAsRollback, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation
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
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, 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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
protected static final java.lang.String EVENT_NAME_ATTRIBUTE_NAME
protected static final java.lang.String CATALOG_REF_ID_ATTRIBUTE_NAME
public static final java.lang.String ENVRESOURCES
protected atg.web.messaging.MessageTools mMessageTools
protected atg.svc.agent.environment.EnvironmentTools mEnvironmentTools
protected CSRAgentTools mCSRAgentTools
protected java.util.List mPropertyUpdates
public atg.web.messaging.MessageTools getMessageTools()
If the mMessageTools
is null, then EnvironmentTools#getMessageTools()
sets mMessageTools
.
EnvironmentTools.getMessageTools()
public void setMessageTools(atg.web.messaging.MessageTools pMessageTools)
public atg.svc.agent.environment.EnvironmentTools getEnvironmentTools()
public void setEnvironmentTools(atg.svc.agent.environment.EnvironmentTools pEnvironmentTools)
public void setCSRAgentTools(CSRAgentTools pAgentTools)
public CSRAgentTools getCSRAgentTools()
public atg.core.util.ContactInfo getNewAddress()
getNewAddress
in class atg.commerce.gifts.GiftlistFormHandler
public void setProfileTools(atg.commerce.profile.CommerceProfileTools pProfileTools)
setProfileTools
in class atg.commerce.gifts.GiftlistFormHandler
public atg.commerce.profile.CommerceProfileTools getProfileTools()
getProfileTools
in class atg.commerce.gifts.GiftlistFormHandler
public void setGiftItemId(java.lang.String pGiftItemId)
pGiftItemId
- The property to store the giftItemIdpublic java.lang.String getGiftItemId()
public void setRemoveItemFromGiftlistErrorURL(java.lang.String pRemoveItemFromGiftlistErrorURL)
pRemoveItemFromGiftlistErrorURL
- The property to store the error URL for removeItemFromGiftlist.public java.lang.String getRemoveItemFromGiftlistErrorURL()
public void setGiftItemEvents(java.util.List pGiftItemEvents)
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.
pGiftItemEvents
- public java.util.List getGiftItemEvents()
public boolean handleRemoveItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException, atg.commerce.CommerceException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioatg.commerce.CommerceException
- if there was an error with Commercepublic void removeItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws atg.commerce.CommerceException, atg.repository.RepositoryException, javax.servlet.ServletException, java.io.IOException
atg.commerce.CommerceException
- if there were any errors removing item from giftlist.atg.repository.RepositoryException
- if an error occurs accessing the repositoryjava.io.IOException
javax.servlet.ServletException
public void preRemoveItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postRemoveItemFromGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic java.lang.String saveGiftlist(java.lang.String pProfileId) throws atg.commerce.CommerceException, atg.commerce.gifts.InvalidDateException
saveGiftlist
in class atg.commerce.gifts.GiftlistFormHandler
pProfileId
- the profile Idatg.commerce.gifts.InvalidDateException
- thrown when an invalid date has been entered for a gift listatg.commerce.CommerceException
- if there was an error with Commercepublic void preSaveGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
preSaveGiftlist
in class atg.commerce.gifts.GiftlistFormHandler
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongprotected java.util.List createPropertyUpdates(atg.repository.RepositoryItem pGiftlist)
PropertyUpdate
objects which are included
in the GiftlistEvent
generated when a gift list is updated.pGiftlist
- protected java.lang.String[] getPropertiesToRecord()
public java.util.List getPropertyUpdates()
PropertyUpdate
objects which are included in the GiftlistEvent
.
They are created by {@link #preUpdateGiftlist(DynamoHttpServletRequest, DynamoHttpServletResponse) and sent by {@link #postUpdateGiftlist(DynamoHttpServletRequest, DynamoHttpServletResponse)
public void setPropertyUpdates(java.util.List pPropertyUpdates)
public void preUpdateGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
newAddressName
property when a new address is
being created.preUpdateGiftlist
in class atg.commerce.gifts.GiftlistFormHandler
javax.servlet.ServletException
java.io.IOException
public void updateGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws atg.commerce.gifts.InvalidDateException, atg.commerce.CommerceException
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
updateGiftlist
in class atg.commerce.gifts.GiftlistFormHandler
pRequest
- the dynamo request objectpResponse
- the dynamo response objectatg.commerce.gifts.InvalidDateException
atg.commerce.CommerceException
public void postUpdateGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
AgentEvent
for the update.postUpdateGiftlist
in class atg.commerce.gifts.GiftlistFormHandler
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void preDeleteGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
preDeleteGiftlist
in class atg.commerce.gifts.GiftlistFormHandler
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postDeleteGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
postDeleteGiftlist
in class atg.commerce.gifts.GiftlistFormHandler
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postAddItemToGiftlist(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
postAddItemToGiftlist
in class atg.commerce.gifts.GiftlistFormHandler
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void preUpdateGiftlistItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
The events are generated here so that the current quantity values can be captured. They are not sent until {@link #postUpdateGiftlistItems(DynamoHttpServletRequest, DynamoHttpServletResponse)}
preUpdateGiftlistItems
in class atg.commerce.gifts.GiftlistFormHandler
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postUpdateGiftlistItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
getGiftItemEvents()
are sent.postUpdateGiftlistItems
in class atg.commerce.gifts.GiftlistFormHandler
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongprotected java.util.Locale getUserLocale()