atg.commerce.csr.approvals.order
Class ProcRemoveOrderApproval

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.commerce.csr.approvals.order.ProcRemoveOrderApproval
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.service.pipeline.PipelineProcessor, java.util.EventListener

public class ProcRemoveOrderApproval
extends atg.nucleus.GenericService
implements atg.service.pipeline.PipelineProcessor

A processor of this type is used in the reconciliation pipeline that reconciles an Order in a pending agent approval state. Its purpose is to remove the order approval record that references the order being reconciled.


Field Summary
static java.lang.String CLASS_VERSION
           
protected  OrderApprovalTools mOrderApprovalTools
           
protected  int[] mRetCodes
          Returns the valid return codes.
 
Fields inherited from class atg.nucleus.GenericService
SERVICE_INFO_KEY
 
Fields inherited from interface atg.service.pipeline.PipelineProcessor
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK
 
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
ProcRemoveOrderApproval()
           
 
Method Summary
 OrderApprovalTools getOrderApprovalTools()
          Returns a reference to the OrderApprovalTools component that provides order approval helper methods and property definitions.
 int[] getRetCodes()
           
 int runProcess(java.lang.Object pParam, atg.service.pipeline.PipelineResult pResult)
          Removes the order approval record that references the original order in the clone edit state.
 void setOrderApprovalTools(OrderApprovalTools pOrderApprovalTools)
           
 
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 final java.lang.String CLASS_VERSION
See Also:
Constant Field Values

mOrderApprovalTools

protected OrderApprovalTools mOrderApprovalTools

mRetCodes

protected int[] mRetCodes
Returns the valid return codes. This processor always returns a status of 1 indicating successful completion.

Constructor Detail

ProcRemoveOrderApproval

public ProcRemoveOrderApproval()
Method Detail

getRetCodes

public int[] getRetCodes()
Specified by:
getRetCodes in interface atg.service.pipeline.PipelineProcessor

getOrderApprovalTools

public OrderApprovalTools getOrderApprovalTools()
Returns a reference to the OrderApprovalTools component that provides order approval helper methods and property definitions.


setOrderApprovalTools

public void setOrderApprovalTools(OrderApprovalTools pOrderApprovalTools)

runProcess

public int runProcess(java.lang.Object pParam,
                      atg.service.pipeline.PipelineResult pResult)
               throws java.lang.Exception
Removes the order approval record that references the original order in the clone edit state.

Specified by:
runProcess in interface atg.service.pipeline.PipelineProcessor
Throws:
java.lang.Exception
See Also:
OrderApprovalTools.removeApprovalForOrder(String)