de.hybris.platform.cscockpit.widgets.controllers.impl

Class DefaultCheckoutController

java.lang.Object

de.hybris.platform.cockpit.widgets.controllers.impl.AbstractWidgetController

de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCsWidgetController

de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCallContextDependantController

de.hybris.platform.cscockpit.widgets.controllers.impl.DefaultCheckoutController

All Implemented Interfaces:

WidgetController, CardPaymentController, CheckoutController

Direct Known Subclasses:

DefaultSubscriptionCheckoutController

public class DefaultCheckoutController
extends AbstractCallContextDependantController
implements CheckoutController, CardPaymentController

The default implementation of the CardPaymentController interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultCheckoutController.PaymentOption Payment option used to return the data extracted from the payment form.

Field Summary

Fields inherited from class de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCsWidgetController

CONTROLLER_CONTEXT

Constructor Summary

Constructors

Constructor and Description
DefaultCheckoutController()

Method Summary

Modifier and Type	Method and Description
void	canCreatePayments() Test if payment options can be created against the current cart.
protected ImpersonationContext	createImpersonationContext(CartModel cartModel)
protected DefaultCheckoutController.PaymentOption	createPaymentOption()
protected DefaultCheckoutController.PaymentOption	createPaymentOptionFrom(ObjectValueContainer paymentOptionValueContainer)
void	dispatchEvent(java.lang.String context, java.lang.Object source, java.util.Map<java.lang.String,java.lang.Object> data) Notifies all event acceptors which are registered for events with the context code context.
java.util.List<CreditCardType>	getAvailableCartTypes() The list of available card types
BasketController	getBasketController() Get the basket controller
protected CartModel	getCartModel()
CommerceCartService	getCommerceCartService()
protected CommonI18NService	getCommonI18NService()
protected CsCardPaymentService	getCsCardPaymentService()
protected CsCheckoutService	getCsCheckoutService()
TypedObject	getCurrency() Get the payment currency
CustomerController	getCustomerController() Get the customer controller
TypedObject	getDefaultPaymentAddress() Get the default payment address
java.util.Date	getFirstAvailableNamedDeliveryDate(TypedObject cartEntry) Get the first available named delivery date for the
protected ImpersonationService	getImpersonationService()
protected NamedDeliveryDateStrategy	getNamedDeliveryDateStrategy()
java.util.List<TypedObject>	getPreviousPaymentInfos() Get the list of available payment infos that can be used as templates for the card payment form.
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.
protected void	populatePaymentOption(ObjectValueContainer paymentOptionValueContainer, DefaultCheckoutController.PaymentOption paymentOption)
boolean	processPayment(ObjectValueContainer paymentOptionValueContainer) Process the card payment
boolean	processPayment(TypedObject tokenisedCreditCard, java.math.BigDecimal amount, java.lang.String cv2)
protected void	pushProperties(java.util.Map<java.lang.String,java.lang.Object> values, java.lang.Object targetInstance)
void	setBasketController(BasketController basketController)
void	setCommerceCartService(CommerceCartService commerceCartService)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setCsCardPaymentService(CsCardPaymentService csCardPaymentService)
void	setCsCheckoutService(CsCheckoutService csCheckoutService)
void	setImpersonationService(ImpersonationService impersonationService)
boolean	setNamedDeliveryDate(TypedObject cartEntry, java.util.Date date) Set the named delivery date on a cart entry
void	setNamedDeliveryDateStrategy(NamedDeliveryDateStrategy namedDeliveryDateStrategy)
boolean	splitCartEntry(TypedObject cartEntry) Split a cart entry into 2 cart entries.

Methods inherited from class de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCallContextDependantController

bindToCallContextController, getCallContextController, handleCallContextControllerEvent, setCallContextController

Methods inherited from class de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCsWidgetController

getCockpitTypeService, getModelService, setCockpitTypeService, setModelService

Methods inherited from class de.hybris.platform.cockpit.widgets.controllers.impl.AbstractWidgetController

addCockpitEventAcceptor, dispatchEvent, getAcceptors, removeCockpitEventAcceptor, setCockpitEventAcceptors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addCockpitEventAcceptor, removeCockpitEventAcceptor, setCockpitEventAcceptors

Constructor Detail

DefaultCheckoutController

public DefaultCheckoutController()

Method Detail

getCsCardPaymentService

protected CsCardPaymentService getCsCardPaymentService()

setCsCardPaymentService

public void setCsCardPaymentService(CsCardPaymentService csCardPaymentService)

getCsCheckoutService

protected CsCheckoutService getCsCheckoutService()

setCsCheckoutService

public void setCsCheckoutService(CsCheckoutService csCheckoutService)

getNamedDeliveryDateStrategy

protected NamedDeliveryDateStrategy getNamedDeliveryDateStrategy()

setNamedDeliveryDateStrategy

public void setNamedDeliveryDateStrategy(NamedDeliveryDateStrategy namedDeliveryDateStrategy)

getCommerceCartService

public CommerceCartService getCommerceCartService()

setCommerceCartService

public void setCommerceCartService(CommerceCartService commerceCartService)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getImpersonationService

protected ImpersonationService getImpersonationService()

setImpersonationService

public void setImpersonationService(ImpersonationService impersonationService)

dispatchEvent

public void dispatchEvent(java.lang.String context,
                          java.lang.Object source,
                          java.util.Map<java.lang.String,java.lang.Object> data)

Description copied from interface: WidgetController

Notifies all event acceptors which are registered for events with the context code context.

Specified by:

dispatchEvent in interface WidgetController

Specified by:

dispatchEvent in class AbstractWidgetController

Parameters:

context - event context

source - event source

data - parameters to be be passed to registered listeners

getBasketController

public BasketController getBasketController()

Description copied from interface: CheckoutController

Get the basket controller

Specified by:

getBasketController in interface CheckoutController

Returns:

the basket controller

setBasketController

public void setBasketController(BasketController basketController)

getCustomerController

public CustomerController getCustomerController()

Description copied from interface: CardPaymentController

Get the customer controller

Specified by:

getCustomerController in interface CardPaymentController

Returns:

the customer controller

placeOrder

public TypedObject placeOrder()
                       throws ValidationException

Description copied from interface: CheckoutController

Place the order.

Specified by:

placeOrder in interface CheckoutController

Returns:

the new order

Throws:

ValidationException - thrown if the order fails validation

createImpersonationContext

protected ImpersonationContext createImpersonationContext(CartModel cartModel)

getCartModel

protected CartModel getCartModel()

splitCartEntry

public boolean splitCartEntry(TypedObject cartEntry)
                       throws InvalidCartException

Description copied from interface: CheckoutController

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.

Specified by:

splitCartEntry in interface CheckoutController

Parameters:

cartEntry - the cart entry

Returns:

true if the cart entry has been split

Throws:

InvalidCartException - thrown on error

getFirstAvailableNamedDeliveryDate

public java.util.Date getFirstAvailableNamedDeliveryDate(TypedObject cartEntry)

Description copied from interface: CheckoutController

Get the first available named delivery date for the

Specified by:

getFirstAvailableNamedDeliveryDate in interface CheckoutController

Parameters:

cartEntry - the cart entry

Returns:

the earliest available delivery date for the cart entry

setNamedDeliveryDate

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

Description copied from interface: CheckoutController

Set the named delivery date on a cart entry

Specified by:

setNamedDeliveryDate in interface CheckoutController

Parameters:

cartEntry - the cart entry

date - the named delivery date

Returns:

true if the named delivery date has been changed

needPaymentOption

public boolean needPaymentOption()

Description copied from interface: CheckoutController

Does the cart require further payment.

Specified by:

needPaymentOption in interface CheckoutController

Returns:

true if the cart needs further payment

getSuggestedAmountForPaymentOption

public double getSuggestedAmountForPaymentOption()

Description copied from interface: CheckoutController

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

Specified by:

getSuggestedAmountForPaymentOption in interface CardPaymentController

Specified by:

getSuggestedAmountForPaymentOption in interface CheckoutController

Returns:

the outstanding payment amount

getValidPaymentTransactions

public java.util.List<TypedObject> getValidPaymentTransactions()

Description copied from interface: CheckoutController

Get the valid payment transactions for the cart

Specified by:

getValidPaymentTransactions in interface CheckoutController

Returns:

the list of payment transactions

canCreatePayments

public void canCreatePayments()
                       throws ValidationException

Description copied from interface: CheckoutController

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.

Specified by:

canCreatePayments in interface CheckoutController

Throws:

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

getTokenisedCreditCards

public java.util.List<TypedObject> getTokenisedCreditCards()

Description copied from interface: CheckoutController

Gets the list of tokenised credit cards of this customer

Specified by:

getTokenisedCreditCards in interface CheckoutController

Returns:

The list of tokenised credit cards

getPreviousPaymentInfos

public java.util.List<TypedObject> getPreviousPaymentInfos()

Description copied from interface: CardPaymentController

Get the list of available payment infos that can be used as templates for the card payment form.

Specified by:

getPreviousPaymentInfos in interface CardPaymentController

Returns:

list of previously used payment infos.

getCurrency

public TypedObject getCurrency()

Description copied from interface: CardPaymentController

Get the payment currency

Specified by:

getCurrency in interface CardPaymentController

Returns:

the payment currency

getDefaultPaymentAddress

public TypedObject getDefaultPaymentAddress()

Description copied from interface: CardPaymentController

Get the default payment address

Specified by:

getDefaultPaymentAddress in interface CardPaymentController

Returns:

the default payment address

getAvailableCartTypes

public java.util.List<CreditCardType> getAvailableCartTypes()

Description copied from interface: CardPaymentController

The list of available card types

Specified by:

getAvailableCartTypes in interface CardPaymentController

Returns:

the list of available card types

processPayment

public boolean processPayment(ObjectValueContainer paymentOptionValueContainer)
                       throws PaymentException,
                              ValidationException

Description copied from interface: CardPaymentController

Process the card payment

Specified by:

processPayment in interface CardPaymentController

Parameters:

paymentOptionValueContainer - the payment data

Returns:

true on success

Throws:

PaymentException - thrown when payment service fails

ValidationException - thrown if the payment data is invalid

processPayment

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

Specified by:

processPayment in interface CheckoutController

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

createPaymentOptionFrom

protected DefaultCheckoutController.PaymentOption createPaymentOptionFrom(ObjectValueContainer paymentOptionValueContainer)

createPaymentOption

protected DefaultCheckoutController.PaymentOption createPaymentOption()

populatePaymentOption

protected void populatePaymentOption(ObjectValueContainer paymentOptionValueContainer,
                                     DefaultCheckoutController.PaymentOption paymentOption)

pushProperties

protected void pushProperties(java.util.Map<java.lang.String,java.lang.Object> values,
                              java.lang.Object targetInstance)
                       throws java.beans.IntrospectionException,
                              java.lang.reflect.InvocationTargetException,
                              java.lang.IllegalAccessException

Throws:

java.beans.IntrospectionException

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException