Class TransactionExecutionResponse
java.lang.Object
com.broadleafcommerce.cartoperation.service.provider.external.domain.payment.TransactionExecutionResponse
- All Implemented Interfaces:
Serializable
Response object describing the resulting transaction details and
PaymentSummary
.- Author:
- Chris Kittrell (ckittrell)
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
javax.money.MonetaryAmount
The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.javax.money.MonetaryAmount
The total amount that we're expecting to be executed against the payment, spread across thetransactionExecutionDetails
.javax.money.MonetaryAmount
The total fees related to theexpectedTotalAmount
javax.money.MonetaryAmount
The payment's total fulfillment cost.javax.money.MonetaryAmount
The amount of taxes that are included in the subtotal (VAT).The list of all payments for the owning entity (e.g.The updatedPaymentSummary
representation.The id representing the customer's request to execute one or more transactions.javax.money.MonetaryAmount
The payment's total usually excluding adjustments, tax, fees, and shipping.javax.money.MonetaryAmount
The payment's total tax cost.A list ofTransactionExecutionDetails
describing the transactions executed.The type of transactions that were executed.int
hashCode()
boolean
Whether any of the transactions are awaiting result based onTransactionExecutionDetail.isAwaitingResult()
.boolean
Whether any of the transactions have been flagged for manual review based onTransactionExecutionDetail.isFlaggedForManualReview()
.void
setAdjustmentsTotal
(javax.money.MonetaryAmount adjustmentsTotal) The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.void
setExpectedTotalAmount
(javax.money.MonetaryAmount expectedTotalAmount) The total amount that we're expecting to be executed against the payment, spread across thetransactionExecutionDetails
.void
setFeesTotal
(javax.money.MonetaryAmount feesTotal) The total fees related to theexpectedTotalAmount
void
setFulfillmentTotal
(javax.money.MonetaryAmount fulfillmentTotal) The payment's total fulfillment cost.void
setIncludedTaxTotal
(javax.money.MonetaryAmount includedTaxTotal) The amount of taxes that are included in the subtotal (VAT).void
setOwningEntityPayments
(List<PaymentSummary> owningEntityPayments) The list of all payments for the owning entity (e.g.void
setPaymentSummary
(PaymentSummary paymentSummary) The updatedPaymentSummary
representation.void
setRequestId
(String requestId) The id representing the customer's request to execute one or more transactions.void
setSubtotal
(javax.money.MonetaryAmount subtotal) The payment's total usually excluding adjustments, tax, fees, and shipping.void
setTaxTotal
(javax.money.MonetaryAmount taxTotal) The payment's total tax cost.void
setTransactionExecutionDetails
(List<TransactionExecutionDetail> transactionExecutionDetails) A list ofTransactionExecutionDetails
describing the transactions executed.void
setTransactionType
(String transactionType) The type of transactions that were executed.toString()
boolean
Whether all the transactions were successful based onTransactionExecutionDetail.wasSuccessful()
.
-
Constructor Details
-
TransactionExecutionResponse
public TransactionExecutionResponse()
-
-
Method Details
-
wasSuccessful
public boolean wasSuccessful()Whether all the transactions were successful based onTransactionExecutionDetail.wasSuccessful()
.- Returns:
- Whether or not all the transactions were successful.
- See Also:
-
hasTransactionAwaitingResult
public boolean hasTransactionAwaitingResult()Whether any of the transactions are awaiting result based onTransactionExecutionDetail.isAwaitingResult()
.- Returns:
- Whether or not all the transactions are awaiting result.
- See Also:
-
hasTransactionFlaggedForManualReview
public boolean hasTransactionFlaggedForManualReview()Whether any of the transactions have been flagged for manual review based onTransactionExecutionDetail.isFlaggedForManualReview()
.- Returns:
- Whether any of the transactions have been flagged for manual review.
- See Also:
-
getPaymentId
-
getTransactionIds
-
getPaymentSummary
The updatedPaymentSummary
representation.This can be null if the payment is archived as a result of a failed transaction.
- Returns:
- The updated
PaymentSummary
representation.
-
getOwningEntityPayments
The list of all payments for the owning entity (e.g. Cart). This list is returned if the request containshydrateOwningEntityPayments=true
parameter.- Returns:
- all payments for the owning entity (e.g. Cart)
-
getTransactionType
The type of transactions that were executed.- Returns:
- The type of transactions that were executed.
- See Also:
-
getTransactionExecutionDetails
A list ofTransactionExecutionDetails
describing the transactions executed.- Returns:
- A list of
TransactionExecutionDetails
describing the transactions executed.
-
getRequestId
The id representing the customer's request to execute one or more transactions.- Returns:
- The id representing the customer's request to execute one or more transactions.
-
getExpectedTotalAmount
public javax.money.MonetaryAmount getExpectedTotalAmount()The total amount that we're expecting to be executed against the payment, spread across thetransactionExecutionDetails
. This amount must be valid according to what's available for the payment. If specified, the amount details (subtotal
,adjustmentsTotal
,fulfillmentTotal
, &taxTotal
) should sum together to equal this amount.- Returns:
- The total amount that we're expecting to execute against the payment, spread across
the
transactionExecutionDetails
.
-
getSubtotal
public javax.money.MonetaryAmount getSubtotal()The payment's total usually excluding adjustments, tax, fees, and shipping.- Returns:
- The payment's total usually excluding adjustments, tax, fees, and shipping.
-
getAdjustmentsTotal
public javax.money.MonetaryAmount getAdjustmentsTotal()The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.- Returns:
- The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
-
getFulfillmentTotal
public javax.money.MonetaryAmount getFulfillmentTotal()The payment's total fulfillment cost.- Returns:
- The payment's total fulfillment cost.
-
getFeesTotal
public javax.money.MonetaryAmount getFeesTotal()The total fees related to theexpectedTotalAmount
- Returns:
- The total fees related to the
expectedTotalAmount
-
getTaxTotal
public javax.money.MonetaryAmount getTaxTotal()The payment's total tax cost.- Returns:
- The payment's total tax cost.
-
getIncludedTaxTotal
public javax.money.MonetaryAmount getIncludedTaxTotal()The amount of taxes that are included in the subtotal (VAT).- Returns:
- The amount of taxes that are included in the subtotal (VAT).
-
setPaymentSummary
The updatedPaymentSummary
representation.This can be null if the payment is archived as a result of a failed transaction.
- Parameters:
paymentSummary
- The updatedPaymentSummary
representation.
-
setOwningEntityPayments
The list of all payments for the owning entity (e.g. Cart). This list is returned if the request containshydrateOwningEntityPayments=true
parameter.- Parameters:
owningEntityPayments
- all payments for the owning entity (e.g. Cart)
-
setTransactionType
The type of transactions that were executed.- Parameters:
transactionType
- The type of transactions that were executed.- See Also:
-
setTransactionExecutionDetails
public void setTransactionExecutionDetails(List<TransactionExecutionDetail> transactionExecutionDetails) A list ofTransactionExecutionDetails
describing the transactions executed.- Parameters:
transactionExecutionDetails
- A list ofTransactionExecutionDetails
describing the transactions executed.
-
setRequestId
The id representing the customer's request to execute one or more transactions.- Parameters:
requestId
- The id representing the customer's request to execute one or more transactions.
-
setExpectedTotalAmount
public void setExpectedTotalAmount(javax.money.MonetaryAmount expectedTotalAmount) The total amount that we're expecting to be executed against the payment, spread across thetransactionExecutionDetails
. This amount must be valid according to what's available for the payment. If specified, the amount details (subtotal
,adjustmentsTotal
,fulfillmentTotal
, &taxTotal
) should sum together to equal this amount.- Parameters:
expectedTotalAmount
- The total amount that we're expecting to execute against the payment, spread across thetransactionExecutionDetails
.
-
setSubtotal
public void setSubtotal(javax.money.MonetaryAmount subtotal) The payment's total usually excluding adjustments, tax, fees, and shipping.- Parameters:
subtotal
- The payment's total usually excluding adjustments, tax, fees, and shipping.
-
setAdjustmentsTotal
public void setAdjustmentsTotal(javax.money.MonetaryAmount adjustmentsTotal) The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.- Parameters:
adjustmentsTotal
- The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
-
setFulfillmentTotal
public void setFulfillmentTotal(javax.money.MonetaryAmount fulfillmentTotal) The payment's total fulfillment cost.- Parameters:
fulfillmentTotal
- The payment's total fulfillment cost.
-
setFeesTotal
public void setFeesTotal(javax.money.MonetaryAmount feesTotal) The total fees related to theexpectedTotalAmount
- Parameters:
feesTotal
- The total fees related to theexpectedTotalAmount
-
setTaxTotal
public void setTaxTotal(javax.money.MonetaryAmount taxTotal) The payment's total tax cost.- Parameters:
taxTotal
- The payment's total tax cost.
-
setIncludedTaxTotal
public void setIncludedTaxTotal(javax.money.MonetaryAmount includedTaxTotal) The amount of taxes that are included in the subtotal (VAT).- Parameters:
includedTaxTotal
- The amount of taxes that are included in the subtotal (VAT).
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-