com.broadleafcommerce.cartoperation.service.payment.summary

Class DefaultPaymentSummaryService

java.lang.Object

com.broadleafcommerce.cartoperation.service.payment.summary.DefaultPaymentSummaryService

All Implemented Interfaces:

PaymentSummaryService

public class DefaultPaymentSummaryService
extends Object
implements PaymentSummaryService

Default implementation of the PaymentSummaryService.

Author:

Dima Myroniuk (dmyroniuk)

Constructor Summary

Constructors

Constructor and Description
DefaultPaymentSummaryService(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method and Description
protected com.broadleafcommerce.order.common.domain.PaymentSummary	buildBasePaymentSummary(com.broadleafcommerce.order.common.domain.Payment payment)
com.broadleafcommerce.order.common.domain.PaymentSummary	buildPaymentSummary(@NonNull com.broadleafcommerce.order.common.domain.Payment payment) Determines PaymentSummary based on the Payment's PaymentTransactions.
protected javax.money.MonetaryAmount	determineAuthorizedAmount(@NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary, @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions) Determines the authorized amount of the payment transactions - "total authorized - total reverse-authed".
protected javax.money.MonetaryAmount	determineCapturedAmount(@NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary, @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions) Determines the captured amount of the payment transactions - "total captured - total refunded - total voided".
protected javax.money.MonetaryAmount	determineDetachedCreditAmount(@NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary, @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions) Determines the detached amount of the payment transactions.
protected javax.money.MonetaryAmount	determineRefundedAmount(@NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary, @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions) Determines the refunded amount of the payment transactions.
protected javax.money.MonetaryAmount	determineSettledAmount(@NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary, @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions) Determines the settled amount of the payment transactions.
protected javax.money.MonetaryAmount	determineVoidedAmount(@NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary, @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions) Determines the voided amount of the payment transactions.
protected List<com.broadleafcommerce.order.common.domain.PaymentTransaction>	filterOutFailedAndReversedTransactions(@NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions)
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPaymentSummaryService

public DefaultPaymentSummaryService(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

buildPaymentSummary

public com.broadleafcommerce.order.common.domain.PaymentSummary buildPaymentSummary(@NonNull
                                                                                    @NonNull com.broadleafcommerce.order.common.domain.Payment payment)

Description copied from interface: PaymentSummaryService

Determines PaymentSummary based on the Payment's PaymentTransactions.

Specified by:

buildPaymentSummary in interface PaymentSummaryService

Parameters:

payment - the payment to determine the summary

Returns:

the payment summary for the specified payment

filterOutFailedAndReversedTransactions

protected List<com.broadleafcommerce.order.common.domain.PaymentTransaction> filterOutFailedAndReversedTransactions(@NonNull
                                                                                                                    @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions)

buildBasePaymentSummary

protected com.broadleafcommerce.order.common.domain.PaymentSummary buildBasePaymentSummary(com.broadleafcommerce.order.common.domain.Payment payment)

determineAuthorizedAmount

protected javax.money.MonetaryAmount determineAuthorizedAmount(@NonNull
                                                               @NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary,
                                                               @NonNull
                                                               @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions)

Determines the authorized amount of the payment transactions - "total authorized - total reverse-authed".

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the authorized amount of the payment transactions

determineCapturedAmount

protected javax.money.MonetaryAmount determineCapturedAmount(@NonNull
                                                             @NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary,
                                                             @NonNull
                                                             @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions)

Determines the captured amount of the payment transactions - "total captured - total refunded - total voided".

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the captured amount of the payment transactions

determineDetachedCreditAmount

protected javax.money.MonetaryAmount determineDetachedCreditAmount(@NonNull
                                                                   @NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary,
                                                                   @NonNull
                                                                   @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions)

Determines the detached amount of the payment transactions.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the detached amount of the payment transactions

determineRefundedAmount

protected javax.money.MonetaryAmount determineRefundedAmount(@NonNull
                                                             @NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary,
                                                             @NonNull
                                                             @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions)

Determines the refunded amount of the payment transactions.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the refunded amount of the payment transactions

determineSettledAmount

protected javax.money.MonetaryAmount determineSettledAmount(@NonNull
                                                            @NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary,
                                                            @NonNull
                                                            @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions)

Determines the settled amount of the payment transactions.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the settled amount of the payment transactions

determineVoidedAmount

protected javax.money.MonetaryAmount determineVoidedAmount(@NonNull
                                                           @NonNull com.broadleafcommerce.order.common.domain.PaymentSummary paymentSummary,
                                                           @NonNull
                                                           @NonNull List<com.broadleafcommerce.order.common.domain.PaymentTransaction> transactions)

Determines the voided amount of the payment transactions.

Parameters:

paymentSummary - the PaymentSummary for the payment

transactions - the payment transactions

Returns:

the voided amount of the payment transactions

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()