atg.commerce.csr.order.appeasement

Class GetOrderAppeasementsDroplet

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.GetOrderAppeasementsDroplet

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 GetOrderAppeasementsDroplet
extends atg.servlet.DynamoServlet

This droplet provides the appeasements for a given order.

If the order is a replacementOrder then the appeasements for the from the replaced order are also returned. input params

orderId

(required) the orderId for which the appeasements are returned.

restrictToOrder

(optional) if true, only return appeasements that are directly linked to current order. Defaults to false.

state

(optional) The state of the appeasements to search on. If not specified then all appeasements are returned.

oparams

output

rendered once if there are appeasements

empty

rendered once if there are no appeasements

output params

appeasements

An array of appeasements

See Also:

AppeasementTools.generateSortedAppeasements(String, boolean)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPEASEMENTS The following are the parameters available in output oparam
static atg.nucleus.naming.ParameterName	EMPTY oparam rendered once when there are no related return requests
protected atg.commerce.csr.order.appeasement.CSRAppeasementTools	mCSRAppeasementTools
static atg.nucleus.naming.ParameterName	ORDER_ID
static atg.nucleus.naming.ParameterName	OUTPUT oparam rendered once with the related return requests
static atg.nucleus.naming.ParameterName	RESTRICT
static atg.nucleus.naming.ParameterName	STATE

Fields inherited from class atg.servlet.DynamoServlet

CLASS_VERSION, 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
GetOrderAppeasementsDroplet()

Method Summary

Modifier and Type	Method and Description
atg.commerce.csr.order.appeasement.CSRAppeasementTools	getCSRAppeasementTools() Returns the appeasement tools used to get the related appeasements
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Where all the droplet action occurs.
void	setCSRAppeasementTools(atg.commerce.csr.order.appeasement.CSRAppeasementTools pCSRAppeasementTools) Sets the appeasement tools.

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

ORDER_ID

public static final atg.nucleus.naming.ParameterName ORDER_ID

RESTRICT

public static final atg.nucleus.naming.ParameterName RESTRICT

STATE

public static final atg.nucleus.naming.ParameterName STATE

OUTPUT

public static final atg.nucleus.naming.ParameterName OUTPUT

oparam rendered once with the related return requests

EMPTY

public static final atg.nucleus.naming.ParameterName EMPTY

oparam rendered once when there are no related return requests

APPEASEMENTS

public static final java.lang.String APPEASEMENTS

The following are the parameters available in output oparam

See Also:

Constant Field Values

mCSRAppeasementTools

protected atg.commerce.csr.order.appeasement.CSRAppeasementTools mCSRAppeasementTools

Constructor Detail

GetOrderAppeasementsDroplet

public GetOrderAppeasementsDroplet()

Method Detail

getCSRAppeasementTools

public atg.commerce.csr.order.appeasement.CSRAppeasementTools getCSRAppeasementTools()

Returns the appeasement tools used to get the related appeasements

Returns:

The CSRAppeasementTools

setCSRAppeasementTools

public void setCSRAppeasementTools(atg.commerce.csr.order.appeasement.CSRAppeasementTools pCSRAppeasementTools)

Sets the appeasement tools.

Parameters:

pCSRAppeasementTools - The appeasements tools component.

service

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

Where all the droplet action occurs.

This droplet returns an ordered list of appeasements

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - The request object.

pResponse - The response object

Throws:

javax.servlet.ServletException - If a error during processing

java.io.IOException - If a IO error occurs during processing