atg.commerce.csr.order.appeasement

Class OrderIsAppeasableDroplet

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.nucleus.TimedOperationService

atg.nucleus.servlet.ServletService

atg.nucleus.servlet.HttpServletService

atg.servlet.DynamoServlet

atg.commerce.csr.order.appeasement.OrderIsAppeasableDroplet

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, atg.servlet.ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class OrderIsAppeasableDroplet
extends atg.servlet.DynamoServlet

This droplet checks whether an order is appeasable.

input params

orderId

(required)the orderId of the order to determine is appeasable.

oparams

true

if the order is appeasable

false

if the order is not appeasable

error

If an processing problem occurs. Further details in the errorMsg parameter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static atg.nucleus.naming.ParameterName	ERROR oparam rendered once with the result
static java.lang.String	ERROR_MESSAGE The following is the parameter available in error oparam
static atg.nucleus.naming.ParameterName	FALSE
protected atg.commerce.csr.order.appeasement.AppeasementManager	mAppeasementManager
protected CSRAgentTools	mCSRAgentTools
static atg.nucleus.naming.ParameterName	ORDER_ID
protected static java.util.ResourceBundle	sResourceBundle
static atg.nucleus.naming.ParameterName	TRUE oparam rendered once with the result

Fields inherited from class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

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

Method Summary

Modifier and Type	Method and Description
atg.commerce.csr.order.appeasement.AppeasementManager	getAppeasementManager() Returns the AppeasementManager object
CSRAgentTools	getCSRAgentTools()
boolean	orderIsAppeasable(atg.commerce.order.Order pOrder) Given an order, this method determines whether the order appeasable.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Returns the boolean value true if there is any appeasement in PENDING status for the selected order, and false otherwise
void	setAppeasementManager(atg.commerce.csr.order.appeasement.AppeasementManager pAppeasementManager) Sets the AppeasementManager object
void	setCSRAgentTools(CSRAgentTools pCSRAgentTools) Sets the property CSRAgentTools.

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, clearAbsoluteNameAndContext, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, isStartServiceComplete, 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 java.lang.String CLASS_VERSION

Class version string

sResourceBundle

protected static java.util.ResourceBundle sResourceBundle

ORDER_ID

public static final atg.nucleus.naming.ParameterName ORDER_ID

TRUE

public static final atg.nucleus.naming.ParameterName TRUE

oparam rendered once with the result

FALSE

public static final atg.nucleus.naming.ParameterName FALSE

ERROR

public static final atg.nucleus.naming.ParameterName ERROR

oparam rendered once with the result

ERROR_MESSAGE

public static final java.lang.String ERROR_MESSAGE

The following is the parameter available in error oparam

See Also:

Constant Field Values

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

mAppeasementManager

protected atg.commerce.csr.order.appeasement.AppeasementManager mAppeasementManager

Constructor Detail

OrderIsAppeasableDroplet

public OrderIsAppeasableDroplet()

Method Detail

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)

Sets the property CSRAgentTools.

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Returns:

The CSRAgentTools component used to manipulate the profile

setAppeasementManager

public void setAppeasementManager(atg.commerce.csr.order.appeasement.AppeasementManager pAppeasementManager)

Sets the AppeasementManager object

Parameters:

pAppeasementManager - the AppeasementManager object

getAppeasementManager

public atg.commerce.csr.order.appeasement.AppeasementManager getAppeasementManager()

Returns the AppeasementManager object

Returns:

the AppeasementManager object

service

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

Returns the boolean value true if there is any appeasement in PENDING status for the selected order, and false otherwise

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - the request to be processed

pResponse - the response object for this request

Throws:

javax.servlet.ServletException - for an application specific error occurred processing this request

java.io.IOException - for an error occurred reading data from the request or writing data to the response.

orderIsAppeasable

public boolean orderIsAppeasable(atg.commerce.order.Order pOrder)
                          throws atg.commerce.CommerceException

Given an order, this method determines whether the order appeasable.

Any order that is not a B2B order and has been fulfilled is appeasable.

Parameters:

pOrder - the order

Returns:

whether the order is appeasable

Throws:

atg.commerce.CommerceException - if the processing fails.