de.hybris.platform.cscockpit.services.checkout

Interface CsCheckoutService

All Known Implementing Classes:

DefaultCsCheckoutService, DefaultSubscriptionCsCheckoutService

public interface CsCheckoutService

Service interface to support checking out a cart.

Method Summary

Modifier and Type	Method and Description
PaymentTransactionEntryModel	authorisePayment(CartModel cart, CardInfo cardInfo, double amount) Authorise payment for the cart or order.
PaymentTransactionEntryModel	authorisePayment(CartModel cart, CreditCardPaymentInfoModel storeCard, java.math.BigDecimal amount, java.lang.String cv2) Authorise payment for the cart.
void	canCreatePayments(CartModel cartModel) Test if payment options can be created against the current cart.
OrderModel	doCheckout(CartModel cart) Place an order based on the cart supplied.
java.util.List<DeliveryModeModel>	getAllDeliveryModes(CartModel cart) Get all the supported delivery modes for the cart specified.
double	getUnauthorizedTotal(CartModel cart) Gets the unauthorized total for the cart specified.
java.util.List<PaymentTransactionModel>	getValidPaymentTransactions(CartModel cart) Get the list of payment transactions that have been created for the cart specified.

Method Detail

doCheckout

OrderModel doCheckout(CartModel cart)
               throws ValidationException

Place an order based on the cart supplied.

Parameters:

cart - the cart

Returns:

the new order

Throws:

ValidationException - thrown if the order cannot be placed

getUnauthorizedTotal

double getUnauthorizedTotal(CartModel cart)

Gets the unauthorized total for the cart specified. The unauthorized total is the difference between the total price and the currently authorised amount. In the simplest case of a cart with no existing payment transactions the unauthorized total equals the total price. The unauthorized total returned must be in the range zero to total price.

Parameters:

cart - the cart

Returns:

the unauthorized total

getValidPaymentTransactions

java.util.List<PaymentTransactionModel> getValidPaymentTransactions(CartModel cart)

Get the list of payment transactions that have been created for the cart specified. The list only includes payment transactions that contain an authorisation that is both successful and valid.

Parameters:

cart - the cart

Returns:

the list of valid payment transactions

getAllDeliveryModes

java.util.List<DeliveryModeModel> getAllDeliveryModes(CartModel cart)

Get all the supported delivery modes for the cart specified.

Parameters:

cart - the cart

Returns:

the list of supported delivery modes

canCreatePayments

void canCreatePayments(CartModel cartModel)
                throws ValidationException

Test if payment options can be created against the current cart. This method performs validation on the cart to ensure that there are entries in the cart, that the cart total is positive and that there is still some amount remaining to be paid.

Parameters:

cartModel - The cart

Throws:

ValidationException - Exception thrown if payments cannot be created at this time. The exception includes messages that detail the errors.

authorisePayment

PaymentTransactionEntryModel authorisePayment(CartModel cart,
                                              CardInfo cardInfo,
                                              double amount)
                                       throws PaymentException,
                                              ValidationException

Authorise payment for the cart or order.

Parameters:

cart - the cart

cardInfo - the payment card data

amount - the amount to authorise

Returns:

the authorisation payment transaction entry

Throws:

PaymentException - thrown on error from the payment service

ValidationException - thrown if the card details are invalid

authorisePayment

PaymentTransactionEntryModel authorisePayment(CartModel cart,
                                              CreditCardPaymentInfoModel storeCard,
                                              java.math.BigDecimal amount,
                                              java.lang.String cv2)
                                       throws PaymentException,
                                              ValidationException

Authorise payment for the cart.

Parameters:

cart - the cart

storeCard - the stored card

amount - the amount to authorise

cv2 - the cv2 number

Returns:

the authorisation payment transaction entry

Throws:

PaymentException - thrown on error from the payment service

ValidationException - thrown if the card details are invalid