de.hybris.platform.cscockpit.widgets.controllers

Interface CheckoutController

All Superinterfaces:

WidgetController

All Known Implementing Classes:

DefaultCheckoutController, DefaultSubscriptionCheckoutController

public interface CheckoutController
extends WidgetController

Interface for the checkout controller

Method Summary

Modifier and Type	Method and Description
void	canCreatePayments() Test if payment options can be created against the current cart.
BasketController	getBasketController() Get the basket controller
java.util.Date	getFirstAvailableNamedDeliveryDate(TypedObject cartEntry) Get the first available named delivery date for the
double	getSuggestedAmountForPaymentOption() Get the outstanding payment amount.
java.util.List<TypedObject>	getTokenisedCreditCards() Gets the list of tokenised credit cards of this customer
java.util.List<TypedObject>	getValidPaymentTransactions() Get the valid payment transactions for the cart
boolean	needPaymentOption() Does the cart require further payment.
TypedObject	placeOrder() Place the order.
boolean	processPayment(TypedObject tokenisedCreditCard, java.math.BigDecimal amount, java.lang.String cv2)
boolean	setNamedDeliveryDate(TypedObject cartEntry, java.util.Date date) Set the named delivery date on a cart entry
boolean	splitCartEntry(TypedObject cartEntry) Split a cart entry into 2 cart entries.

Methods inherited from interface de.hybris.platform.cockpit.widgets.controllers.WidgetController

addCockpitEventAcceptor, dispatchEvent, removeCockpitEventAcceptor, setCockpitEventAcceptors

Method Detail

placeOrder

TypedObject placeOrder()
                throws ValidationException

Place the order.

Returns:

the new order

Throws:

ValidationException - thrown if the order fails validation

getBasketController

BasketController getBasketController()

Get the basket controller

Returns:

the basket controller

splitCartEntry

boolean splitCartEntry(TypedObject cartEntry)
                throws InvalidCartException

Split a cart entry into 2 cart entries. The original cart entry will have its quantity reduced by 1. The new cart entry will have the same attributes as the original cart entry, but will have the quantity 1.

Parameters:

cartEntry - the cart entry

Returns:

true if the cart entry has been split

Throws:

InvalidCartException - thrown on error

getFirstAvailableNamedDeliveryDate

java.util.Date getFirstAvailableNamedDeliveryDate(TypedObject cartEntry)

Get the first available named delivery date for the

Parameters:

cartEntry - the cart entry

Returns:

the earliest available delivery date for the cart entry

setNamedDeliveryDate

boolean setNamedDeliveryDate(TypedObject cartEntry,
                             java.util.Date date)

Set the named delivery date on a cart entry

Parameters:

cartEntry - the cart entry

date - the named delivery date

Returns:

true if the named delivery date has been changed

getSuggestedAmountForPaymentOption

double getSuggestedAmountForPaymentOption()

Get the outstanding payment amount. This amount must be authorised before the order can be placed.

Returns:

the outstanding payment amount

needPaymentOption

boolean needPaymentOption()

Does the cart require further payment.

Returns:

true if the cart needs further payment

getValidPaymentTransactions

java.util.List<TypedObject> getValidPaymentTransactions()

Get the valid payment transactions for the cart

Returns:

the list of payment transactions

canCreatePayments

void canCreatePayments()
                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.

Throws:

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

getTokenisedCreditCards

java.util.List<TypedObject> getTokenisedCreditCards()

Gets the list of tokenised credit cards of this customer

Returns:

The list of tokenised credit cards

processPayment

boolean processPayment(TypedObject tokenisedCreditCard,
                       java.math.BigDecimal amount,
                       java.lang.String cv2)
                throws PaymentException,
                       ValidationException

Parameters:

tokenisedCreditCard - the stored card

amount - the amount to authorise

cv2 - the cv2 number

Returns:

true on success

Throws:

PaymentException - thrown when payment service fails

ValidationException - thrown if the payment data is invalid