|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.droplet.EmptyFormHandler atg.droplet.GenericFormHandler atg.b2bcommerce.approval.ApprovalFormHandler
public class ApprovalFormHandler
This form handler is used in response to a request for an order approval. The handleApproveOrder method is called when an order should be approved and handleRejectOrder when an order is rejected for approval. The orderId property should be set to the order id which is to be approved or rejected. The approverMessage property is an optional property which can contain a message which will be added to the order when either of the two handle methods are called.
Field Summary | |
---|---|
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
|
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 | |
---|---|
ApprovalFormHandler()
Creates a new ApprovalFormHandler instance. |
Method Summary | |
---|---|
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 |
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)
|
boolean |
handleRejectOrder(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
|
boolean |
isUseRequestLocale()
Return the useRequestLocale property. |
protected B2BOrder |
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 pReqeust,
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 |
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)
|
Methods inherited from class atg.droplet.EmptyFormHandler |
---|
afterGet, beforeGet |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 |
---|
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
Constructor Detail |
---|
public ApprovalFormHandler()
ApprovalFormHandler
instance.
Method Detail |
---|
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 boolean handleApproveOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public void preRejectOrder(DynamoHttpServletRequest pReqeust, 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 boolean handleRejectOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected B2BOrder 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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |