Package com.broadleafcommerce.paymenttransaction.service.summary

Interface PaymentSummaryService

All Known Implementing Classes:

DefaultPaymentSummaryService

public interface PaymentSummaryService

This service provides a mechanism to build a PaymentSummary based on the state of a Payment Payment and it's PaymentTransactions.

Author:

Dima Myroniuk (dmyroniuk)

Method Summary

Modifier and Type	Method	Description
default List<PaymentSummary>	buildPaymentSummaries(List<Payment> payments)	Builds a list of PaymentSummaries based on the Payment.
default PaymentSummary	buildPaymentSummary(Payment payment)	Determines PaymentSummary based on the Payment's PaymentTransactions.
PaymentSummary	buildPaymentSummary(Payment payment, String sourceEntityType, String sourceEntityId)	Determines PaymentSummary based on the Payment's PaymentTransactions and the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().
PaymentSummary	buildPaymentSummary(Payment payment, Set<String> sourceEntityTypes)	Determines PaymentSummary based on the Payment's PaymentTransactions and the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().

Method Details

buildPaymentSummary

default PaymentSummary buildPaymentSummary(Payment payment)

Determines PaymentSummary based on the Payment's PaymentTransactions.

Parameters:

payment - the payment to determine the summary

Returns:

the payment summary for the specified payment

buildPaymentSummaries

default List<PaymentSummary> buildPaymentSummaries(List<Payment> payments)

Builds a list of PaymentSummaries based on the Payment.

Parameters:

payments - the payments to build the summaries from

Returns:

the payment summaries for the provided payments

buildPaymentSummary

PaymentSummary buildPaymentSummary(Payment payment,
 @Nullable
 String sourceEntityType,
 @Nullable
 String sourceEntityId)

Determines PaymentSummary based on the Payment's PaymentTransactions and the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().

Parameters:

payment - the payment to determine the summary

sourceEntityType - the PaymentTransaction.getSourceEntityType() to filter the Payment.getTransactions() by

sourceEntityId - the PaymentTransaction.getSourceEntityId() to filter the Payment.getTransactions() by

Returns:

the payment summary for the specified payment

buildPaymentSummary

PaymentSummary buildPaymentSummary(Payment payment,
 Set<String> sourceEntityTypes)

Determines PaymentSummary based on the Payment's PaymentTransactions and the given PaymentTransaction.getSourceEntityType() and PaymentTransaction.getSourceEntityId().

Parameters:

payment - the payment to determine the summary

sourceEntityTypes - the set of PaymentTransaction.getSourceEntityType() to filter the Payment.getTransactions() by

Returns:

the payment summary for the specified payment