Package com.broadleafcommerce.paymenttransaction.service.utils

Interface TransactionExecutionUtil

All Known Implementing Classes:

DefaultTransactionExecutionUtil

public interface TransactionExecutionUtil

Simple util class to assist with the building of a TransactionExecutionDetail, based on a TransactionExecutionRequest, a Payment, and a PaymentTransaction.

Author:

Chris Kittrell (ckittrell)

Method Summary

Modifier and Type	Method	Description
TransactionExecutionDetail	buildTransactionExecutionDetail(Payment payment, PaymentTransaction transaction, com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse)	Builds a TransactionExecutionDetail based on the provided TransactionExecutionRequest and PaymentTransaction.
default TransactionExecutionResponse	buildTransactionExecutionResponse(Payment payment, PaymentTransaction transaction)	Builds a TransactionExecutionResponse based on the provided Payment, and PaymentTransaction.
TransactionExecutionResponse	buildTransactionExecutionResponse(Payment payment, PaymentTransaction transaction, com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse)	Builds a TransactionExecutionResponse based on the provided Payment, and PaymentTransaction.
default TransactionExecutionResponse	buildTransactionExecutionResponse(TransactionExecutionRequest request, TransactionExecutionDetail transactionExecutionDetail, Payment payment)	Builds a TransactionExecutionResponse for a single TransactionExecutionDetail and Payment.
TransactionExecutionResponse	buildTransactionExecutionResponse(TransactionExecutionRequest request, List<TransactionExecutionDetail> transactionExecutionDetails, Payment payment)	Builds a TransactionExecutionResponse based on the given TransactionExecutionDetails and Payment.
List<TransactionWithExecutableAmount>	getParentTransactionWithExecutableAmounts(Payment payment, TransactionExecutionRequest request)	Gets a list of TransactionWithExecutableAmounts representing the parent transactions of the given TransactionExecutionRequest.

Method Details

buildTransactionExecutionResponse

default TransactionExecutionResponse buildTransactionExecutionResponse(TransactionExecutionRequest request,
 TransactionExecutionDetail transactionExecutionDetail,
 @Nullable
 Payment payment)

Builds a TransactionExecutionResponse for a single TransactionExecutionDetail and Payment.

This is useful for TransactionExecutionRequest that doesn't require a parent transaction, such as DefaultTransactionTypes.AUTHORIZE and DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE.

Parameters:

request - the TransactionExecutionRequest describing the desired details of the execution

transactionExecutionDetail - the TransactionExecutionDetail that was executed

payment - the related Payment that the transactions acted against

Returns:

a TransactionExecutionResponse for a single TransactionExecutionDetail and Payment

buildTransactionExecutionResponse

TransactionExecutionResponse buildTransactionExecutionResponse(TransactionExecutionRequest request,
 List<TransactionExecutionDetail> transactionExecutionDetails,
 @Nullable
 Payment payment)

Builds a TransactionExecutionResponse based on the given TransactionExecutionDetails and Payment.

This is used when multiple transactions were executed for a single TransactionExecutionRequest, which can happen when the TransactionExecutionRequest.getTransactionType() requires one or more proceeding parent transactions to act against, such as DefaultTransactionTypes.REFUND.

For example, let's say we have 2 capture transactions, one for $10 and one for $5, and the TransactionExecutionRequest wants to execute a refund for $15. In this case, one refund transaction is needed for each parent capture transaction to cover the whole $15, one refund for $10 and one for $5.

Note that out-of-box, the scenario of having multiple parent transactions is very unlikely and not expected, however it is supported.

Parameters:

request - the TransactionExecutionRequest describing the desired details of the execution

transactionExecutionDetails - a list of TransactionExecutionDetails that were executed

payment - the related Payment that the transactions acted against

Returns:

a TransactionExecutionResponse based on the given TransactionExecutionDetails and Payment

buildTransactionExecutionDetail

TransactionExecutionDetail buildTransactionExecutionDetail(@Nullable
 Payment payment,
 PaymentTransaction transaction,
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse)

Builds a TransactionExecutionDetail based on the provided TransactionExecutionRequest and PaymentTransaction.

Parameters:

payment - The related Payment that the transactions acted against.

transaction - The transaction that was executed.

paymentResponse - The payment gateway's response to the executed transaction

Returns:

A TransactionExecutionDetail based on the provided TransactionExecutionRequest and PaymentTransaction

buildTransactionExecutionResponse

default TransactionExecutionResponse buildTransactionExecutionResponse(@Nullable
 Payment payment,
 PaymentTransaction transaction)

Builds a TransactionExecutionResponse based on the provided Payment, and PaymentTransaction.

Parameters:

payment - The related Payment that the request will act against.

transaction - The transaction that was executed.

Returns:

A TransactionExecutionResponse based on the provided Payment, and PaymentTransaction

buildTransactionExecutionResponse

TransactionExecutionResponse buildTransactionExecutionResponse(@Nullable
 Payment payment,
 PaymentTransaction transaction,
 @Nullable
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse)

Builds a TransactionExecutionResponse based on the provided Payment, and PaymentTransaction.

Parameters:

payment - The related Payment that the request will act against.

transaction - The transaction that was executed.

paymentResponse - The payment gateway's response to the executed transaction

Returns:

A TransactionExecutionResponse based on the provided Payment, and PaymentTransaction

getParentTransactionWithExecutableAmounts

List<TransactionWithExecutableAmount> getParentTransactionWithExecutableAmounts(Payment payment,
 TransactionExecutionRequest request)

Gets a list of TransactionWithExecutableAmounts representing the parent transactions of the given TransactionExecutionRequest.

This is used when the TransactionExecutionRequest.getTransactionType() requires one or more proceeding parent transactions to act against. For example, if the request is for DefaultTransactionTypes.REFUND, this will retrieve all the non-fully-reversed parent transactions, such as capture, etc.

Note that out-of-box, the scenario of having multiple parent transactions is very unlikely and not expected, however it is supported.

Parameters:

payment - the Payment to look for the transaction from.

Returns:

a list of TransactionWithExecutableAmounts representing the parent transactions of the given TransactionExecutionRequest

Throws:

InvalidTransactionExecutionRequestException - if the given TransactionExecutionRequest.getTransactionType() requires a parent transaction but is not found