atg.commerce.csr.order
Class OrderNoteFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.commerce.csr.order.OrderNoteFormHandler

All Implemented Interfaces:

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

public class OrderNoteFormHandler
extends atg.droplet.GenericFormHandler

This form handler is used to handle the adding of Notes to Orders..

Field Summary

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

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

OrderNoteFormHandler()

Method Summary

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

Methods inherited from class atg.droplet.GenericFormHandler

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

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

Methods inherited from class atg.nucleus.GenericService

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

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, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mComment

protected java.lang.String mComment

mErrorURL

protected java.lang.String mErrorURL

mSuccessURL

protected java.lang.String mSuccessURL

mOrder

protected atg.commerce.order.Order mOrder

mOrderManager

protected atg.commerce.order.OrderManager mOrderManager

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

mAgentMessagingTools

protected CSRAgentMessagingTools mAgentMessagingTools

mTransactionManager

protected javax.transaction.TransactionManager mTransactionManager

Constructor Detail

OrderNoteFormHandler

public OrderNoteFormHandler()

Method Detail

getComment

public java.lang.String getComment()

Return the comment that gets added to the Order.

Returns:

the Comment

setComment

public void setComment(java.lang.String pComment)

Sets the Comment

Parameters:

pComment - The Comment to set

getErrorURL

public java.lang.String getErrorURL()

Gets the ErrorURL

Returns:

the ErrorURL

setErrorURL

public void setErrorURL(java.lang.String pErrorURL)

Sets the ErrorURL

Parameters:

pErrorURL - The ErrorURL to set

getSuccessURL

public java.lang.String getSuccessURL()

Gets the SuccessURL

Returns:

the SuccessURL

setSuccessURL

public void setSuccessURL(java.lang.String pSuccessURL)

Sets the SuccessURL

Parameters:

pSuccessURL - The SuccessURL to set

getOrder

public atg.commerce.order.Order getOrder()

Gets the Order

Returns:

the Order

setOrder

public void setOrder(atg.commerce.order.Order pOrder)

Sets the Order

Parameters:

pOrder - The Order to set

getOrderManager

public atg.commerce.order.OrderManager getOrderManager()

Gets the OrderManager

Returns:

the OrderManager

setOrderManager

public void setOrderManager(atg.commerce.order.OrderManager pOrderManager)

Sets the OrderManager

Parameters:

pOrderManager - The OrderManager to set

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Gets the CSRAgentTools

Returns:

the CSRAgentTools

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)

Sets the CSRAgentTools

Parameters:

pCSRAgentTools - The CSRAgentTools to set

getAgentMessagingTools

public CSRAgentMessagingTools getAgentMessagingTools()

Gets the AgentMessagingTools

Returns:

the AgentMessagingTools

setAgentMessagingTools

public void setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools)

Sets the AgentMessagingTools

Parameters:

pAgentMessagingTools - The AgentMessagingTools to set

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Sets the Transaction Manager

Parameters:

pTransactionManager -

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Returns the transaction manager

handleAddComment

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

This method is responsible for adding a comment to the order's activity log

Parameters:

pRequest - the request object

pResponse - the response object

Returns:

true if the method was handled

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preAddComment

protected void preAddComment(atg.servlet.DynamoHttpServletRequest pRequest,
                             atg.servlet.DynamoHttpServletResponse pResponse)

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

Parameters:

pRequest - a value of type 'DynamoHttpServletRequest'

pResponse - a value of type 'DynamoHttpServletResponse'

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postAddComment

protected void postAddComment(atg.servlet.DynamoHttpServletRequest pRequest,
                              atg.servlet.DynamoHttpServletResponse pResponse)

This is called after all processing is done by the handleAddComment method.

It currently resets the comment property if there weren't any errors.

Parameters:

pRequest - a value of type 'DynamoHttpServletRequest'

pResponse - a value of type 'DynamoHttpServletResponse'

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs