atg.commerce.csr.approvals.order

Class OrderApprovalTools

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.csr.approvals.AgentApprovalTools

atg.commerce.csr.approvals.order.OrderApprovalTools

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 OrderApprovalTools
extends atg.commerce.csr.approvals.AgentApprovalTools

This class provides some helper methods and defines common properties for working with order approvals

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected java.lang.String	mOrderIdPropertyName

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

APPROVAL_NOT_NEEDED, CSC_BYPASS_APPROVAL_CHECK_PARAM, mAppeasementTotalPropertyName, mApprovalItemDescriptorName, mApprovalsManager, mCSRAgentTools, mCustomerEmailPropertyName, mOrderTotalPropertyName

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
OrderApprovalTools()

Method Summary

Modifier and Type	Method and Description
java.util.Map	addBypassOrderApprovalCheckParameter(java.util.Map pExtraParameters) Adds the parameter that will cause the processOrder pipeline to skip checking for approval for the order.
Approval	createOrderApproval(atg.commerce.order.Order pOrder, atg.repository.RepositoryItem pAgentProfile, atg.repository.RepositoryItem pTicket, java.lang.String pSiteId, java.util.Map pExtraParameters) Creates an Approval object for the given Order that can be passed to the ApprovalManager to determine if approval is required.
atg.repository.RepositoryItem	findApprovalForOrder(java.lang.String pOrderId) Returns an Approval Repository Item.
java.lang.String	getOrderIdPropertyName() Returns the name of the property used to store the order id on the order approval item
void	removeApprovalForOrder(java.lang.String pOrderId) Removes the order approval item that references the given order id.
void	setOrderIdPropertyName(java.lang.String pOrderIdPropertyName)

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

getAgentAppeasementLimit, getAppeasementTotalPropertyName, getApprovalItemDescriptorName, getApprovalsManager, getCSRAgentTools, getCustomerEmailPropertyName, getOrderTotalPropertyName, setAppeasementTotalPropertyName, setApprovalItemDescriptorName, setApprovalsManager, setCSRAgentTools, setCustomerEmailPropertyName, setOrderTotalPropertyName, updateCustomerEmailOnOrderApproval

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

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

mOrderIdPropertyName

protected java.lang.String mOrderIdPropertyName

Constructor Detail

OrderApprovalTools

public OrderApprovalTools()

Method Detail

setOrderIdPropertyName

public void setOrderIdPropertyName(java.lang.String pOrderIdPropertyName)

Parameters:

pOrderIdPropertyName - the mOrderIdPropertyName to set

getOrderIdPropertyName

public java.lang.String getOrderIdPropertyName()

Returns the name of the property used to store the order id on the order approval item

findApprovalForOrder

public atg.repository.RepositoryItem findApprovalForOrder(java.lang.String pOrderId)
                                                   throws ApprovalsException

Returns an Approval Repository Item. This will be the first RepositoryItem in the result set. If more than 1 are found, an exception is thrown, and if none are found, null is returned.

Parameters:

pOrderId - The id of the order to search for an approval.

Returns:

an Approval RepositoryItem.

Throws:

ApprovalsException

removeApprovalForOrder

public void removeApprovalForOrder(java.lang.String pOrderId)
                            throws ApprovalsException

Removes the order approval item that references the given order id.

Parameters:

pOrderId - The id of the order that we are removing the approval from.

Throws:

ApprovalsException

addBypassOrderApprovalCheckParameter

public java.util.Map addBypassOrderApprovalCheckParameter(java.util.Map pExtraParameters)

Adds the parameter that will cause the processOrder pipeline to skip checking for approval for the order.

Parameters:

pExtraParameters - The map to add the approval skip check param to.

Returns:

The updated map with parameter added.

See Also:

AgentApprovalTools.CSC_BYPASS_APPROVAL_CHECK_PARAM

createOrderApproval

public Approval createOrderApproval(atg.commerce.order.Order pOrder,
                                    atg.repository.RepositoryItem pAgentProfile,
                                    atg.repository.RepositoryItem pTicket,
                                    java.lang.String pSiteId,
                                    java.util.Map pExtraParameters)
                             throws ApprovalsException

Creates an Approval object for the given Order that can be passed to the ApprovalManager to determine if approval is required.

Parameters:

pOrder - The order to create the approval for.

pAgentProfile - The profile of the agent that is creating the approval.

pTicket - The ticket related to the approval.

pSiteId - The site that the order is being processed on.

pExtraParameters - A map of parameter used during processing.

Returns:

Approval object

Throws:

ApprovalsException - If a failure in processing occurs.