atg.commerce.csr.approvals
Class GetTotalApprovalsForStateDroplet

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.approvals.GetTotalApprovalsForStateDroplet

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, 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 GetTotalApprovalsForStateDroplet
extends atg.servlet.DynamoServlet

This droplet will query the approvals repository and return the total number of results for a given type

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected ApprovalsManager	mApprovalsManager
protected java.lang.String	mItemDescriptor
protected java.lang.String	mRequiredState

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

GetTotalApprovalsForStateDroplet()

Method Summary

ApprovalsManager	getApprovalsManager() Returns the Approvals Manager
java.lang.String	getItemDescriptor() Returns the item descriptor for which the total is required.
java.lang.String	getRequiredState() Returns the approval state for which the total is required.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Calls into the Approvals Manager to get all the approval objects for the given type and state.
void	setApprovalsManager(ApprovalsManager pApprovalsManager) Sets the Approvals Manager.
void	setItemDescriptor(java.lang.String mItemDescriptor) Sets the item descriptor for which the total is required.
void	setRequiredState(java.lang.String pRequiredState) Sets the approval state for which the total is required.

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

mApprovalsManager

protected ApprovalsManager mApprovalsManager

mRequiredState

protected java.lang.String mRequiredState

mItemDescriptor

protected java.lang.String mItemDescriptor

Constructor Detail

GetTotalApprovalsForStateDroplet

public GetTotalApprovalsForStateDroplet()

Method Detail

setApprovalsManager

public void setApprovalsManager(ApprovalsManager pApprovalsManager)

Sets the Approvals Manager.

Parameters:

pApprovalsManager - the ApprovalsManager to set

getApprovalsManager

public ApprovalsManager getApprovalsManager()

Returns the Approvals Manager

Returns:

the mApprovalsManager

setRequiredState

public void setRequiredState(java.lang.String pRequiredState)

Sets the approval state for which the total is required.

Parameters:

pRequiredState - the RequiredState to set

getRequiredState

public java.lang.String getRequiredState()

Returns the approval state for which the total is required.

Returns:

the mRequiredState

setItemDescriptor

public void setItemDescriptor(java.lang.String mItemDescriptor)

Sets the item descriptor for which the total is required.

Parameters:

mItemDescriptor - the mItemDescriptor to set

getItemDescriptor

public java.lang.String getItemDescriptor()

Returns the item descriptor for which the total is required.

Returns:

the mItemDescriptor

service

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

Calls into the Approvals Manager to get all the approval objects for the given type and state. Renders the length of the resulting array of RepositoryItems in the output parameter.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest -

pResponse -

Throws:

ServletException, - IOException

javax.servlet.ServletException

java.io.IOException