org.broadleafcommerce.core.payment.service.module

Class AbstractModule

java.lang.Object

org.broadleafcommerce.core.payment.service.module.AbstractModule

All Implemented Interfaces:

PaymentModule

Direct Known Subclasses:

AcceptAndPassthroughModule, DefaultModule, NullCreditCardPaymentModule

public abstract class AbstractModule
extends Object
implements PaymentModule

Constructor Summary

Constructors

Constructor and Description
AbstractModule()

Method Summary

Methods

Modifier and Type	Method and Description
PaymentResponseItem	authorize(PaymentContext paymentContext)
PaymentResponseItem	authorizeAndDebit(PaymentContext paymentContext)
PaymentResponseItem	balance(PaymentContext paymentContext)
PaymentResponseItem	credit(PaymentContext paymentContext)
PaymentResponseItem	debit(PaymentContext paymentContext)
protected PaymentInfo	findPaymentInfoFromContext(PaymentContext paymentContext)
protected Money	getAmountAvailableToCredit(PaymentContext paymentContext)
protected Money	getAmountAvailableToDebit(PaymentContext paymentContext)
protected Money	getAmountAvailableToReverseAuthorize(PaymentContext paymentContext)
protected PaymentInfoDetail	getNewCapturePaymentInfoDetail(PaymentInfo paymentInfo, Money amount)
protected PaymentInfoDetail	getNewPaymentInfoDetail(PaymentInfo paymentInfo, PaymentInfoDetailType type, Money amount)
protected PaymentInfoDetail	getNewRefundPaymentInfoDetail(PaymentInfo paymentInfo, Money amount)
protected PaymentResponseItem	getNewResponseItem()
protected PaymentResponseItem	getNewResponseItem(Money amount, BroadleafCurrency currency)
protected PaymentInfoDetail	getNewReverseAuthPaymentInfoDetail(PaymentInfo paymentInfo, Money amount)
PaymentResponseItem	partialPayment(PaymentContext paymentContext)
PaymentResponseItem	reverseAuthorize(PaymentContext paymentContext) Typically payment module implementors would not override this method.
PaymentResponseItem	voidPayment(PaymentContext paymentContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.broadleafcommerce.core.payment.service.module.PaymentModule

isValidCandidate, processAuthorize, processAuthorizeAndDebit, processBalance, processCredit, processDebit, processPartialPayment, processReverseAuthorize, processVoidPayment

Constructor Detail

AbstractModule

public AbstractModule()

Method Detail

authorize

public PaymentResponseItem authorize(PaymentContext paymentContext)
                              throws PaymentException

Specified by:

authorize in interface PaymentModule

Throws:

PaymentException

reverseAuthorize

public PaymentResponseItem reverseAuthorize(PaymentContext paymentContext)
                                     throws PaymentException

Typically payment module implementors would not override this method. They would instead override the processReverseAuthorize() method.

Specified by:

reverseAuthorize in interface PaymentModule

Parameters:

paymentContext -

Returns:

Throws:

PaymentException

debit

public PaymentResponseItem debit(PaymentContext paymentContext)
                          throws PaymentException

Specified by:

debit in interface PaymentModule

Throws:

PaymentException

authorizeAndDebit

public PaymentResponseItem authorizeAndDebit(PaymentContext paymentContext)
                                      throws PaymentException

Specified by:

authorizeAndDebit in interface PaymentModule

Throws:

PaymentException

credit

public PaymentResponseItem credit(PaymentContext paymentContext)
                           throws PaymentException

Specified by:

credit in interface PaymentModule

Throws:

PaymentException

voidPayment

public PaymentResponseItem voidPayment(PaymentContext paymentContext)
                                throws PaymentException

Specified by:

voidPayment in interface PaymentModule

Throws:

PaymentException

balance

public PaymentResponseItem balance(PaymentContext paymentContext)
                            throws PaymentException

Specified by:

balance in interface PaymentModule

Throws:

PaymentException

partialPayment

public PaymentResponseItem partialPayment(PaymentContext paymentContext)
                                   throws PaymentException

Specified by:

partialPayment in interface PaymentModule

Throws:

PaymentException

getNewResponseItem

protected PaymentResponseItem getNewResponseItem()

getNewResponseItem

protected PaymentResponseItem getNewResponseItem(Money amount,
                                     BroadleafCurrency currency)

getNewPaymentInfoDetail

protected PaymentInfoDetail getNewPaymentInfoDetail(PaymentInfo paymentInfo,
                                        PaymentInfoDetailType type,
                                        Money amount)

getNewCapturePaymentInfoDetail

protected PaymentInfoDetail getNewCapturePaymentInfoDetail(PaymentInfo paymentInfo,
                                               Money amount)

getNewRefundPaymentInfoDetail

protected PaymentInfoDetail getNewRefundPaymentInfoDetail(PaymentInfo paymentInfo,
                                              Money amount)

getNewReverseAuthPaymentInfoDetail

protected PaymentInfoDetail getNewReverseAuthPaymentInfoDetail(PaymentInfo paymentInfo,
                                                   Money amount)

findPaymentInfoFromContext

protected PaymentInfo findPaymentInfoFromContext(PaymentContext paymentContext)

getAmountAvailableToDebit

protected Money getAmountAvailableToDebit(PaymentContext paymentContext)

getAmountAvailableToCredit

protected Money getAmountAvailableToCredit(PaymentContext paymentContext)

getAmountAvailableToReverseAuthorize

protected Money getAmountAvailableToReverseAuthorize(PaymentContext paymentContext)