atg.commerce.payment.processor
Class ProcProcessInvoiceRequest

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.commerce.payment.processor.ProcProcessPaymentGroup
              atg.commerce.payment.processor.ProcProcessInvoiceRequest

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

Direct Known Subclasses:

ProcProcessInvoiceRequest

public class ProcProcessInvoiceRequest
extends ProcProcessPaymentGroup

This pipeline processor element is called to authorize, debit, and credit InvoiceRequest payment groups. It calls through to an InvoiceRequestProcessor object to perform these operations.

See Also:

InvoiceRequestProcessor

Field Summary

static java.lang.String

CLASS_VERSION

Fields inherited from class atg.commerce.payment.processor.ProcProcessPaymentGroup

SUCCESS

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

ProcProcessInvoiceRequest()

Method Summary

PaymentStatus	authorizePaymentGroup(PaymentManagerPipelineArgs pParams) Authorize billing against an InvoiceRequest payment group.
PaymentStatus	creditPaymentGroup(PaymentManagerPipelineArgs pParams) Credit an InvoiceRequest payment group.
PaymentStatus	debitPaymentGroup(PaymentManagerPipelineArgs pParams) Debit an InvoiceRequest payment group.
InvoiceRequestProcessor	getInvoiceRequestProcessor() Get the invoice request processor that will actually be used to authorize, debit, and credit invoice request payment groups.
void	setInvoiceRequestProcessor(InvoiceRequestProcessor pInvoiceRequestProcessor) Set the invoice request processor that will actually be used to authorize, debit, and credit invoice request payment groups.

Methods inherited from class atg.commerce.payment.processor.ProcProcessPaymentGroup

decreaseAuthorizationForPaymentGroup, getRetCodes, invokeProcessorAction, runProcess

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

Constructor Detail

ProcProcessInvoiceRequest

public ProcProcessInvoiceRequest()

Method Detail

setInvoiceRequestProcessor

public void setInvoiceRequestProcessor(InvoiceRequestProcessor pInvoiceRequestProcessor)

Set the invoice request processor that will actually be used to authorize, debit, and credit invoice request payment groups.

getInvoiceRequestProcessor

public InvoiceRequestProcessor getInvoiceRequestProcessor()

Get the invoice request processor that will actually be used to authorize, debit, and credit invoice request payment groups.

authorizePaymentGroup

public PaymentStatus authorizePaymentGroup(PaymentManagerPipelineArgs pParams)
                                    throws CommerceException

Authorize billing against an InvoiceRequest payment group. This method simply calls through to the invoiceRequestProcessor authorize method.

Specified by:

authorizePaymentGroup in class ProcProcessPaymentGroup

Parameters:

pParams - The argument dictionary passed to this pipeline processor.

Returns:

The PaymentStatus object returned by the invoiceRequestProcessor authorize method.

Throws:

CommerceException - If there is any error authorizing the payment group.

debitPaymentGroup

public PaymentStatus debitPaymentGroup(PaymentManagerPipelineArgs pParams)
                                throws CommerceException

Debit an InvoiceRequest payment group. This method simply calls through to the invoiceRequestProcessor debit method.

Specified by:

debitPaymentGroup in class ProcProcessPaymentGroup

Parameters:

pParams - The argument dictionary passed to this pipeline processor.

Returns:

The PaymentStatus object returned by the invoiceRequestProcessor debit method.

Throws:

CommerceException - If there is any error debiting the payment group.

creditPaymentGroup

public PaymentStatus creditPaymentGroup(PaymentManagerPipelineArgs pParams)
                                 throws CommerceException

Credit an InvoiceRequest payment group. This method simply calls through to the invoiceRequestProcessor credit method.

Specified by:

creditPaymentGroup in class ProcProcessPaymentGroup

Parameters:

pParams - The argument dictionary passed to this pipeline processor.

Returns:

The PaymentStatus object returned by the invoiceRequestProcessor credit method.

Throws:

CommerceException - If there is any error crediting the payment group.