public class ViewOrderFormHandler
extends atg.droplet.GenericFormHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected CSREnvironmentTools |
mCSREnvironmentTools |
protected CSRScheduledOrderTools |
mCSRScheduledOrderTools |
protected atg.web.messaging.MessageTools |
mMessageTools |
protected atg.commerce.order.OrderManager |
mOrderManager |
protected javax.transaction.TransactionManager |
mTransactionManager |
protected java.lang.String |
mViewOrderId |
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
Constructor and Description |
---|
ViewOrderFormHandler() |
Modifier and Type | Method and Description |
---|---|
protected atg.commerce.order.Order |
changeViewOrder(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Sets the current order on the view order holder to the order
specified by the property
viewOrderId |
CSREnvironmentTools |
getCSREnvironmentTools() |
CSRScheduledOrderTools |
getCSRScheduledOrderTools()
Returns a reference to the CSRScheduledOrderTools component
|
java.lang.String |
getErrorURL()
Returns property ErrorURL
|
atg.web.messaging.MessageTools |
getMessageTools()
Returns the MessageTools component
|
atg.commerce.order.OrderManager |
getOrderManager() |
atg.svc.agent.ui.OriginatingPage |
getOriginatingPage()
Returns a reference to the OriginatingPage component
|
java.lang.String |
getSuccessScheduledURL()
Returns property SuccessScheduledURL
|
java.lang.String |
getSuccessURL()
Returns property SuccessURL
|
javax.transaction.TransactionManager |
getTransactionManager()
Returns the transaction manager
|
protected java.util.Locale |
getUserLocale()
This method gets the current Locale
|
java.lang.String |
getViewOrderId()
Returns the id of the order that will be loaded into the view order
holder by handleChangeViewOrder
|
boolean |
handleChangeViewOrder(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This handler is used to change the current order loaded in the view
order holder.
|
boolean |
handleFindOrderId(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This handler is used to find existing order by Id
|
protected void |
postChangeViewOrder(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Called after changing the current view order.
|
protected void |
preChangeViewOrder(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Called prior to changing the current view order.
|
void |
setCSREnvironmentTools(CSREnvironmentTools pCSREnvironmentTools) |
void |
setCSRScheduledOrderTools(CSRScheduledOrderTools pCSRScheduledOrderTools) |
void |
setErrorURL(java.lang.String pErrorURL)
Sets property ErrorURL.
|
void |
setMessageTools(atg.web.messaging.MessageTools pMessageTools) |
void |
setOrderManager(atg.commerce.order.OrderManager pOrderManager) |
void |
setOriginatingPage(atg.svc.agent.ui.OriginatingPage pOriginatingPage) |
void |
setSuccessScheduledURL(java.lang.String pSuccessScheduledURL)
Sets property SuccessScheduledURL
|
void |
setSuccessURL(java.lang.String pSuccessURL)
Sets property SuccessURL
|
void |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
Sets the Transaction Manager
|
void |
setViewOrderId(java.lang.String pViewOrderId) |
addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, 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 atg.web.messaging.MessageTools mMessageTools
protected CSREnvironmentTools mCSREnvironmentTools
protected java.lang.String mViewOrderId
protected atg.commerce.order.OrderManager mOrderManager
protected CSRScheduledOrderTools mCSRScheduledOrderTools
protected javax.transaction.TransactionManager mTransactionManager
public atg.web.messaging.MessageTools getMessageTools()
public void setMessageTools(atg.web.messaging.MessageTools pMessageTools)
public CSREnvironmentTools getCSREnvironmentTools()
public void setCSREnvironmentTools(CSREnvironmentTools pCSREnvironmentTools)
public java.lang.String getViewOrderId()
public void setViewOrderId(java.lang.String pViewOrderId)
public atg.commerce.order.OrderManager getOrderManager()
public void setOrderManager(atg.commerce.order.OrderManager pOrderManager)
public CSRScheduledOrderTools getCSRScheduledOrderTools()
public void setCSRScheduledOrderTools(CSRScheduledOrderTools pCSRScheduledOrderTools)
public void setOriginatingPage(atg.svc.agent.ui.OriginatingPage pOriginatingPage)
public atg.svc.agent.ui.OriginatingPage getOriginatingPage()
public void setErrorURL(java.lang.String pErrorURL)
This property can be set by request parameter using the name defined by ERROR_URL
.This
makes it possible to pass the parameter using an anchor tag.
pErrorURL
- a String
valuepublic java.lang.String getErrorURL()
String
valuepublic void setSuccessURL(java.lang.String pSuccessURL)
This property can be set by request parameter using the name defined by SUCCESS_URL
. This
makes it possible to pass the parameter using an anchor tag.
pSuccessURL
- a String
valuepublic java.lang.String getSuccessURL()
String
valuepublic java.lang.String getSuccessScheduledURL()
String
valuepublic void setSuccessScheduledURL(java.lang.String pSuccessScheduledURL)
pSuccessScheduledURL
- a String
valuepublic void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
pTransactionManager
- public javax.transaction.TransactionManager getTransactionManager()
protected void preChangeViewOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- pResponse
- javax.servlet.ServletException
java.io.IOException
public boolean handleChangeViewOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- pResponse
- javax.servlet.ServletException
java.io.IOException
protected void postChangeViewOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- pResponse
- javax.servlet.ServletException
java.io.IOException
public boolean handleFindOrderId(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- pResponse
- javax.servlet.ServletException
java.io.IOException
protected atg.commerce.order.Order changeViewOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
viewOrderId
If the order is a scheduled order template, the order will be re-priced (but not saved to the repository) so the view will show current day pricing.
This method calls CSRScheduledOrderTools.shouldRepriceScheduledOrder(Order)
to find out whether to re-price
the scheduled order or not . If the above method returns false, then the scheduled order is not re-priced.
pRequest
- pResponse
- javax.servlet.ServletException
java.io.IOException
CSRScheduledOrderTools.repriceScheduledOrderForView(Order)
protected java.util.Locale getUserLocale()