atg.commerce.csr.returns

Class ReturnDroplet

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.returns.ReturnDroplet

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class ReturnDroplet
extends DynamoServlet

This droplet returns the returns & exchanges associated with a given order.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
static ParameterName	ERROR The oparam name rendered for a failed completion
static java.lang.String	ITEMRETURNEDSUMMARY The output parameter name used for returning the item return summary Map, which maps commerce items to returned quantity.
static java.lang.String	MY_RESOURCE_NAME
static ParameterName	ORDER_ID The input parametere used for specifying the id of the order.
static ParameterName	OUTPUT The oparam name rendered for a successful completion
static java.lang.String	RESULT The output parameter name used for returning the results
static ParameterName	RESULT_NAME The input parametere used for specifying the desired name of the result output parameter.
static ParameterName	SEARCH_BY_REPLACEMENT_ID If true, the droplet will search for all related orders one step in either direction, that is: 1) Replacement orders that have orderId as the original order 2) Original orders that have orderId as the replacement order By default, only replacement orders with specified original orderId are returned.

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

Method Summary

Modifier and Type	Method and Description
ReturnTools	getReturnTools() Returns the return tools
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Return the returns & exchanges associated with the given order
void	setReturnTools(ReturnTools pReturnTools) sets the return 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, 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 java.lang.String CLASS_VERSION

MY_RESOURCE_NAME

public static java.lang.String MY_RESOURCE_NAME

ORDER_ID

public static final ParameterName ORDER_ID

The input parametere used for specifying the id of the order.

RESULT_NAME

public static final ParameterName RESULT_NAME

The input parametere used for specifying the desired name of the result output parameter.

SEARCH_BY_REPLACEMENT_ID

public static final ParameterName SEARCH_BY_REPLACEMENT_ID

If true, the droplet will search for all related orders one step in either direction, that is: 1) Replacement orders that have orderId as the original order 2) Original orders that have orderId as the replacement order By default, only replacement orders with specified original orderId are returned.

OUTPUT

public static final ParameterName OUTPUT

The oparam name rendered for a successful completion

ERROR

public static final ParameterName ERROR

The oparam name rendered for a failed completion

RESULT

public static final java.lang.String RESULT

The output parameter name used for returning the results

See Also:

Constant Field Values

ITEMRETURNEDSUMMARY

public static final java.lang.String ITEMRETURNEDSUMMARY

The output parameter name used for returning the item return summary Map, which maps commerce items to returned quantity.

See Also:

Constant Field Values

Constructor Detail

ReturnDroplet

public ReturnDroplet()

Method Detail

setReturnTools

public void setReturnTools(ReturnTools pReturnTools)

sets the return tools

Parameters:

pReturnTools - the return tools

getReturnTools

public ReturnTools getReturnTools()

Returns the return tools

service

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

Return the returns & exchanges associated with the given order

Overrides:

service in class DynamoServlet

Parameters:

pRequest - the HTTP request

pResponse - the HTTP response

Throws:

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

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