public class ApprovalFormHandler extends GenericFormHandler implements atg.commerce.util.PipelineErrorHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
protected static boolean |
FAILURE |
protected static java.lang.String |
MSG_UNABLE_TO_APPROVE_ORDER |
protected static java.lang.String |
MSG_UNABLE_TO_REJECT_ORDER |
protected static boolean |
SUCCESS |
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ApprovalFormHandler()
Creates a new
ApprovalFormHandler instance. |
Modifier and Type | Method and Description |
---|---|
void |
approveOrder(Order pOrder,
RepositoryItem pProfile,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Runs the pipeline chain for approving the order and then handles the results.
|
PipelineManager |
getApprovalPipelineManager()
Returns property approvalPipelineManager
|
java.lang.String |
getApprovedOrderState()
Return the approvedOrderState property.
|
java.lang.String |
getApproveOrderErrorURL()
Return the approveOrderErrorURL property.
|
java.lang.String |
getApproveOrderSuccessURL()
Return the approveOrderSuccessURL property.
|
java.lang.String |
getApproverMessage()
Returns property approverMessage
|
protected Order |
getOrder() |
java.lang.String |
getOrderApprovedChainId()
Returns property orderApprovedChainId
|
java.lang.String |
getOrderId()
Return the orderId property.
|
OrderManager |
getOrderManager()
Return the orderManager property.
|
java.lang.String |
getOrderRejectedChainId()
Returns property orderRejectedChainId
|
MutableRepository |
getOrderRepository()
Returns property orderRepository
|
OrderStates |
getOrderStates()
Return the orderStates property.
|
java.lang.String |
getRejectedOrderState()
Return the rejectedOrderState property.
|
java.lang.String |
getRejectOrderErrorURL()
Return the rejectOrderErrorURL property.
|
java.lang.String |
getRejectOrderSuccessURL()
Return the rejectOrderSuccessURL property.
|
javax.transaction.TransactionManager |
getTransactionManager()
Return the TransactionManager property.
|
java.util.Locale |
getUserLocale(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns the locale associated with the request.
|
boolean |
handleApproveOrder(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse) |
void |
handlePipelineError(java.lang.Object pError,
java.lang.String pErrorKey)
Add a pipeline error to the list of form exceptions.
|
boolean |
handleRejectOrder(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse) |
boolean |
isUseRequestLocale()
Return the useRequestLocale property.
|
protected Order |
loadOrder(java.lang.String pOrderId) |
void |
postApproveOrder(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse) |
void |
postRejectOrder(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse) |
void |
preApproveOrder(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse) |
void |
preRejectOrder(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse) |
void |
processException(java.lang.Exception pException,
java.lang.String pMsgId,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Add a user error message to the form exceptions, and then display
the exception in the logs
|
protected boolean |
processPipelineErrors(PipelineResult pResult)
Examine the pipeline result looking for any error messages, creates DropletFormExceptions
and adds them as form exceptions
|
void |
rejectOrder(Order pOrder,
RepositoryItem pProfile,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Runs the pipeline chain for rejecting the order and then handles the results.
|
void |
setApprovalPipelineManager(PipelineManager pApprovalPipelineManager)
Sets property approvalPipelineManager
|
void |
setApprovedOrderState(java.lang.String pApprovedOrderState)
Set the approvedOrderState property.
|
void |
setApproveOrderErrorURL(java.lang.String pApproveOrderErrorURL)
Set the approveOrderErrorURL property.
|
void |
setApproveOrderSuccessURL(java.lang.String pApproveOrderSuccessURL)
Set the approveOrderSuccessURL property.
|
void |
setApproverMessage(java.lang.String pApproverMessage)
Sets property approverMessage
|
void |
setOrderApprovedChainId(java.lang.String pOrderApprovedChainId)
Sets property orderApprovedChainId
|
void |
setOrderId(java.lang.String pOrderId)
Set the orderId property.
|
void |
setOrderManager(OrderManager pOrderManager)
Set the orderManager property.
|
void |
setOrderRejectedChainId(java.lang.String pOrderRejectedChainId)
Sets property orderRejectedChainId
|
void |
setOrderRepository(MutableRepository pOrderRepository)
Sets property orderRepository
|
void |
setOrderStates(OrderStates pOrderStates)
Set the orderStates property.
|
void |
setRejectedOrderState(java.lang.String pRejectedOrderState)
Set the rejectedOrderState property.
|
void |
setRejectOrderErrorURL(java.lang.String pRejectOrderErrorURL)
Set the rejectOrderErrorURL property.
|
void |
setRejectOrderSuccessURL(java.lang.String pRejectOrderSuccessURL)
Set the rejectOrderSuccessURL property.
|
void |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
Set the TransactionManager property.
|
void |
setUseRequestLocale(boolean pUseRequestLocale)
Set the useRequestLocale property.
|
protected void |
updateOrder(Order pOrder) |
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
afterGet, beforeGet
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 static final java.lang.String MSG_UNABLE_TO_APPROVE_ORDER
protected static final java.lang.String MSG_UNABLE_TO_REJECT_ORDER
protected static final boolean SUCCESS
protected static final boolean FAILURE
public ApprovalFormHandler()
ApprovalFormHandler
instance.public PipelineManager getApprovalPipelineManager()
public void setApprovalPipelineManager(PipelineManager pApprovalPipelineManager)
pApprovalPipelineManager
- the value to set for property approvalPipelineManagerpublic java.lang.String getOrderApprovedChainId()
public void setOrderApprovedChainId(java.lang.String pOrderApprovedChainId)
pOrderApprovedChainId
- the value to set for property orderApprovedChainIdpublic java.lang.String getOrderRejectedChainId()
public void setOrderRejectedChainId(java.lang.String pOrderRejectedChainId)
pOrderRejectedChainId
- the value to set for property orderRejectedChainIdpublic boolean isUseRequestLocale()
public void setUseRequestLocale(boolean pUseRequestLocale)
pUseRequestLocale
- public OrderManager getOrderManager()
public void setOrderManager(OrderManager pOrderManager)
pOrderManager
- public OrderStates getOrderStates()
public void setOrderStates(OrderStates pOrderStates)
pOrderStates
- public java.lang.String getApproveOrderSuccessURL()
public void setApproveOrderSuccessURL(java.lang.String pApproveOrderSuccessURL)
pApproveOrderSuccessURL
- public java.lang.String getApproveOrderErrorURL()
public void setApproveOrderErrorURL(java.lang.String pApproveOrderErrorURL)
pApproveOrderErrorURL
- public java.lang.String getRejectOrderSuccessURL()
public void setRejectOrderSuccessURL(java.lang.String pRejectOrderSuccessURL)
pRejectOrderSuccessURL
- public java.lang.String getRejectOrderErrorURL()
public void setRejectOrderErrorURL(java.lang.String pRejectOrderErrorURL)
pRejectOrderErrorURL
- public java.lang.String getApprovedOrderState()
public void setApprovedOrderState(java.lang.String pApprovedOrderState)
pApprovedOrderState
- public java.lang.String getRejectedOrderState()
public void setRejectedOrderState(java.lang.String pRejectedOrderState)
pRejectedOrderState
- public javax.transaction.TransactionManager getTransactionManager()
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
pTransactionManager
- public MutableRepository getOrderRepository()
public void setOrderRepository(MutableRepository pOrderRepository)
pOrderRepository
- the value to set for property orderRepositorypublic java.lang.String getOrderId()
public void setOrderId(java.lang.String pOrderId)
pOrderId
- public java.lang.String getApproverMessage()
public void setApproverMessage(java.lang.String pApproverMessage)
pApproverMessage
- the value to set for property approverMessagepublic void preApproveOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public void postApproveOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public void approveOrder(Order pOrder, RepositoryItem pProfile, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
pOrder
- The order to approve.pProfile
- The owner of the order.pRequest
- pResponse
- java.io.IOException
javax.servlet.ServletException
public boolean handleApproveOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public void preRejectOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public void postRejectOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public void rejectOrder(Order pOrder, RepositoryItem pProfile, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
pOrder
- The order to reject.pProfile
- The owner of the order.pRequest
- pResponse
- java.io.IOException
javax.servlet.ServletException
public boolean handleRejectOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected Order getOrder() throws CommerceException
CommerceException
protected Order loadOrder(java.lang.String pOrderId) throws CommerceException
CommerceException
protected void updateOrder(Order pOrder) throws CommerceException
CommerceException
public void processException(java.lang.Exception pException, java.lang.String pMsgId, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public java.util.Locale getUserLocale(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
locale
. This value can be
either a java.util.Locale object or a String which represents the locale.
Next if the useRequestLocale
property is true, then the
locale of the request will be returned. Finally, if the locale
cannot be determined,
the the defaultLocale
property is used.javax.servlet.ServletException
java.io.IOException
public void handlePipelineError(java.lang.Object pError, java.lang.String pErrorKey)
handlePipelineError
in interface atg.commerce.util.PipelineErrorHandler
pError
- the error reported by the pipeline.pErrorKey
- the key of the error, used for localization.protected boolean processPipelineErrors(PipelineResult pResult)
pResult
- a PipelineResult
value