public class StateDescription
extends atg.servlet.DynamoServlet
<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>
Modifier and Type | Field and Description |
---|---|
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
|
Constructor and Description |
---|
StateDescription() |
Modifier and Type | Method and Description |
---|---|
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
|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final atg.nucleus.naming.ParameterName STATE
public static final atg.nucleus.naming.ParameterName OBJECT_STATES
public static final atg.nucleus.naming.ParameterName ELEMENT_NAME
public static final atg.nucleus.naming.ParameterName OUTPUT
public static final atg.nucleus.naming.ParameterName UNSET
public static final atg.nucleus.naming.ParameterName ERROR
public void setObjectStates(atg.commerce.states.ObjectStates pObjectStates)
pObjectStates
- the object statespublic atg.commerce.states.ObjectStates getObjectStates()
public void setUseResourcedStateDescriptions(boolean pUseResourcedStateDescriptions)
pUseResourcedStateDescriptions
- boolean indicating if the state descriptions should
be pulled from a resource filepublic boolean isUseResourcedStateDescriptions()
ObjectStates
public void service(atg.servlet.DynamoHttpServletRequest pReq, atg.servlet.DynamoHttpServletResponse pRes) throws javax.servlet.ServletException, java.io.IOException
service
in class atg.servlet.DynamoServlet
javax.servlet.ServletException
java.io.IOException