atg.commerce.order.edit.processor
Class ProcAuthorizePaymentGroups

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

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

Applies the payment group authorization updates for any payment groups added, updated or removed during the Order modification.


Field Summary
static java.lang.String CLASS_VERSION
           
protected  PaymentGroupEditHandler mPaymentGroupEditHandler
           
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
ProcAuthorizePaymentGroups()
           
 
Method Summary
protected  void addErrorToPipelineResult(atg.commerce.order.edit.AuthorizationUpdateException pAuthorizationUpdateException, atg.service.pipeline.PipelineResult pResult, java.util.ResourceBundle pBundle)
          Adds an error to the pipeline result based on the given auth exception
 PaymentGroupEditHandler getPaymentGroupEditHandler()
          A reference to the PaymentGroupEditHandler that will apply the auth updates.
 int[] getRetCodes()
           
 int runProcess(java.lang.Object pParam, atg.service.pipeline.PipelineResult pResult)
          Applies the payment group authorization updates
 void setPaymentGroupEditHandler(PaymentGroupEditHandler pPaymentGroupEditHandler)
           
 
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

mPaymentGroupEditHandler

protected PaymentGroupEditHandler mPaymentGroupEditHandler

mRetCodes

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

Constructor Detail

ProcAuthorizePaymentGroups

public ProcAuthorizePaymentGroups()
Method Detail

getPaymentGroupEditHandler

public PaymentGroupEditHandler getPaymentGroupEditHandler()
A reference to the PaymentGroupEditHandler that will apply the auth updates.

Returns:

setPaymentGroupEditHandler

public void setPaymentGroupEditHandler(PaymentGroupEditHandler pPaymentGroupEditHandler)

getRetCodes

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

runProcess

public int runProcess(java.lang.Object pParam,
                      atg.service.pipeline.PipelineResult pResult)
               throws java.lang.Exception
Applies the payment group authorization updates

Specified by:
runProcess in interface atg.service.pipeline.PipelineProcessor
Throws:
java.lang.Exception
See Also:
PaymentGroupEditHandler.processAuthorizations(CloneEditState)

addErrorToPipelineResult

protected void addErrorToPipelineResult(atg.commerce.order.edit.AuthorizationUpdateException pAuthorizationUpdateException,
                                        atg.service.pipeline.PipelineResult pResult,
                                        java.util.ResourceBundle pBundle)
Adds an error to the pipeline result based on the given auth exception

Parameters:
pAuthorizationUpdateException -
pResult - the pipeline result to which the error is added.
pBundle - the resource bundle for getting the message text