public class OrderNoteFormHandler
extends atg.droplet.GenericFormHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected CSRAgentMessagingTools |
mAgentMessagingTools |
protected java.lang.String |
mComment |
protected CSRAgentTools |
mCSRAgentTools |
protected java.lang.String |
mErrorURL |
protected atg.commerce.order.Order |
mOrder |
protected atg.commerce.order.OrderManager |
mOrderManager |
protected java.lang.String |
mSuccessURL |
protected javax.transaction.TransactionManager |
mTransactionManager |
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
Constructor and Description |
---|
OrderNoteFormHandler() |
Modifier and Type | Method and Description |
---|---|
CSRAgentMessagingTools |
getAgentMessagingTools()
Gets the AgentMessagingTools
|
java.lang.String |
getComment()
Return the comment that gets added to the Order.
|
CSRAgentTools |
getCSRAgentTools()
Gets the CSRAgentTools
|
java.lang.String |
getErrorURL()
Gets the ErrorURL
|
atg.commerce.order.Order |
getOrder()
Gets the Order
|
atg.commerce.order.OrderManager |
getOrderManager()
Gets the OrderManager
|
java.lang.String |
getSuccessURL()
Gets the SuccessURL
|
javax.transaction.TransactionManager |
getTransactionManager()
Returns the transaction manager
|
boolean |
handleAddComment(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This method is responsible for adding a comment to the order's
activity log
|
protected void |
postAddComment(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This is called after all processing is done by the
handleAddComment method.
|
protected void |
preAddComment(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This is called before any processing is done by the
handleAddComment method.
|
void |
setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools)
Sets the AgentMessagingTools
|
void |
setComment(java.lang.String pComment)
Sets the Comment
|
void |
setCSRAgentTools(CSRAgentTools pCSRAgentTools)
Sets the CSRAgentTools
|
void |
setErrorURL(java.lang.String pErrorURL)
Sets the ErrorURL
|
void |
setOrder(atg.commerce.order.Order pOrder)
Sets the Order
|
void |
setOrderManager(atg.commerce.order.OrderManager pOrderManager)
Sets the OrderManager
|
void |
setSuccessURL(java.lang.String pSuccessURL)
Sets the SuccessURL
|
void |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
Sets the Transaction Manager
|
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 java.lang.String mComment
protected java.lang.String mErrorURL
protected java.lang.String mSuccessURL
protected atg.commerce.order.Order mOrder
protected atg.commerce.order.OrderManager mOrderManager
protected CSRAgentTools mCSRAgentTools
protected CSRAgentMessagingTools mAgentMessagingTools
protected javax.transaction.TransactionManager mTransactionManager
public java.lang.String getComment()
public void setComment(java.lang.String pComment)
pComment
- The Comment to setpublic java.lang.String getErrorURL()
public void setErrorURL(java.lang.String pErrorURL)
pErrorURL
- The ErrorURL to setpublic java.lang.String getSuccessURL()
public void setSuccessURL(java.lang.String pSuccessURL)
pSuccessURL
- The SuccessURL to setpublic atg.commerce.order.Order getOrder()
public void setOrder(atg.commerce.order.Order pOrder)
pOrder
- The Order to setpublic atg.commerce.order.OrderManager getOrderManager()
public void setOrderManager(atg.commerce.order.OrderManager pOrderManager)
pOrderManager
- The OrderManager to setpublic CSRAgentTools getCSRAgentTools()
public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)
pCSRAgentTools
- The CSRAgentTools to setpublic CSRAgentMessagingTools getAgentMessagingTools()
public void setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools)
pAgentMessagingTools
- The AgentMessagingTools to setpublic void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
pTransactionManager
- public javax.transaction.TransactionManager getTransactionManager()
public boolean handleAddComment(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
pRequest
- the request objectpResponse
- the response objectjavax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occursprotected void preAddComment(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occursprotected void postAddComment(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
It currently resets the comment property if there weren't any errors.
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurs