atg.commerce.csr.approvals.order

Class OrderApprovalsHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.csr.approvals.GenericApprovalsHandler

atg.commerce.csr.approvals.AgentApprovalsHandler

atg.commerce.csr.approvals.order.OrderApprovalsHandler

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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 OrderApprovalsHandler
extends atg.commerce.csr.approvals.AgentApprovalsHandler

Order Approvals Handler. This handler is responsible for dealing with approvals relating to orders. It is called from the Approvals Manager to determine if an approval is required for an order, to save and load the approval's order specific information from the ApprovalRepository, and also to perform order specific operations during the approval and rejection process.

Field Summary

Fields

Modifier and Type	Field and Description
static double	APPROVAL_NOT_REQUIRED Approval not required constant
static java.lang.String	ATTRIBUTE_ORDER the attribute name used to store the Order in the Approval object's attributes.
static java.lang.String	CLASS_VERSION
protected OrderApprovalTools	mOrderApprovalTools

Fields inherited from class atg.commerce.csr.approvals.AgentApprovalsHandler

ATTRIBUTE_APPEASEMENT, ATTRIBUTE_APPROVER_LOCALE, ATTRIBUTE_CUSTOMER_EMAIL, ATTRIBUTE_ORDER_TOTAL, ATTRIBUTE_TOTAL_APPEASEMENTS, mApprovalAcceptedEventType, mApprovalCreatedEventType, mApprovalRejectedEventType, mAuthority, mCSRAgentTools, mOrderApproverAccessRight, mOrderManager, mPaymentManager, mSecurityDomain, mTransactionManager

Fields inherited from class atg.commerce.csr.approvals.GenericApprovalsHandler

mApprovalAcceptedJMSType, mApprovalCreatedJMSType, mApprovalItemDescriptorName, mApprovalRejectedJMSType, mCSRAgentMessagingTools

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

Constructors

Constructor and Description
OrderApprovalsHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	approve(Approval pApproval) processes the order supplied as an attribute on the pApproval
protected void	doPaymentGroupAuthorizations(atg.commerce.order.Order pOrder, Approval pApproval, atg.repository.MutableRepositoryItem pItem) This method is called when saving the approval and executes the initial payment group authorization for payment groups that have no authorization status yet.
protected java.util.Map	generateOrderApprovalParameters(Approval pApproval) Generates the extra parameter map that is passed to processOrder when approving an Order.
atg.commerce.csr.events.ApprovalEvent	getApprovalAcceptedEvent(Approval pApproval) creates and populates an OrderApprovalEvent
atg.commerce.csr.events.ApprovalEvent	getApprovalCreatedEvent(Approval pApproval) creates and populates an OrderApprovalEvent
atg.commerce.csr.events.ApprovalEvent	getApprovalRejectedEvent(Approval pApproval) creates and populates an OrderApprovalEvent
OrderApprovalTools	getOrderApprovalTools() Returns a reference to the OrderApprovalTools component that provides order approval helper methods and property definitions.
void	loadApproval(Approval pApproval) Loads the order associated with the approval and also the order specific properties for the approval
void	reject(Approval pApproval) Executes the process of rejecting an order that is pending approval.
void	saveApproval(Approval pApproval, atg.repository.MutableRepositoryItem pItem) This method saves the application specific data for an Order approval.
void	setOrderApprovalTools(OrderApprovalTools pOrderApprovalTools) Sets a reference to the OrderApprovalTools component that provides order approval helper methods and property definitions.
protected void	setOrderStateToPendingApproval(atg.commerce.order.Order pOrder, Approval pApproval) This method is called when saving the approval and sets the Order to the appropriate pending approval state.
protected void	setOrderStateToRejected(atg.commerce.order.Order pOrder, Approval pApproval) This method is called when an approval is rejected to set the order's state.

Methods inherited from class atg.commerce.csr.approvals.AgentApprovalsHandler

doesAgentHaveAppeasmentLimit, doesAgentRequireApproval, doesAppeasementsExceedLimit, getAgentAppeasementLimit, getApprovalAcceptedEventType, getApprovalCreatedEventType, getApprovalRejectedEventType, getCSRAgentTools, getOrderApproverAccessRight, getOrderManager, getPaymentManager, getSecurityDomain, getTotalAppeasementsForOrder, getTransactionManager, getUserAuthority, isApprovalRequired, setApprovalAcceptedEventType, setApprovalCreatedEventType, setApprovalRejectedEventType, setCSRAgentTools, setOrderApproverAccessRight, setOrderManager, setPaymentManager, setSecurityDomain, setTransactionManager, setUserAuthority

Methods inherited from class atg.commerce.csr.approvals.GenericApprovalsHandler

getApprovalAcceptedJMSType, getApprovalCreatedJMSType, getApprovalItemDescriptorName, getApprovalRejectedJMSType, getCSRAgentMessagingTools, setApprovalAcceptedJMSType, setApprovalCreatedJMSType, setApprovalItemDescriptorName, setApprovalRejectedJMSType, setCSRAgentMessagingTools

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 final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

APPROVAL_NOT_REQUIRED

public static final double APPROVAL_NOT_REQUIRED

Approval not required constant

See Also:

Constant Field Values

ATTRIBUTE_ORDER

public static final java.lang.String ATTRIBUTE_ORDER

the attribute name used to store the Order in the Approval object's attributes.

See Also:

Constant Field Values

mOrderApprovalTools

protected OrderApprovalTools mOrderApprovalTools

Constructor Detail

OrderApprovalsHandler

public OrderApprovalsHandler()

Method Detail

saveApproval

public void saveApproval(Approval pApproval,
                atg.repository.MutableRepositoryItem pItem)
                  throws ApprovalsException

This method saves the application specific data for an Order approval.

It sets the orderId property of the approval item and updates the Order to the appropriate pending approval state; adds the Order to the repository, if transient and performs the initial authorizations on the Order's payment groups.

Overrides:

saveApproval in class atg.commerce.csr.approvals.AgentApprovalsHandler

Parameters:

pApproval - the Approval to save

pApproval - the Approval object being saved

pItem - the associated approval repository item

pApproval - the Approval to save

Throws:

ApprovalsException

See Also:

setOrderStateToPendingApproval(Order, Approval), doPaymentGroupAuthorizations(Order, Approval, MutableRepositoryItem)

setOrderStateToPendingApproval

protected void setOrderStateToPendingApproval(atg.commerce.order.Order pOrder,
                                  Approval pApproval)
                                       throws ApprovalsException

This method is called when saving the approval and sets the Order to the appropriate pending approval state.

Parameters:

pOrder -

pApproval -

Throws:

ApprovalsException

setOrderStateToRejected

protected void setOrderStateToRejected(atg.commerce.order.Order pOrder,
                           Approval pApproval)
                                throws ApprovalsException

This method is called when an approval is rejected to set the order's state.

Parameters:

pOrder -

pApproval -

Throws:

ApprovalsException

doPaymentGroupAuthorizations

protected void doPaymentGroupAuthorizations(atg.commerce.order.Order pOrder,
                                Approval pApproval,
                                atg.repository.MutableRepositoryItem pItem)
                                     throws ApprovalsException

This method is called when saving the approval and executes the initial payment group authorization for payment groups that have no authorization status yet.

This method is intended to handle initial authorizations when the Order is first submitted and requires approval. Authorizations done on subsequent attempts to submit the same Order that still needs approval are handled in the clone edit reconciliation process.

Overrides:

doPaymentGroupAuthorizations in class atg.commerce.csr.approvals.AgentApprovalsHandler

Parameters:

pOrder - the Order

pApproval - the current approval objects

pItem - the approval repository item

Throws:

ApprovalsException

loadApproval

public void loadApproval(Approval pApproval)
                  throws ApprovalsException

Loads the order associated with the approval and also the order specific properties for the approval

Overrides:

loadApproval in class atg.commerce.csr.approvals.AgentApprovalsHandler

Parameters:

pApproval -

Throws:

ApprovalsException

approve

public void approve(Approval pApproval)
             throws ApprovalsException

processes the order supplied as an attribute on the pApproval

Overrides:

approve in class atg.commerce.csr.approvals.AgentApprovalsHandler

Parameters:

pApproval - - the approval to approve

Throws:

ApprovalsException

generateOrderApprovalParameters

protected java.util.Map generateOrderApprovalParameters(Approval pApproval)
                                                 throws ApprovalsException

Generates the extra parameter map that is passed to processOrder when approving an Order.

Parameters:

pApproval -

Returns:

Map of extra parameters

Throws:

ApprovalsException

reject

public void reject(Approval pApproval)
            throws ApprovalsException

Executes the process of rejecting an order that is pending approval.

The payment group authorizations are reverted and the order's state is changed to a failed approval state.

Overrides:

reject in class atg.commerce.csr.approvals.AgentApprovalsHandler

Parameters:

pApproval - approval to reject

Throws:

ApprovalsException

getApprovalAcceptedEvent

public atg.commerce.csr.events.ApprovalEvent getApprovalAcceptedEvent(Approval pApproval)

creates and populates an OrderApprovalEvent

Overrides:

getApprovalAcceptedEvent in class atg.commerce.csr.approvals.AgentApprovalsHandler

Parameters:

pApproval - - the approval

Returns:

ApprovalEvent of type OrderApprovalEvent, pre-populated with data from the Approval object

getOrderApprovalTools

public OrderApprovalTools getOrderApprovalTools()

Returns a reference to the OrderApprovalTools component that provides order approval helper methods and property definitions.

Overrides:

getOrderApprovalTools in class atg.commerce.csr.approvals.AgentApprovalsHandler

setOrderApprovalTools

public void setOrderApprovalTools(OrderApprovalTools pOrderApprovalTools)

Sets a reference to the OrderApprovalTools component that provides order approval helper methods and property definitions.

Overrides:

setOrderApprovalTools in class atg.commerce.csr.approvals.AgentApprovalsHandler

getApprovalCreatedEvent

public atg.commerce.csr.events.ApprovalEvent getApprovalCreatedEvent(Approval pApproval)

creates and populates an OrderApprovalEvent

Overrides:

getApprovalCreatedEvent in class atg.commerce.csr.approvals.AgentApprovalsHandler

Parameters:

pApproval - - the approval

Returns:

ApprovalEvent of type OrderApprovalEvent, pre-populated with data from the Approval object

getApprovalRejectedEvent

public atg.commerce.csr.events.ApprovalEvent getApprovalRejectedEvent(Approval pApproval)

creates and populates an OrderApprovalEvent

Overrides:

getApprovalRejectedEvent in class atg.commerce.csr.approvals.AgentApprovalsHandler

Parameters:

pApproval - - the approval

Returns:

ApprovalEvent of type OrderApprovalEvent, pre-populated with data from the Approval object