atg.commerce.csr.util
Class StateDescription

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.util.StateDescription

All Implemented Interfaces:

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

The StateDescription will translate an object state value into it's description.

state

The state value to describe

objectStates

The object state component to utilize. This can be set in a property file

elementName

The optional parameter that should be used for the name of the description value which is bound into the scope of the output oparam

 <DROPLET bean="StateDescription">
   <PARAM NAME="objectStates" value="bean:/atg/commerce/custsvc/returns/ReturnedItemStates">
   <PARAM NAME="state"        VALUE="RETURNED">
   <PARAM NAME="elementName"  VALUE="stateDescription">
   <OPARAM NAME="output"><valueof param="stateDescription">N/A</valueof></OPARAM>
   <OPARAM NAME="error">Error</OPARAM>
   <OPARAM NAME="unset">Unset</OPARAM>
 </DROPLET>
 

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static atg.nucleus.naming.ParameterName	ELEMENT_NAME the parameter that provides the value that will contain the description
static atg.nucleus.naming.ParameterName	ERROR the oparam that is rendered if an error is encountered
static atg.nucleus.naming.ParameterName	OBJECT_STATES the parameter that provides the object states component
static atg.nucleus.naming.ParameterName	OUTPUT the oparam that is rendered if a translated value is found
static atg.nucleus.naming.ParameterName	STATE the parameter that provides the state to describe
static atg.nucleus.naming.ParameterName	UNSET the oparam that is rendered if the object states are not set

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

StateDescription()

Method Summary

atg.commerce.states.ObjectStates	getObjectStates()
boolean	isUseResourcedStateDescriptions() If this is true, then the state descriptions are pulled from a resource file
void	service(atg.servlet.DynamoHttpServletRequest pReq, atg.servlet.DynamoHttpServletResponse pRes) Render the StateDescription
void	setObjectStates(atg.commerce.states.ObjectStates pObjectStates) Sets the object states
void	setUseResourcedStateDescriptions(boolean pUseResourcedStateDescriptions) Sets boolean indicating if the state descriptions should be pulled from a resource file

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

STATE

public static final atg.nucleus.naming.ParameterName STATE

the parameter that provides the state to describe

OBJECT_STATES

public static final atg.nucleus.naming.ParameterName OBJECT_STATES

the parameter that provides the object states component

ELEMENT_NAME

public static final atg.nucleus.naming.ParameterName ELEMENT_NAME

the parameter that provides the value that will contain the description

OUTPUT

public static final atg.nucleus.naming.ParameterName OUTPUT

the oparam that is rendered if a translated value is found

UNSET

public static final atg.nucleus.naming.ParameterName UNSET

the oparam that is rendered if the object states are not set

ERROR

public static final atg.nucleus.naming.ParameterName ERROR

the oparam that is rendered if an error is encountered

Constructor Detail

StateDescription

public StateDescription()

Method Detail

setObjectStates

public void setObjectStates(atg.commerce.states.ObjectStates pObjectStates)

Sets the object states

Parameters:

pObjectStates - the object states

getObjectStates

public atg.commerce.states.ObjectStates getObjectStates()

Returns:

the object states

setUseResourcedStateDescriptions

public void setUseResourcedStateDescriptions(boolean pUseResourcedStateDescriptions)

Sets boolean indicating if the state descriptions should be pulled from a resource file

Parameters:

pUseResourcedStateDescriptions - boolean indicating if the state descriptions should be pulled from a resource file

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(atg.servlet.DynamoHttpServletRequest pReq,
                    atg.servlet.DynamoHttpServletResponse pRes)
             throws javax.servlet.ServletException,
                    java.io.IOException

Render the StateDescription

Overrides:

service in class atg.servlet.DynamoServlet

Throws:

javax.servlet.ServletException

java.io.IOException