atg.commerce.csr.returns
Class IsReturnable

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

All Implemented Interfaces:

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 IsReturnable
extends DynamoServlet

This droplet deteremines if a given order or commerce item is returnable.

Input params:

item

a CommerceItem object or commerce item repository item

order

a Order object or order repository item

Oparams:

true

item is returnable

false

item is not returnable output parameters:

returnableState

the raw returnable state value for the item or order

returnableDescription

the resource description for the state

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	FALSE_OPARAM the name for the false output parameter.
static ParameterName	ITEM_PARAM the input parameter name for the item parameter
protected ReturnManager	mReturnManager
static ParameterName	ORDER_PARAM the input parameter name for the item parameter
static java.lang.String	RETURNABLE_DESCRIPTION the output parameter name for the resourced returnable description parameter
static java.lang.String	RETURNABLE_STATE the output parameter name for the returnable state
static java.lang.String	TRUE_OPARAM the name for the true output parameter.

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

IsReturnable()

Method Summary

protected java.lang.String	getItemReturnableState(RepositoryItem pCommerceItem) This API is called to determine the returnable state for the given item
protected java.lang.String	getOrderReturnableState(RepositoryItem pOrder) This API is called to determine the returnable state for the given order
ReturnManager	getReturnManager() Returns the return manager object
protected boolean	isItemReturnable(RepositoryItem pItem) Called to determine if the item is returnable.
protected boolean	isOrderReturnable(RepositoryItem pOrder) called to determine if the order associated with the item is returnable
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".
void	setReturnManager(ReturnManager pReturnManager) Sets the return manager object

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

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

Class version string

ITEM_PARAM

public static final ParameterName ITEM_PARAM

the input parameter name for the item parameter

ORDER_PARAM

public static final ParameterName ORDER_PARAM

the input parameter name for the item parameter

TRUE_OPARAM

public static final java.lang.String TRUE_OPARAM

the name for the true output parameter. use to render the true oparam if item is returnable

See Also:

Constant Field Values

FALSE_OPARAM

public static final java.lang.String FALSE_OPARAM

the name for the false output parameter. use to render the false oparam if item is not returnable

See Also:

Constant Field Values

RETURNABLE_DESCRIPTION

public static final java.lang.String RETURNABLE_DESCRIPTION

the output parameter name for the resourced returnable description parameter

See Also:

Constant Field Values

RETURNABLE_STATE

public static final java.lang.String RETURNABLE_STATE

the output parameter name for the returnable state

See Also:

Constant Field Values

mReturnManager

protected ReturnManager mReturnManager

Constructor Detail

IsReturnable

public IsReturnable()

Method Detail

setReturnManager

public void setReturnManager(ReturnManager pReturnManager)

Sets the return manager object

Parameters:

pReturnManager - the return manager

getReturnManager

public ReturnManager getReturnManager()

Returns the return manager object

service

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

Description copied from class: DynamoServlet

This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".

Overrides:

service in class DynamoServlet

Parameters:

pRequest - the request to be processed

pResponse - the response object for this request

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.

See Also:

isItemReturnable(RepositoryItem), isOrderReturnable(RepositoryItem)

getOrderReturnableState

protected java.lang.String getOrderReturnableState(RepositoryItem pOrder)

This API is called to determine the returnable state for the given order

Parameters:

pOrder -

Returns:

the returnable state

See Also:

ReturnTools.getOrderReturnableState(RepositoryItem)

getItemReturnableState

protected java.lang.String getItemReturnableState(RepositoryItem pCommerceItem)

This API is called to determine the returnable state for the given item

Parameters:

pCommerceItem -

Returns:

the returnable state

See Also:

ReturnTools.getItemReturnableState(RepositoryItem)

isOrderReturnable

protected boolean isOrderReturnable(RepositoryItem pOrder)

called to determine if the order associated with the item is returnable

Parameters:

pOrder -

Returns:

See Also:

ReturnTools.isReturnable(RepositoryItem)

isItemReturnable

protected boolean isItemReturnable(RepositoryItem pItem)

Called to determine if the item is returnable.

Parameters:

pItem -

Returns:

See Also:

ReturnTools.isItemReturnable(RepositoryItem)