atg.commerce.order.edit.processor
Class ProcAuthorizePaymentGroups

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.commerce.order.edit.processor.ProcAuthorizePaymentGroups

All Implemented Interfaces:

atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, PipelineProcessor, java.util.EventListener

public class ProcAuthorizePaymentGroups
extends GenericService
implements 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, 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() Returns an array of all the return codes that could be returned by this PipelineProcessor.
int	runProcess(java.lang.Object pParam, 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()

Description copied from interface: PipelineProcessor

Returns an array of all the return codes that could be returned by this PipelineProcessor.

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an array of all the return codes that could be returned by this PipelineProcessor.

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception

Applies the payment group authorization updates

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - an optional user parameter

pResult - the PipelineResult object which is used to return errors or other data

Returns:

an integer value which is mapped to the next processor to execute. STOP_CHAIN_EXECUTION will notify the PipelineManager to stop execution. An unmapped value will throw a RunProcessException.

Throws:

java.lang.Exception

See Also:

PaymentGroupEditHandler.processAuthorizations(CloneEditState)

addErrorToPipelineResult

protected void addErrorToPipelineResult(atg.commerce.order.edit.AuthorizationUpdateException pAuthorizationUpdateException,
                                        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