org.broadleafcommerce.core.payment.service

Interface OrderToPaymentRequestDTOService

All Known Implementing Classes:

OrderToPaymentRequestDTOServiceImpl

public interface OrderToPaymentRequestDTOService

Author:

Elbert Bautista (elbertbautista)

Method Summary

Methods

Modifier and Type	Method and Description
void	populateBillTo(Order order, PaymentRequestDTO requestDTO)
void	populateCustomerInfo(Order order, PaymentRequestDTO requestDTO)
void	populateDefaultLineItemsAndSubtotal(Order order, PaymentRequestDTO requestDTO)
void	populateShipTo(Order order, PaymentRequestDTO requestDTO) Uses the first shippable fulfillment group to populate the PaymentRequestDTO.shipTo() object
void	populateTotals(Order order, PaymentRequestDTO requestDTO)
PaymentRequestDTO	translateOrder(Order order) This translates an Order of PaymentType.CREDIT_CARD into a PaymentRequestDTO.
PaymentRequestDTO	translatePaymentTransaction(Money transactionAmount, PaymentTransaction paymentTransaction) Utilizes the PaymentTransaction.getAdditionalFields() map to populate necessary request parameters on the resulting PaymentRequestDTO.

Method Detail

translateOrder

PaymentRequestDTO translateOrder(Order order)

This translates an Order of PaymentType.CREDIT_CARD into a PaymentRequestDTO. This method assumes that this translation will apply to a final payment which means that the transaction amount for the returned PaymentRequestDTO will be Order.getTotalAfterAppliedPayments() It assumes that all other payments (e.g. gift cards/account credit) have already been applied to the Order.

Parameters:

order - the Order to be translated

Returns:

a PaymentRequestDTO based on the properties of order. This will only utilize the payments that are of type PaymentType.CREDIT_CARD

translatePaymentTransaction

PaymentRequestDTO translatePaymentTransaction(Money transactionAmount,
                                            PaymentTransaction paymentTransaction)

Utilizes the PaymentTransaction.getAdditionalFields() map to populate necessary request parameters on the resulting PaymentRequestDTO. These additional fields are then used by the payment gateway to construct additional requests to the payment gateway. For instance, this might be use to refund or void the given paymentTransaction

Parameters:

transactionAmount - the amount that should be placed on PaymentRequestDTO.getTransactionTotal()

paymentTransaction - the transaction whose additional fields should be placed on PaymentRequestDTO.getAdditionalFields() for the gateway to use

Returns:

a new PaymentRequestDTO populated with the additional fields from paymentTransaction and the amount from transactionAmount

populateTotals

void populateTotals(Order order,
                  PaymentRequestDTO requestDTO)

populateCustomerInfo

void populateCustomerInfo(Order order,
                        PaymentRequestDTO requestDTO)

populateShipTo

void populateShipTo(Order order,
                  PaymentRequestDTO requestDTO)

Uses the first shippable fulfillment group to populate the PaymentRequestDTO.shipTo() object

Parameters:

order - the Order to get data from

requestDTO - the PaymentRequestDTO that should be populated

See Also:

FulfillmentGroupService#getFirstShippableFulfillmentGroup(Order)}

populateBillTo

void populateBillTo(Order order,
                  PaymentRequestDTO requestDTO)

populateDefaultLineItemsAndSubtotal

void populateDefaultLineItemsAndSubtotal(Order order,
                                       PaymentRequestDTO requestDTO)