atg.commerce.payment

Class InStorePaymentProcessorImpl

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.payment.InStorePaymentProcessorImpl

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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, InStorePaymentProcessor, java.util.EventListener

public class InStorePaymentProcessorImpl
extends GenericService
implements InStorePaymentProcessor

This class performs the actual functions of authorizing, debiting and crediting an in store payment. These are all the methods that must be implemented in order to provide a payment method.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

Constructors

Constructor and Description
InStorePaymentProcessorImpl()

Method Summary

Methods

Modifier and Type	Method and Description
PaymentStatus	authorize(InStorePaymentInfo pInStorePaymentInfo) Authorize the use of in store payment.
protected PaymentStatus	createSuccessStatus(double pAmount) Create an instance of a PaymentStatus reflecting a successful transaction.
PaymentStatus	credit(InStorePaymentInfo pInStorePaymentInfo) Process refunds/credits on payments made by in store payment as a new order
PaymentStatus	credit(InStorePaymentInfo pInStorePaymentInfo, PaymentStatus pStatus) Process refunds/credits on payments made by in store payment.
PaymentStatus	debit(InStorePaymentInfo pInStorePaymentInfo, PaymentStatus pStatus) Process payment by in store payment.
CurrentDate	getClock() Return the "clock" component used to generate timestamps
protected java.lang.String	nextTransactionId() Generate a unique transaction id.
void	setClock(CurrentDate pClock) Set the "clock" component used to generate timestamps

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

Class version string

Constructor Detail

InStorePaymentProcessorImpl

public InStorePaymentProcessorImpl()

Method Detail

authorize

public PaymentStatus authorize(InStorePaymentInfo pInStorePaymentInfo)

Description copied from interface: InStorePaymentProcessor

Authorize the use of in store payment. Implementations that perform tests such as checks before placing an order may want to implement them in this method.

Specified by:

authorize in interface InStorePaymentProcessor

Parameters:

pInStorePaymentInfo - the InStorePaymentInfo that contains authorization data

Returns:

a PaymentStatus object detailing the results of the authorization

debit

public PaymentStatus debit(InStorePaymentInfo pInStorePaymentInfo,
                  PaymentStatus pStatus)

Description copied from interface: InStorePaymentProcessor

Process payment by in store payment.

Specified by:

debit in interface InStorePaymentProcessor

Parameters:

pInStorePaymentInfo - the InStorePaymentInfo that contains debit data

pStatus - the PaymentStatus object that contains information about the transaction. This will be the object that was returned by the last call to authorize().

Returns:

a PaymentStatus object detailing the results of the debit

credit

public PaymentStatus credit(InStorePaymentInfo pInStorePaymentInfo,
                   PaymentStatus pStatus)

Description copied from interface: InStorePaymentProcessor

Process refunds/credits on payments made by in store payment.

Specified by:

credit in interface InStorePaymentProcessor

Parameters:

pInStorePaymentInfo - the InStorePaymentInfo that contains credit data

pStatus - the PaymentStatus object that contains information about the transaction. This will be the object that was returned by the last call to debit().

Returns:

a PaymentStatus object detailing the results of the credit

credit

public PaymentStatus credit(InStorePaymentInfo pInStorePaymentInfo)

Description copied from interface: InStorePaymentProcessor

Process refunds/credits on payments made by in store payment as a new order

Specified by:

credit in interface InStorePaymentProcessor

Parameters:

pInStorePaymentInfo - the InStorePaymentInfo that contains credit data

Returns:

a PaymentStatus object detailing the results of the credit

nextTransactionId

protected java.lang.String nextTransactionId()

Generate a unique transaction id. The id has no semantic meaning whatsoever.

createSuccessStatus

protected PaymentStatus createSuccessStatus(double pAmount)

Create an instance of a PaymentStatus reflecting a successful transaction.

setClock

public void setClock(CurrentDate pClock)

Set the "clock" component used to generate timestamps

getClock

public CurrentDate getClock()

Return the "clock" component used to generate timestamps