atg.commerce.order
Class StateDetailDroplet

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.order.StateDetailDroplet

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class StateDetailDroplet
extends DynamoServlet

This droplet is used to format a state of an order or its comonent in a humanly readable way.

Example:

Usage:

states

List of all possible states that might occur. This is different for each order component: PaymentGroup, ShippingGroup, etc. Should be set in the properties file

state

A number, representing a state

output

This parameter is serviced if the instance of this class is used as a droplet

detailedState

Available from within the output parameter, this is the state explanatin displayed

Field Summary

static java.lang.String	CLASS_VERSION
static ParameterName	ERROR
static ParameterName	OUTPUT
static ParameterName	STATE

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

StateDetailDroplet()

Method Summary

ObjectStates	getStates() Returns the universe of states in question
boolean	isUseResourcedStateDescriptions() If this is true, then the state descriptions are pulled from a resource file
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Takes the formatted currency String and sets a request parameter named detailedState, then services the output parameter.
void	setStates(ObjectStates pStates) Sets the universe of states in question
void	setUseResourcedStateDescriptions(boolean pUseResourcedStateDescriptions)

Methods inherited from class atg.servlet.DynamoServlet

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

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, init, 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, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

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

STATE

public static final ParameterName STATE

OUTPUT

public static final ParameterName OUTPUT

ERROR

public static final ParameterName ERROR

Constructor Detail

StateDetailDroplet

public StateDetailDroplet()

Method Detail

setStates

public void setStates(ObjectStates pStates)

Sets the universe of states in question

getStates

public ObjectStates getStates()

Returns the universe of states in question

setUseResourcedStateDescriptions

public void setUseResourcedStateDescriptions(boolean pUseResourcedStateDescriptions)

isUseResourcedStateDescriptions

public boolean isUseResourcedStateDescriptions()

If this is true, then the state descriptions are pulled from a resource file

See Also:

ObjectStates

service

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

Takes the formatted currency String and sets a request parameter named detailedState, then services the output parameter.

Overrides:

service in class DynamoServlet

Parameters:

DynamoHttpServletRequest -

DynamoHttpServletResponse -

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.