atg.commerce.promotion

Class GiftWithPurchaseFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.commerce.order.purchase.PurchaseProcessFormHandler

atg.commerce.promotion.GiftWithPurchaseFormHandler

All Implemented Interfaces:

atg.commerce.util.PipelineErrorHandler, atg.core.logging.Logging, atg.core.logging.TraceLogging, DropletFormHandler, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class GiftWithPurchaseFormHandler
extends PurchaseProcessFormHandler

This formhandler is used to make a gift selection for a gift with purchase promotion.

See Also:

GenericFormHandler, PurchaseProcessFormHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected java.lang.String	mCommerceItemType
protected java.lang.String	mCurrentSelectedItemId
protected java.util.Map	mExtraParameters
protected int	mGiftHashCode
protected GWPManager	mGwpManager
protected java.lang.String	mMakeGiftSelectionErrorURL
protected java.lang.String	mMakeGiftSelectionSuccessURL
protected java.lang.String	mProductId
protected java.lang.String	mPromotionId
protected long	mQuantity
protected double	mQuantityWithFraction
protected java.lang.String	mRemoveAllSelectableQuantityErrorURL
protected java.lang.String	mRemoveAllSelectableQuantitySuccessURL
protected java.lang.String	mRemoveSelectableQuantityErrorURL
protected java.lang.String	mRemoveSelectableQuantitySuccessURL
protected boolean	mReplaceFailedQuantity
protected boolean	mReplaceRemovedQuantity
protected long	mSelectableQuantityToRemove
protected double	mSelectableQuantityWithFractionToRemove
static java.lang.String	MSG_ERROR_MAKE_GIFT_SELECTION
static java.lang.String	MSG_ERROR_REMOVE_SELECTABLE_QUANTITY
protected ShippingGroup	mShippingGroup
protected java.lang.String	mSiteId
protected java.lang.String	mSkuId

Fields inherited from class atg.commerce.order.purchase.PurchaseProcessFormHandler

LOCK_NAME_ATTRIBUTE_NAME, PARAM_TRANSACTION_CREATED, PARAM_VALUE_TRUE

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
GiftWithPurchaseFormHandler()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getCatalogKey(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Get a string that will be used to identify the catalog to use when obtaining a catalogRef and productRef for the creation of a commerce item.
java.lang.String	getCommerceItemType() Returns the default item type for added commerce items
java.lang.String	getCurrentSelectedItemId() Getter for the current selected item id.
java.util.Map	getExtraParameters() Getter for the extra parameters map
int	getGiftHashCode() Getter for the gift hash code.
GWPManager	getGwpManager() Returns property GwpManager
java.lang.String	getMakeGiftSelectionErrorURL() Returns property MakeGiftSelectionErrorURL
java.lang.String	getMakeGiftSelectionSuccessURL() Returns property MakeGiftSelectionSuccessURL
protected PricingContext	getPricingContext(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Gets a pricing context to work with.
java.lang.String	getProductId() Getter for the Product id.
java.lang.String	getPromotionId() Getter for the promotion id.
long	getQuantity() Getter for the quantity.
double	getQuantityWithFraction() Getter for the quantity.
java.lang.String	getRemoveAllSelectableQuantityErrorURL() Returns property RemoveAllSelectableQuantityErrorURL
java.lang.String	getRemoveAllSelectableQuantitySuccessURL() Returns property RemoveAllSelectableQuantitySuccessURL
java.lang.String	getRemoveSelectableQuantityErrorURL() Returns property RemoveSelectableQuantityErrorURL
java.lang.String	getRemoveSelectableQuantitySuccessURL() Returns property RemoveSelectableQuantitySuccessURL
boolean	getReplaceFailedQuantity() Returns the flag whether a new selection should replace failed quantity
boolean	getReplaceRemovedQuantity() Returns the flag whether a new selection should replace removed quantity
long	getSelectableQuantityToRemove() Getter for the selectableQuantityToRemove.
double	getSelectableQuantityWithFractionToRemove() Getter for the selectableQuantityWithFractionToRemove.
ShippingGroup	getShippingGroup() Returns property ShippingGroup.
java.lang.String	getSiteId() Returns property SiteId
java.lang.String	getSkuId() Getter for the SKU id.
boolean	handleMakeGiftSelection(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
boolean	handleRemoveAllSelectableQuantity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Removes all available gift place holders.
boolean	handleRemoveSelectableQuantity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Handle method to remove selectable quantity.
protected void	makeGiftSelection(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Method to make a single gift selection or change an existing selection.
void	postMakeGiftSelection(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all work is done by the handleMakeGiftSelection method.
void	postRemoveAllSelectableQuantity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all work is done by the handleRemoveAllSelectableQuantity method.
void	postRemoveSelectableQuantity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called after all work is done by the handleRemoveSelectableQuantity method.
void	preMakeGiftSelection(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called before any work is done by the handleMakeGiftSelection method.
void	preRemoveAllSelectableQuantity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called before any work is done by the handleRemoveAllSelectableQuantity method.
void	preRemoveSelectableQuantity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called before any work is done by the handleRemoveSelectableQuantity method.
protected void	removeAllSelectableQuantity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Method to remove all selectable quantity, i.e.
protected void	removeSelectableQuantity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Method to remove selectable quantity, e.g.
void	setCommerceItemType(java.lang.String pCommerceItemType) Sets the default item type for added commerce items
void	setCurrentSelectedItemId(java.lang.String pCurrentSelectedItemId) Setter for the current selected item id.
void	setExtraParameters(java.util.Map pExtraParameters) Setter for the extra parameters
void	setGiftHashCode(int pGiftHashCode) Setter for the gift hash code.
void	setGwpManager(GWPManager pGwpManager) Sets property mGwpManager
void	setMakeGiftSelectionErrorURL(java.lang.String pMakeGiftSelectionErrorURL) Sets property MakeGiftSelectionErrorURL
void	setMakeGiftSelectionSuccessURL(java.lang.String pMakeGiftSelectionSuccessURL) Sets property MakeGiftSelectionSuccessURL
void	setProductId(java.lang.String pProductId) Setter for the Product id.
void	setPromotionId(java.lang.String pPromotionId) Setter for the promotion id.
void	setQuantity(long pQuantity) Setter for the quantity.
void	setQuantityWithFraction(double pQuantityWithFraction) Setter for the quantity.
void	setRemoveAllSelectableQuantityErrorURL(java.lang.String pRemoveAllSelectableQuantityErrorURL) Sets property RemoveAllSelectableQuantityErrorURL
void	setRemoveAllSelectableQuantitySuccessURL(java.lang.String pRemoveAllSelectableQuantitySuccessURL) Sets property RemoveAllSelectableQuantitySuccessURL
void	setRemoveSelectableQuantityErrorURL(java.lang.String pRemoveSelectableQuantityErrorURL) Sets property RemoveSelectableQuantityErrorURL
void	setRemoveSelectableQuantitySuccessURL(java.lang.String pRemoveSelectableQuantitySuccessURL) Sets property RemoveSelectableQuantitySuccessURL
void	setReplaceFailedQuantity(boolean pReplaceFailedQuantity) Sets the flag whether a new selection should replace failed quantity
void	setReplaceRemovedQuantity(boolean pReplaceRemovedQuantity) Sets the flag whether a new selection should replace removed quantity
void	setSelectableQuantityToRemove(long pSelectableQuantityToRemove) Setter for the selectableQuantityToRemove.
void	setSelectableQuantityWithFractionToRemove(double pSelectableQuantityWithFractionToRemove) Setter for the selectableQuantityWithFractionToRemove.
void	setShippingGroup(ShippingGroup pShippingGroup) Sets shipping group bean to use for modifying the shipping groups
void	setSiteId(java.lang.String pSiteId) Sets property SiteId
void	setSkuId(java.lang.String pSkuId) Setter for the SKU id.
protected void	updateOrder(Order pOrder, java.lang.String pMsgId, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Utility method to update an order and process any exception that happens during the update.

Methods inherited from class atg.commerce.order.purchase.PurchaseProcessFormHandler

acquireTransactionLock, acquireTransactionLock, afterSet, beforeSet, checkFormRedirect, commitTransaction, copyConfiguration, createRepriceParameterMap, defaultLocalLockManager, defaultUserProfile, doStartService, ensureTransaction, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, generatePropertyPath, getClaimableManager, getCommerceIdentifierPaymentInfoContainer, getCommerceItemManager, getCommerceItemShippingInfoContainer, getCommerceProfileTools, getCommercePropertyManager, getConfiguration, getCurrentTransaction, getDefaultLocale, getGiftlistManager, getHandlingInstructionManager, getLocalLockManager, getOrder, getOrderManager, getPaymentGroupManager, getPaymentGroupMapContainer, getPipelineManager, getPriceList, getPriceListId, getPriceListManager, getProfile, getProfileRepository, getPurchaseProcessHelper, getRepeatingRequestMonitor, getRepriceOrderChainId, getResourceBundle, getResourceBundle, getResourceBundleName, getSessionExpirationURL, getShippingGroupManager, getShippingGroupMapContainer, getShoppingCart, getTransactionManager, getUserLocale, getUserLocale, getUserPricingModels, handlePipelineError, isConcurrentUpdate, isEnsureTransaction, isFormSubmission, isTransactionCreated, isTransactionMarkedAsRollBack, isUseLocksAroundTransactions, isUseRequestLocale, processException, processPipelineErrors, releaseTransactionLock, releaseTransactionLock, runProcess, runProcess, runProcess, runProcessRepriceOrder, runProcessRepriceOrder, runRepricingProcess, setClaimableManager, setCommerceIdentifierPaymentInfoContainer, setCommerceItemManager, setCommerceItemShippingInfoContainer, setCommerceProfileTools, setCommercePropertyManager, setConfiguration, setCurrentTransaction, setDefaultLocale, setEnsureTransaction, setGiftlistManager, setHandlingInstructionManager, setLocalLockManager, setOrder, setOrderManager, setPaymentGroupManager, setPaymentGroupMapContainer, setPipelineManager, setPriceListId, setPriceListManager, setProfile, setProfileRepository, setPurchaseProcessHelper, setRepeatingRequestMonitor, setRepriceOrderChainId, setSessionExpirationURL, setShippingGroupManager, setShippingGroupMapContainer, setShoppingCart, setTransactionCreated, setTransactionManager, setTransactionToRollbackOnly, setUseLocksAroundTransactions, setUseRequestLocale, setUserLocale, setUserPricingModels, transactionLockName, unsetTransactionCreated

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, createAdminServlet, 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, 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 final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

MSG_ERROR_MAKE_GIFT_SELECTION

public static final java.lang.String MSG_ERROR_MAKE_GIFT_SELECTION

See Also:

Constant Field Values

MSG_ERROR_REMOVE_SELECTABLE_QUANTITY

public static final java.lang.String MSG_ERROR_REMOVE_SELECTABLE_QUANTITY

See Also:

Constant Field Values

mMakeGiftSelectionSuccessURL

protected java.lang.String mMakeGiftSelectionSuccessURL

mMakeGiftSelectionErrorURL

protected java.lang.String mMakeGiftSelectionErrorURL

mGwpManager

protected GWPManager mGwpManager

mPromotionId

protected java.lang.String mPromotionId

mGiftHashCode

protected int mGiftHashCode

mCurrentSelectedItemId

protected java.lang.String mCurrentSelectedItemId

mProductId

protected java.lang.String mProductId

mSkuId

protected java.lang.String mSkuId

mQuantity

protected long mQuantity

mQuantityWithFraction

protected double mQuantityWithFraction

mShippingGroup

protected ShippingGroup mShippingGroup

mCommerceItemType

protected java.lang.String mCommerceItemType

mReplaceRemovedQuantity

protected boolean mReplaceRemovedQuantity

mReplaceFailedQuantity

protected boolean mReplaceFailedQuantity

mSiteId

protected java.lang.String mSiteId

mExtraParameters

protected java.util.Map mExtraParameters

mRemoveSelectableQuantitySuccessURL

protected java.lang.String mRemoveSelectableQuantitySuccessURL

mRemoveSelectableQuantityErrorURL

protected java.lang.String mRemoveSelectableQuantityErrorURL

mSelectableQuantityToRemove

protected long mSelectableQuantityToRemove

mSelectableQuantityWithFractionToRemove

protected double mSelectableQuantityWithFractionToRemove

mRemoveAllSelectableQuantitySuccessURL

protected java.lang.String mRemoveAllSelectableQuantitySuccessURL

mRemoveAllSelectableQuantityErrorURL

protected java.lang.String mRemoveAllSelectableQuantityErrorURL

Constructor Detail

GiftWithPurchaseFormHandler

public GiftWithPurchaseFormHandler()

Method Detail

setMakeGiftSelectionSuccessURL

public void setMakeGiftSelectionSuccessURL(java.lang.String pMakeGiftSelectionSuccessURL)

Sets property MakeGiftSelectionSuccessURL

Parameters:

pMakeGiftSelectionSuccessURL - a String value

getMakeGiftSelectionSuccessURL

public java.lang.String getMakeGiftSelectionSuccessURL()

Returns property MakeGiftSelectionSuccessURL

Returns:

a String value

setMakeGiftSelectionErrorURL

public void setMakeGiftSelectionErrorURL(java.lang.String pMakeGiftSelectionErrorURL)

Sets property MakeGiftSelectionErrorURL

Parameters:

pMakeGiftSelectionErrorURL - a String value

getMakeGiftSelectionErrorURL

public java.lang.String getMakeGiftSelectionErrorURL()

Returns property MakeGiftSelectionErrorURL

Returns:

a String value

setGwpManager

public void setGwpManager(GWPManager pGwpManager)

Sets property mGwpManager

Parameters:

pGwpManager - GWPManager

getGwpManager

public GWPManager getGwpManager()

Returns property GwpManager

Returns:

a GWPManager

getPromotionId

public java.lang.String getPromotionId()

Getter for the promotion id.

Returns:

String promotion id

setPromotionId

public void setPromotionId(java.lang.String pPromotionId)

Setter for the promotion id.

Parameters:

pProductId - String Product id

getGiftHashCode

public int getGiftHashCode()

Getter for the gift hash code.

Returns:

int GiftHashCode

setGiftHashCode

public void setGiftHashCode(int pGiftHashCode)

Setter for the gift hash code.

Parameters:

pGiftHashCode - int GiftHashCode

getCurrentSelectedItemId

public java.lang.String getCurrentSelectedItemId()

Getter for the current selected item id.

Returns:

String commerce item id

setCurrentSelectedItemId

public void setCurrentSelectedItemId(java.lang.String pCurrentSelectedItemId)

Setter for the current selected item id.

Parameters:

pCurrentSelectedItemId - String commerce item id

getProductId

public java.lang.String getProductId()

Getter for the Product id.

Returns:

String Product id

setProductId

public void setProductId(java.lang.String pProductId)

Setter for the Product id.

Parameters:

pProductId - String Product id

getSkuId

public java.lang.String getSkuId()

Getter for the SKU id.

Returns:

String SKU id

setSkuId

public void setSkuId(java.lang.String pSkuId)

Setter for the SKU id.

Parameters:

pSkuId - String SKU id

getQuantity

public long getQuantity()

Getter for the quantity.

Returns:

long quantity

setQuantity

public void setQuantity(long pQuantity)

Setter for the quantity.

Parameters:

pQuantity - long quantity

getQuantityWithFraction

public double getQuantityWithFraction()

Getter for the quantity.

Returns:

double quantityWithFraction

setQuantityWithFraction

public void setQuantityWithFraction(double pQuantityWithFraction)

Setter for the quantity.

Parameters:

pQuantityWithFraction - double quantity

setShippingGroup

public void setShippingGroup(ShippingGroup pShippingGroup)

Sets shipping group bean to use for modifying the shipping groups

Parameters:

pShippingGroup - a ShippingGroup value

getShippingGroup

public ShippingGroup getShippingGroup()

Returns property ShippingGroup.

Returns:

a ShippingGroup value

setCommerceItemType

public void setCommerceItemType(java.lang.String pCommerceItemType)

Sets the default item type for added commerce items

getCommerceItemType

public java.lang.String getCommerceItemType()

Returns the default item type for added commerce items

setReplaceRemovedQuantity

public void setReplaceRemovedQuantity(boolean pReplaceRemovedQuantity)

Sets the flag whether a new selection should replace removed quantity

getReplaceRemovedQuantity

public boolean getReplaceRemovedQuantity()

Returns the flag whether a new selection should replace removed quantity

setReplaceFailedQuantity

public void setReplaceFailedQuantity(boolean pReplaceFailedQuantity)

Sets the flag whether a new selection should replace failed quantity

getReplaceFailedQuantity

public boolean getReplaceFailedQuantity()

Returns the flag whether a new selection should replace failed quantity

setSiteId

public void setSiteId(java.lang.String pSiteId)

Sets property SiteId

Parameters:

pSiteId - a String value

getSiteId

public java.lang.String getSiteId()

Returns property SiteId

Returns:

a String value

getExtraParameters

public java.util.Map getExtraParameters()

Getter for the extra parameters map

Returns:

Map

setExtraParameters

public void setExtraParameters(java.util.Map pExtraParameters)

Setter for the extra parameters

Parameters:

pExtraParameters - Map

getCatalogKey

protected java.lang.String getCatalogKey(DynamoHttpServletRequest pRequest,
                                         DynamoHttpServletResponse pResponse)
                                  throws javax.servlet.ServletException,
                                         java.io.IOException

Get a string that will be used to identify the catalog to use when obtaining a catalogRef and productRef for the creation of a commerce item. CatalogTools will maintain a mapping of key to catalog, currently this mapping will be maintained by the users locale.

Parameters:

pRequest - servlet request object

pResponse - servlet response object

Returns:

the catalog key

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

See Also:

CatalogTools

getPricingContext

protected PricingContext getPricingContext(DynamoHttpServletRequest pRequest,
                                           DynamoHttpServletResponse pResponse)
                                    throws javax.servlet.ServletException,
                                           java.io.IOException

Gets a pricing context to work with.

Parameters:

pRequest - servlet request object

pResponse - servlet response object

Returns:

PricingContext

Throws:

javax.servlet.ServletException

java.io.IOException

updateOrder

protected void updateOrder(Order pOrder,
                           java.lang.String pMsgId,
                           DynamoHttpServletRequest pRequest,
                           DynamoHttpServletResponse pResponse)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Utility method to update an order and process any exception that happens during the update.

Parameters:

pOrder - the order to update

pMsgId - the message ID to use in case of an exception

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException

java.io.IOException

preMakeGiftSelection

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

Called before any work is done by the handleMakeGiftSelection method. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postMakeGiftSelection

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

Called after all work is done by the handleMakeGiftSelection method. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleMakeGiftSelection

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

Throws:

javax.servlet.ServletException

java.io.IOException

makeGiftSelection

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

Method to make a single gift selection or change an existing selection.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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

setRemoveSelectableQuantitySuccessURL

public void setRemoveSelectableQuantitySuccessURL(java.lang.String pRemoveSelectableQuantitySuccessURL)

Sets property RemoveSelectableQuantitySuccessURL

Parameters:

pRemoveSelectableQuantitySuccessURL - a String value

getRemoveSelectableQuantitySuccessURL

public java.lang.String getRemoveSelectableQuantitySuccessURL()

Returns property RemoveSelectableQuantitySuccessURL

Returns:

a String value

setRemoveSelectableQuantityErrorURL

public void setRemoveSelectableQuantityErrorURL(java.lang.String pRemoveSelectableQuantityErrorURL)

Sets property RemoveSelectableQuantityErrorURL

Parameters:

pRemoveSelectableQuantityErrorURL - a String value

getRemoveSelectableQuantityErrorURL

public java.lang.String getRemoveSelectableQuantityErrorURL()

Returns property RemoveSelectableQuantityErrorURL

Returns:

a String value

getSelectableQuantityToRemove

public long getSelectableQuantityToRemove()

Getter for the selectableQuantityToRemove.

Returns:

long selectableQuantityToRemove

setSelectableQuantityToRemove

public void setSelectableQuantityToRemove(long pSelectableQuantityToRemove)

Setter for the selectableQuantityToRemove.

Parameters:

pQuantity - long selectableQuantityToRemove

getSelectableQuantityWithFractionToRemove

public double getSelectableQuantityWithFractionToRemove()

Getter for the selectableQuantityWithFractionToRemove.

Returns:

double selectableQuantityWithFractionToRemove

setSelectableQuantityWithFractionToRemove

public void setSelectableQuantityWithFractionToRemove(double pSelectableQuantityWithFractionToRemove)

Setter for the selectableQuantityWithFractionToRemove.

Parameters:

pQuantity - double selectableQuantityWithFractionToRemove

preRemoveSelectableQuantity

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

Called before any work is done by the handleRemoveSelectableQuantity method. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postRemoveSelectableQuantity

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

Called after all work is done by the handleRemoveSelectableQuantity method. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleRemoveSelectableQuantity

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

Handle method to remove selectable quantity.

Parameters:

pRequest - DynamoHttpServletRequest

pResponse - DynamoHttpServletResponse

Returns:

boolean

Throws:

javax.servlet.ServletException

java.io.IOException

removeSelectableQuantity

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

Method to remove selectable quantity, e.g. place holder quantity for a gift

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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

setRemoveAllSelectableQuantitySuccessURL

public void setRemoveAllSelectableQuantitySuccessURL(java.lang.String pRemoveAllSelectableQuantitySuccessURL)

Sets property RemoveAllSelectableQuantitySuccessURL

Parameters:

pRemoveAllSelectableQuantitySuccessURL - a String value

getRemoveAllSelectableQuantitySuccessURL

public java.lang.String getRemoveAllSelectableQuantitySuccessURL()

Returns property RemoveAllSelectableQuantitySuccessURL

Returns:

a String value

setRemoveAllSelectableQuantityErrorURL

public void setRemoveAllSelectableQuantityErrorURL(java.lang.String pRemoveAllSelectableQuantityErrorURL)

Sets property RemoveAllSelectableQuantityErrorURL

Parameters:

pRemoveAllSelectableQuantityErrorURL - a String value

getRemoveAllSelectableQuantityErrorURL

public java.lang.String getRemoveAllSelectableQuantityErrorURL()

Returns property RemoveAllSelectableQuantityErrorURL

Returns:

a String value

handleRemoveAllSelectableQuantity

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

Removes all available gift place holders.

Parameters:

pRequest -

pResponse -

Returns:

Throws:

javax.servlet.ServletException

java.io.IOException

preRemoveAllSelectableQuantity

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

Called before any work is done by the handleRemoveAllSelectableQuantity method. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postRemoveAllSelectableQuantity

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

Called after all work is done by the handleRemoveAllSelectableQuantity method. It currently does nothing.

Parameters:

pRequest - the request object

pResponse - the response object

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

removeAllSelectableQuantity

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

Method to remove all selectable quantity, i.e. all place holders in the given order

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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