atg.commerce.order.purchase

Class QuoteFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.commerce.order.purchase.PurchaseProcessFormHandler

atg.commerce.order.purchase.QuoteFormHandler

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 QuoteFormHandler
extends PurchaseProcessFormHandler

The QuoteFormHandler can be used to handle a number of operations concerning a quote:

1. requestQuote
2. requestRequote
3. acceptQuote
4. rejectQuote
5. completeQuote

This form handler makes use of the PurchaseProcessFormHandler for general functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mAcceptQuoteErrorURL
protected java.lang.String	mAcceptQuoteSuccessURL
protected java.lang.String	mCompleteQuoteErrorURL
protected java.util.Map<java.lang.String,java.lang.String>	mCompleteQuoteParameters
protected java.lang.String	mCompleteQuoteSuccessURL
protected java.lang.String	mNote
protected java.lang.String	mOrderId
protected java.lang.String	mQuoteErrorURL
protected java.lang.String	mQuoteSuccessURL
protected java.lang.String	mRejectQuoteErrorURL
protected java.lang.String	mRejectQuoteSuccessURL
protected java.lang.String	mRequoteErrorURL
protected java.lang.String	mRequoteSuccessURL
static java.lang.String	MSG_ERROR_LOAD_ORDER
static java.lang.String	MSG_ERROR_UPDATE_ORDER
static java.lang.String	MSG_ORDER_ALREADY_SUBMITTED
static java.lang.String	MSG_ORDER_EMPTY
static java.lang.String	MSG_ORDER_NOT_CURRENT
static java.lang.String	MSG_QUOTE_ACCEPT_ERROR
static java.lang.String	MSG_QUOTE_COMPLETE_ERROR
static java.lang.String	MSG_QUOTE_ERROR
static java.lang.String	MSG_QUOTE_INVALID_ORDER_ID
static java.lang.String	MSG_QUOTE_REJECT_ERROR

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
QuoteFormHandler() Constructs an instance of QuoteFormHandler

Method Summary

Modifier and Type	Method and Description
void	acceptQuote(Order pOrder, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) The method invokes OrderManager.acceptQuote in order to do initiate the order reprice and checkout process for a quoted order.
void	completeQuote(Order pOrder, java.util.Map pMap, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Processes the completion of a quoted order.
java.lang.String	getAcceptQuoteErrorURL()
java.lang.String	getAcceptQuoteSuccessURL()
java.lang.String	getCompleteQuoteErrorURL()
java.util.Map	getCompleteQuoteParameters() Return the CompleQuoteParameters property.
java.lang.String	getCompleteQuoteSuccessURL()
java.lang.String	getNote()
java.lang.String	getOrderId() Return the OrderId property.
java.lang.String	getQuoteErrorURL()
java.lang.String	getQuoteSuccessURL()
java.lang.String	getRejectQuoteErrorURL()
java.lang.String	getRejectQuoteSuccessURL()
java.lang.String	getRequoteErrorURL()
java.lang.String	getRequoteSuccessURL()
boolean	handleAcceptQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is used to accept the quoted order and initiate the repricing and checkout process for the same.
boolean	handleCompleteQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is used to complete a request for a quote.
boolean	handleRejectQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method handles all of the work necessary to reject a quoted order.
boolean	handleRequestQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is used to submit an order for quotation.
boolean	handleRequestRequote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is used to submit an order for requotation.
void	postAcceptQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called after all processing is done by the handleAcceptQuote method.
void	postCompleteQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called after all processing is done by the handleCompleteQuote method.
void	postRejectQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called after all processing is done by the handleRejectQuote method.
void	postRequestQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called after all processing is done by the handleRequestQuote method.
void	postRequestRequote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called after all processing is done by the handleRequestRequote method.
void	preAcceptQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called before any processing is done by the handleAcceptQuote method.
void	preCompleteQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called before any processing is done by the handleCompleteQuote method.
void	preRejectQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called before any processing is done by the handleRejectQuote method.
void	preRequestQuote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called before any processing is done by the handleRequestQuote method.
void	preRequestRequote(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This is called before any processing is done by the handleRequestRequote method.
void	rejectQuote(Order pOrder, java.lang.String pNote, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Processes the rejection of a quoted order.
void	requestQuote(Order pOrder, java.lang.String pNote, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called between preRequestQuote and postRequestQuote.
void	requestRequote(Order pOrder, java.lang.String pNote, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called between preRequestRequote and postRequestRequote.
void	setAcceptQuoteErrorURL(java.lang.String pAcceptQuoteErrorURL)
void	setAcceptQuoteSuccessURL(java.lang.String pAcceptQuoteSuccessURL)
void	setCompleteQuoteErrorURL(java.lang.String pCompleteQuoteErrorURL)
void	setCompleteQuoteParameters(java.util.Map<java.lang.String,java.lang.String> pCompleteQuoteParameters) Set the CompleteQuoteParameters
void	setCompleteQuoteSuccessURL(java.lang.String pCompleteQuoteSuccessURL)
void	setNote(java.lang.String pNote)
void	setOrderId(java.lang.String pOrderId) Set the OrderId property.
void	setQuoteErrorURL(java.lang.String pQuoteErrorURL)
void	setQuoteSuccessURL(java.lang.String pQuoteSuccessURL)
void	setRejectQuoteErrorURL(java.lang.String pRejectQuoteErrorURL)
void	setRejectQuoteSuccessURL(java.lang.String pRejectQuoteSuccessURL)
void	setRequoteErrorURL(java.lang.String pRequoteErrorURL)
void	setRequoteSuccessURL(java.lang.String pRequoteSuccessURL)

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

Class version string

See Also:

Constant Field Values

MSG_ORDER_EMPTY

public static final java.lang.String MSG_ORDER_EMPTY

See Also:

Constant Field Values

MSG_QUOTE_ERROR

public static final java.lang.String MSG_QUOTE_ERROR

See Also:

Constant Field Values

MSG_QUOTE_ACCEPT_ERROR

public static final java.lang.String MSG_QUOTE_ACCEPT_ERROR

See Also:

Constant Field Values

MSG_QUOTE_REJECT_ERROR

public static final java.lang.String MSG_QUOTE_REJECT_ERROR

See Also:

Constant Field Values

MSG_QUOTE_COMPLETE_ERROR

public static final java.lang.String MSG_QUOTE_COMPLETE_ERROR

See Also:

Constant Field Values

MSG_ORDER_ALREADY_SUBMITTED

public static final java.lang.String MSG_ORDER_ALREADY_SUBMITTED

See Also:

Constant Field Values

MSG_ORDER_NOT_CURRENT

public static final java.lang.String MSG_ORDER_NOT_CURRENT

See Also:

Constant Field Values

MSG_QUOTE_INVALID_ORDER_ID

public static final java.lang.String MSG_QUOTE_INVALID_ORDER_ID

See Also:

Constant Field Values

MSG_ERROR_LOAD_ORDER

public static final java.lang.String MSG_ERROR_LOAD_ORDER

See Also:

Constant Field Values

MSG_ERROR_UPDATE_ORDER

public static final java.lang.String MSG_ERROR_UPDATE_ORDER

See Also:

Constant Field Values

mOrderId

protected java.lang.String mOrderId

mNote

protected java.lang.String mNote

mQuoteSuccessURL

protected java.lang.String mQuoteSuccessURL

mQuoteErrorURL

protected java.lang.String mQuoteErrorURL

mRequoteSuccessURL

protected java.lang.String mRequoteSuccessURL

mRequoteErrorURL

protected java.lang.String mRequoteErrorURL

mAcceptQuoteSuccessURL

protected java.lang.String mAcceptQuoteSuccessURL

mAcceptQuoteErrorURL

protected java.lang.String mAcceptQuoteErrorURL

mRejectQuoteSuccessURL

protected java.lang.String mRejectQuoteSuccessURL

mRejectQuoteErrorURL

protected java.lang.String mRejectQuoteErrorURL

mCompleteQuoteParameters

protected java.util.Map<java.lang.String,java.lang.String> mCompleteQuoteParameters

mCompleteQuoteSuccessURL

protected java.lang.String mCompleteQuoteSuccessURL

mCompleteQuoteErrorURL

protected java.lang.String mCompleteQuoteErrorURL

Constructor Detail

QuoteFormHandler

public QuoteFormHandler()

Constructs an instance of QuoteFormHandler

Method Detail

setOrderId

public void setOrderId(java.lang.String pOrderId)

Set the OrderId property.

Parameters:

pOrderId - a String value

getOrderId

public java.lang.String getOrderId()

Return the OrderId property.

Returns:

a String value

getNote

public java.lang.String getNote()

Returns:

Returns the note.

setNote

public void setNote(java.lang.String pNote)

Parameters:

pNote - The note to set.

getQuoteSuccessURL

public java.lang.String getQuoteSuccessURL()

Returns:

Returns the QuoteSuccessURL.

setQuoteSuccessURL

public void setQuoteSuccessURL(java.lang.String pQuoteSuccessURL)

Parameters:

pQuoteSuccessURL - The QuoteSuccessURL to set.

getQuoteErrorURL

public java.lang.String getQuoteErrorURL()

Returns:

Returns the QuoteErrorURL.

setQuoteErrorURL

public void setQuoteErrorURL(java.lang.String pQuoteErrorURL)

Parameters:

pQuoteErrorURL - The QuoteErrorURL to set.

getRequoteSuccessURL

public java.lang.String getRequoteSuccessURL()

Returns:

Returns the RequoteSuccessURL.

setRequoteSuccessURL

public void setRequoteSuccessURL(java.lang.String pRequoteSuccessURL)

Parameters:

pRequoteSuccessURL - The RequoteSuccessURL to set.

getRequoteErrorURL

public java.lang.String getRequoteErrorURL()

Returns:

Returns the RequoteErrorURL.

setRequoteErrorURL

public void setRequoteErrorURL(java.lang.String pRequoteErrorURL)

Parameters:

pRequoteErrorURL - The RequoteErrorURL to set.

getAcceptQuoteSuccessURL

public java.lang.String getAcceptQuoteSuccessURL()

Returns:

Returns the acceptQuoteSuccessURL.

setAcceptQuoteSuccessURL

public void setAcceptQuoteSuccessURL(java.lang.String pAcceptQuoteSuccessURL)

Parameters:

pAcceptQuoteSuccessURL - The acceptQuoteSuccessURL to set.

getAcceptQuoteErrorURL

public java.lang.String getAcceptQuoteErrorURL()

Returns:

Returns the acceptQuoteErrorURL .

setAcceptQuoteErrorURL

public void setAcceptQuoteErrorURL(java.lang.String pAcceptQuoteErrorURL)

Parameters:

pAcceptQuoteErrorURL - The acceptQuoteErrorURL to set.

getRejectQuoteSuccessURL

public java.lang.String getRejectQuoteSuccessURL()

Returns:

returns the rejectQuoteSuccessURL.

setRejectQuoteSuccessURL

public void setRejectQuoteSuccessURL(java.lang.String pRejectQuoteSuccessURL)

Parameters:

pRejectQuoteSuccessURL - The rejectQuoteSuccessURL to set.

getRejectQuoteErrorURL

public java.lang.String getRejectQuoteErrorURL()

Returns:

Returns the rejectQuoteErrorURL.

setRejectQuoteErrorURL

public void setRejectQuoteErrorURL(java.lang.String pRejectQuoteErrorURL)

Parameters:

pRejectQuoteErrorURL - The rejectQuoteErrorURL to set.

setCompleteQuoteParameters

public void setCompleteQuoteParameters(java.util.Map<java.lang.String,java.lang.String> pCompleteQuoteParameters)

Set the CompleteQuoteParameters

Parameters:

pCompleteQuoteParameters - a map containing information to complete the quote

getCompleteQuoteParameters

public java.util.Map getCompleteQuoteParameters()

Return the CompleQuoteParameters property.

Returns:

a HashMap value

getCompleteQuoteSuccessURL

public java.lang.String getCompleteQuoteSuccessURL()

Returns:

returns the completeQuoteSuccessURL.

setCompleteQuoteSuccessURL

public void setCompleteQuoteSuccessURL(java.lang.String pCompleteQuoteSuccessURL)

Parameters:

pCompleteQuoteSuccessURL - The completeQuoteSuccessURL to set.

getCompleteQuoteErrorURL

public java.lang.String getCompleteQuoteErrorURL()

Returns:

Returns the completeQuoteErrorURL.

setCompleteQuoteErrorURL

public void setCompleteQuoteErrorURL(java.lang.String pCompleteQuoteErrorURL)

Parameters:

pCompleteQuoteErrorURL - The completeQuoteErrorURL to set.

preRequestQuote

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

This is called before any processing is done by the handleRequestQuote method. It currently does nothing.

Parameters:

pRequest - the servlet request

pResponse - the servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

handleRequestQuote

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

This method is used to submit an order for quotation. It calls the preRequestQuote method, allowing the application to do any required work before the order is sent to OrderManagers requestQuote method. Next it ensures that the user is not trying to double submit the order by seeing if the shopping cart last order id is is equal to the current order id.

Assuming the order is not a duplicate submission, the form handler calls OrderManager.requestQuote to kick off the requestQuote pipeline chain. If requestQuote pipeline chain succeeds, then the quoteInfo object is added to the Order and the order status is set to PENDING_QUOTE (see OrderStates). Finally, it calls the postRequestQuote method for any application-specific post-processing.

Parameters:

pRequest - the servlet request

pResponse - the servlet 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

requestQuote

public void requestQuote(Order pOrder,
                         java.lang.String pNote,
                         DynamoHttpServletRequest pRequest,
                         DynamoHttpServletResponse pResponse)
                  throws javax.servlet.ServletException,
                         java.io.IOException

This method is called between preRequestQuote and postRequestQuote.

Parameters:

pOrder - the current order

pNote - the customer note to the supplier

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

postRequestQuote

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

This is called after all processing is done by the handleRequestQuote method. It currently does nothing.

Parameters:

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

preRequestRequote

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

This is called before any processing is done by the handleRequestRequote method. It currently does nothing.

Parameters:

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

handleRequestRequote

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

This method is used to submit an order for requotation. It calls the preRequestRequote method, allowing the application to do any required work before the order is sent to OrderManagers requestQuote method. Next it ensures that the orderId is not that of the current shopping cart (OrderHolder) or one of the orders in the shopping carts saved orders OrderHolder.isOrderIdInSavedOrders

The form handler calls then calls into OrderManager.requestQuote to kick off the requestQuote pipeline chain. If requestQuote pipeline chain succeeds, then the quoteInfo object is added to the Order and the order status is set to PENDING_QUOTE (see OrderStates). Finally, it calls the postRequestRequote method for any application-specific post-processing.

Parameters:

pRequest - servlet request

pResponse - servlet 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

requestRequote

public void requestRequote(Order pOrder,
                           java.lang.String pNote,
                           DynamoHttpServletRequest pRequest,
                           DynamoHttpServletResponse pResponse)
                    throws javax.servlet.ServletException,
                           java.io.IOException

This method is called between preRequestRequote and postRequestRequote. It calls into OrderManager.requestQuote

Parameters:

pOrder - the current order

pNote - the customer note to the supplier

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

postRequestRequote

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

This is called after all processing is done by the handleRequestRequote method. It currently does nothing.

Parameters:

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

preAcceptQuote

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

This is called before any processing is done by the handleAcceptQuote method. It currently does nothing.

Parameters:

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleAcceptQuote

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

This method is used to accept the quoted order and initiate the repricing and checkout process for the same. This method calls the preAcceptQuote method, allowing the application to do any required work before the order is submitted , acceptQuote method which calls into OrderManager.acceptQuote and finally calls the postAcceptQuote method for any application- specific post-processing.

Parameters:

pRequest - servlet request

pResponse - servlet response

Returns:

true if processing was successful and 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

acceptQuote

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

The method invokes OrderManager.acceptQuote in order to do initiate the order reprice and checkout process for a quoted order.

Parameters:

pOrder - the current order

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

postAcceptQuote

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

This is called after all processing is done by the handleAcceptQuote method. It currently does nothing. By the time this method is called the quoted order should have been successfully submitted.

Parameters:

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preRejectQuote

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

This is called before any processing is done by the handleRejectQuote method. It currently does nothing.

Parameters:

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

handleRejectQuote

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

This method handles all of the work necessary to reject a quoted order. It will first make a call to preRejectQuote. Then then it will call rejectQuote which does the work of executing the appropriate pipeline chain. Finally, postRejectQuote is called.

Parameters:

pRequest - servlet request

pResponse - servlet 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

rejectQuote

public void rejectQuote(Order pOrder,
                        java.lang.String pNote,
                        DynamoHttpServletRequest pRequest,
                        DynamoHttpServletResponse pResponse)
                 throws javax.servlet.ServletException,
                        java.io.IOException

Processes the rejection of a quoted order. This is done by calling OrderManager.rejectQuote(atg.commerce.order.Order, String, java.util.HashMap).

Parameters:

pOrder - the order to be rejected

pNote - an optional rejection note

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

postRejectQuote

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

This is called after all processing is done by the handleRejectQuote method. It currently does nothing.

Parameters:

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

preCompleteQuote

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

This is called before any processing is done by the handleCompleteQuote method. It currently does nothing.

Parameters:

pRequest - the servlet request

pResponse - the servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

handleCompleteQuote

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

This method is used to complete a request for a quote. It calls the preCompleteQuote method, allowing the application to do any required work before the order is sent to OrderManagers completeQuote method. OrderManager.completeQuote(atg.commerce.order.Order, java.util.HashMap) is called to kick off the completeQuote pipeline chain. If completeQuote pipeline chain succeeds, then the order status is set to QUOTED (see OrderStates). Finally, it calls the postCompleteQuote method for any application-specific post-processing.

Parameters:

pRequest - the servlet request

pResponse - the servlet 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

completeQuote

public void completeQuote(Order pOrder,
                          java.util.Map pMap,
                          DynamoHttpServletRequest pRequest,
                          DynamoHttpServletResponse pResponse)
                   throws javax.servlet.ServletException,
                          java.io.IOException

Processes the completion of a quoted order. This method is called between preCompleteQuote and postCompleteQuote. and calls into OrderManager.completeQuote(atg.commerce.order.Order, java.util.HashMap).

Parameters:

pOrder - the current order

pMap - map containing information to complete the quote

Throws:

java.io.IOException

javax.servlet.ServletException

postCompleteQuote

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

This is called after all processing is done by the handleCompleteQuote method. It currently clears out the completeQuoteParametersMap

Parameters:

pRequest - servlet request

pResponse - servlet response

Throws:

javax.servlet.ServletException

java.io.IOException