atg.commerce.payment.processor
Class ProcProcessStoreCredit

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

All Implemented Interfaces:

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

public class ProcProcessStoreCredit
extends ProcProcessPaymentGroup

This pipeline processor element is called to authorize, debit, and credit StoreCredit payment groups. It calls through to a StoreCreditProcessor object to perform these operations.

See Also:

StoreCreditProcessor

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

ProcProcessStoreCredit()

Method Summary

PaymentStatus	authorizePaymentGroup(PaymentManagerPipelineArgs pParams) Authorize billing against a StoreCredit payment group.
PaymentStatus	creditPaymentGroup(PaymentManagerPipelineArgs pParams) Credit a StoreCredit payment group.
PaymentStatus	debitPaymentGroup(PaymentManagerPipelineArgs pParams) Debit a StoreCredit payment group.
PaymentStatus	decreaseAuthorizationForPaymentGroup(PaymentManagerPipelineArgs pParams) Method called to perform a decrease in authorization for a store credit.

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

getRetCodes, invokeProcessorAction, runProcess

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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

ProcProcessStoreCredit

public ProcProcessStoreCredit()

Method Detail

authorizePaymentGroup

public PaymentStatus authorizePaymentGroup(PaymentManagerPipelineArgs pParams)
                                    throws CommerceException

Authorize billing against a StoreCredit payment group. This method simply calls through to the storeCreditProcessor 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 storeCreditProcessor authorize method.

Throws:

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

debitPaymentGroup

public PaymentStatus debitPaymentGroup(PaymentManagerPipelineArgs pParams)
                                throws CommerceException

Debit a StoreCredit payment group. This method simply calls through to the storeCreditProcessor 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 storeCreditProcessor debit method.

Throws:

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

creditPaymentGroup

public PaymentStatus creditPaymentGroup(PaymentManagerPipelineArgs pParams)
                                 throws CommerceException

Credit a StoreCredit payment group. This method simply calls through to the storeCreditProcessor 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 storeCreditProcessor credit method.

Throws:

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

decreaseAuthorizationForPaymentGroup

public PaymentStatus decreaseAuthorizationForPaymentGroup(PaymentManagerPipelineArgs pParams)
                                                   throws CommerceException

Method called to perform a decrease in authorization for a store credit.

Calls the decreaseAuthorization on the store credit processor returned by the payment manager if it is an instance of DecreaseCreditCardAuthorizationProcessor

Overrides:

decreaseAuthorizationForPaymentGroup in class ProcProcessPaymentGroup

Parameters:

pParams - params handed to pipeline processor

Returns:

a PaymentStatus value

Throws:

CommerceException - if an error occurs

See Also:

PaymentManager.getStoreCreditProcessor(), DecreaseStoreCreditAuthorizationProcessor