atg.commerce.states
Class StateDescriptionDroplet

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.states.StateDescriptionDroplet

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

Direct Known Subclasses:

StateDetailDroplet

public class StateDescriptionDroplet
extends DynamoServlet

This droplet is used to translate a raw state value in its readable format.

Example:

Usage:

states

This property configuration references the ObjectStates component containing the state definitions.

useResourcedStateDescriptions

If this property configuration is set to true, the translated state will be localized using the current request locale.

state

The raw integer or string state value to translate. These values are defined by the ObjectStates component

output

This oparameter is used to render the translated state value

error

This oarameter is rendered when an error occurs.

detailedState

This output parameter contains the translated state value

Field Summary

static java.lang.String	CLASS_VERSION
static ParameterName	ELEMENT_NAME the parameter that provides the value that will contain the description
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

StateDescriptionDroplet()

Method Summary

ObjectStates	getStates() Gets the ObjectStates that contains the raw and translated state values.
boolean	isUseResourcedStateDescriptions() If this is true, then the state descriptions will be localized based on the current request locale
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Takes the provided raw state value and renderes it in its readable form.
void	setStates(ObjectStates pStates) Sets the ObjectStates that contains the raw and translated state values.
void	setUseResourcedStateDescriptions(boolean pUseResourcedStateDescriptions)

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

STATE

public static final ParameterName STATE

OUTPUT

public static final ParameterName OUTPUT

ERROR

public static final ParameterName ERROR

ELEMENT_NAME

public static final ParameterName ELEMENT_NAME

the parameter that provides the value that will contain the description

Constructor Detail

StateDescriptionDroplet

public StateDescriptionDroplet()

Method Detail

setStates

public void setStates(ObjectStates pStates)

Sets the ObjectStates that contains the raw and translated state values.

getStates

public ObjectStates getStates()

Gets the ObjectStates that contains the raw and translated state values.

setUseResourcedStateDescriptions

public void setUseResourcedStateDescriptions(boolean pUseResourcedStateDescriptions)

isUseResourcedStateDescriptions

public boolean isUseResourcedStateDescriptions()

If this is true, then the state descriptions will be localized based on the current request locale

service

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

Takes the provided raw state value and renderes it in its readable form.

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.