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

Class DefaultBasketController

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.DefaultBasketController

All Implemented Interfaces:

WidgetController, BasketController

Direct Known Subclasses:

DefaultSubscriptionBasketController

public class DefaultBasketController
extends AbstractCallContextDependantController
implements BasketController

The default implementation of the BasketController interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultBasketController.DefaultCartSummary

Nested classes/interfaces inherited from interface de.hybris.platform.cscockpit.widgets.controllers.BasketController

BasketController.CartSummary

Field Summary

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

CONTROLLER_CONTEXT

Constructor Summary

Constructors

Constructor and Description
DefaultBasketController()

Method Summary

Modifier and Type	Method and Description
boolean	activateAnonymousCartByCode(java.lang.String cartCode) Find and load a cart owned by the anonymous customer for the given cart code.
void	addToCart(TypedObject product, long quantity) Add product to the cart
protected void	calculateCartInContext(CartModel cartModel)
void	cleanupAnonymousCart() Clear the agent's anonymous cart
void	clearCart() Clear the current cart
protected ImpersonationContext	createImpersonationContext(CartModel cartModel)
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.
protected CustomerModel	getAnonymousCustomer()
java.util.List<TypedObject>	getAppliedOrderPromotions() Get the applied order level promotion results
java.util.List<TypedObject>	getAvailableDeliveryAddresses() Get the available delivery addresses for the current cart
java.util.List<TypedObject>	getAvailableDeliveryModes() Get the available delivery modes for the current cart
protected BasketStrategy	getBasketStrategy()
TypedObject	getCart() Get the current cart
TypedObject	getCartCurrency() Get the current cart's currency
protected CartModel	getCartModel()
BasketController.CartSummary	getCartSummary() Get summary and totals information for the current cart
WidgetBrowserModel	getCheckoutBrowser() Get the checkout browser
protected java.lang.String	getCheckoutBrowserDefaultWidgetCode()
CheckoutController	getCheckoutController() Get the checkout controller
protected CommerceCartService	getCommerceCartService()
protected CommerceCheckoutService	getCommerceCheckoutService()
protected CommonI18NService	getCommonI18NService()
protected CsCheckoutService	getCsCheckoutService()
protected CsPromotionService	getCsPromotionService()
protected CustomerAccountService	getCustomerAccountService()
TypedObject	getDefaultDeliveryMode() Get the default delivery mode.
protected DeliveryService	getDeliveryService()
java.util.List<TypedObject>	getEntries() Get the cart entries
protected FormatFactory	getFormatFactory()
protected ImpersonationService	getImpersonationService()
java.util.List<TypedObject>	getPotentialOrderPromotions() Get potential order level promotion results
java.util.List<CartLineItem>	getPromotionalCartLineItems() Get the cart lines as cart line item wrappers.
protected SessionService	getSessionService()
protected UserService	getUserService()
protected WidgetHelper	getWidgetHelper()
protected WidgetBrowserModel	lookupCheckoutBrowser() Must be overwritten! Use <lookup-method> in spring.
protected CheckoutController	lookupCheckoutController() Must be overridden! Use <lookup-method> in spring.
void	setBasketStrategy(BasketStrategy basketStrategy)
boolean	setCartCurrency(TypedObject currency) Change the cart's currency.
boolean	setCartDeliveryMode(TypedObject cart, TypedObject deliveryMode) Set the delivery mode for the whole cart.
boolean	setCartEntryDeliveryAddress(TypedObject cartEntry, TypedObject deliveryAddress) Set the delivery address for a cart entry
boolean	setCartEntryDeliveryMode(TypedObject cartEntry, TypedObject deliveryMode) Set the delivery mode for a cart entry
void	setCheckoutBrowserDefaultWidgetCode(java.lang.String checkoutBrowserDefaultWidgetCode)
void	setCommerceCartService(CommerceCartService commerceCartService)
void	setCommerceCheckoutService(CommerceCheckoutService commerceCheckoutService)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setCsCheckoutService(CsCheckoutService csCheckoutService)
void	setCsPromotionService(CsPromotionService csPromotionService)
void	setCustomerAccountService(CustomerAccountService customerAccountService)
void	setDeliveryAddress(TypedObject address) Set the delivery address for the cart
protected boolean	setDeliveryAddressIfAvailable(CartModel cart)
protected boolean	setDeliveryModeIfAvailable(CartModel cart)
void	setDeliveryService(DeliveryService deliveryService)
void	setFormatFactory(FormatFactory formatFactory)
void	setImpersonationService(ImpersonationService impersonationService)
void	setPaymentAddress(TypedObject address) Set the payment address for the cart
protected boolean	setPaymentAddressIfAvailable(CartModel cart)
void	setQuantity(TypedObject cartEntry, long quantity) Change the quantity for a cart entry
void	setSessionService(SessionService sessionService)
void	setUserService(UserService userService)
void	setWidgetHelper(WidgetHelper widgetHelper)
boolean	transferAnonymousCartToCustomer(java.lang.String cartCode, TypedObject customer) Transfer the current anonymous cart to the specified customer.
void	triggerCheckout() Begins the checkout flow for the current cart.
protected void	validateBasketReadyForCheckout(CartModel cart)

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

DefaultBasketController

public DefaultBasketController()

Method Detail

getWidgetHelper

protected WidgetHelper getWidgetHelper()

setWidgetHelper

public void setWidgetHelper(WidgetHelper widgetHelper)

getCsCheckoutService

protected CsCheckoutService getCsCheckoutService()

setCsCheckoutService

public void setCsCheckoutService(CsCheckoutService csCheckoutService)

getCheckoutBrowserDefaultWidgetCode

protected java.lang.String getCheckoutBrowserDefaultWidgetCode()

setCheckoutBrowserDefaultWidgetCode

public void setCheckoutBrowserDefaultWidgetCode(java.lang.String checkoutBrowserDefaultWidgetCode)

getCsPromotionService

protected CsPromotionService getCsPromotionService()

setCsPromotionService

public void setCsPromotionService(CsPromotionService csPromotionService)

getCheckoutBrowser

public WidgetBrowserModel getCheckoutBrowser()

Description copied from interface: BasketController

Get the checkout browser

Specified by:

getCheckoutBrowser in interface BasketController

Returns:

the checkout browser

lookupCheckoutBrowser

protected WidgetBrowserModel lookupCheckoutBrowser()

Must be overwritten! Use <lookup-method> in spring.

Returns:

The injected CheckoutBrowserModel

getCommerceCartService

protected CommerceCartService getCommerceCartService()

setCommerceCartService

public void setCommerceCartService(CommerceCartService commerceCartService)

getCustomerAccountService

protected CustomerAccountService getCustomerAccountService()

setCustomerAccountService

public void setCustomerAccountService(CustomerAccountService customerAccountService)

getBasketStrategy

protected BasketStrategy getBasketStrategy()

setBasketStrategy

public void setBasketStrategy(BasketStrategy basketStrategy)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getSessionService

protected SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getUserService

protected UserService getUserService()

setUserService

public void setUserService(UserService userService)

getFormatFactory

protected FormatFactory getFormatFactory()

setFormatFactory

public void setFormatFactory(FormatFactory formatFactory)

getDeliveryService

protected DeliveryService getDeliveryService()

setDeliveryService

public void setDeliveryService(DeliveryService deliveryService)

getCommerceCheckoutService

protected CommerceCheckoutService getCommerceCheckoutService()

setCommerceCheckoutService

public void setCommerceCheckoutService(CommerceCheckoutService commerceCheckoutService)

getImpersonationService

protected ImpersonationService getImpersonationService()

setImpersonationService

public void setImpersonationService(ImpersonationService impersonationService)

getCheckoutController

public CheckoutController getCheckoutController()

Description copied from interface: BasketController

Get the checkout controller

Specified by:

getCheckoutController in interface BasketController

Returns:

the checkout controller

lookupCheckoutController

protected CheckoutController lookupCheckoutController()

Must be overridden! Use <lookup-method> in spring.

Returns:

The CheckoutController

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

addToCart

public void addToCart(TypedObject product,
                      long quantity)

Description copied from interface: BasketController

Add product to the cart

Specified by:

addToCart in interface BasketController

Parameters:

product - the product to add

quantity - the quantity of the product to add

getEntries

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

Description copied from interface: BasketController

Get the cart entries

Specified by:

getEntries in interface BasketController

Returns:

a list of cart entries

getPromotionalCartLineItems

public java.util.List<CartLineItem> getPromotionalCartLineItems()

Description copied from interface: BasketController

Get the cart lines as cart line item wrappers. These cart line item wrappers support splitting the cart entries by applied promotion and also include information on the potential promotions.

Specified by:

getPromotionalCartLineItems in interface BasketController

Returns:

the cart line items

getPotentialOrderPromotions

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

Description copied from interface: BasketController

Get potential order level promotion results

Specified by:

getPotentialOrderPromotions in interface BasketController

Returns:

the list of potential order level promotion results

getAppliedOrderPromotions

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

Description copied from interface: BasketController

Get the applied order level promotion results

Specified by:

getAppliedOrderPromotions in interface BasketController

Returns:

the list of applied order level promotion results

getCart

public TypedObject getCart()

Description copied from interface: BasketController

Get the current cart

Specified by:

getCart in interface BasketController

Returns:

the cart

cleanupAnonymousCart

public void cleanupAnonymousCart()

Description copied from interface: BasketController

Clear the agent's anonymous cart

Specified by:

cleanupAnonymousCart in interface BasketController

transferAnonymousCartToCustomer

public boolean transferAnonymousCartToCustomer(java.lang.String cartCode,
                                               TypedObject customer)

Description copied from interface: BasketController

Transfer the current anonymous cart to the specified customer. The cart will be owned by the customer. After the transfer the cart is recalculated in the context of the new owner.

Specified by:

transferAnonymousCartToCustomer in interface BasketController

Parameters:

cartCode - the code of the anonymous cart to transfer

customer - the customer that the cart is transferred to

Returns:

true if the cart is transferred

getCartModel

protected CartModel getCartModel()

setQuantity

public void setQuantity(TypedObject cartEntry,
                        long quantity)

Description copied from interface: BasketController

Change the quantity for a cart entry

Specified by:

setQuantity in interface BasketController

Parameters:

cartEntry - the cart entry

quantity - the new quantity for the cart entry

setDeliveryAddress

public void setDeliveryAddress(TypedObject address)

Description copied from interface: BasketController

Set the delivery address for the cart

Specified by:

setDeliveryAddress in interface BasketController

Parameters:

address - the delivery address

setPaymentAddress

public void setPaymentAddress(TypedObject address)

Description copied from interface: BasketController

Set the payment address for the cart

Specified by:

setPaymentAddress in interface BasketController

Parameters:

address - the payment address

getCartSummary

public BasketController.CartSummary getCartSummary()

Description copied from interface: BasketController

Get summary and totals information for the current cart

Specified by:

getCartSummary in interface BasketController

Returns:

summary cart info

getCartCurrency

public TypedObject getCartCurrency()

Description copied from interface: BasketController

Get the current cart's currency

Specified by:

getCartCurrency in interface BasketController

Returns:

the cart currency

setCartCurrency

public boolean setCartCurrency(TypedObject currency)

Description copied from interface: BasketController

Change the cart's currency. Recalculates the cart using the new currency.

Specified by:

setCartCurrency in interface BasketController

Parameters:

currency - the new currency

Returns:

true if the currency has been changed

triggerCheckout

public void triggerCheckout()
                     throws ValidationException

Description copied from interface: BasketController

Begins the checkout flow for the current cart. Validates that the cart is ready to begin checkout. Opens the checkout browser and gives focus to the appropriate widgets.

Specified by:

triggerCheckout in interface BasketController

Throws:

ValidationException - thrown on validation error

validateBasketReadyForCheckout

protected void validateBasketReadyForCheckout(CartModel cart)
                                       throws ValidationException

Throws:

ValidationException

setDeliveryAddressIfAvailable

protected boolean setDeliveryAddressIfAvailable(CartModel cart)

setDeliveryModeIfAvailable

protected boolean setDeliveryModeIfAvailable(CartModel cart)

setPaymentAddressIfAvailable

protected boolean setPaymentAddressIfAvailable(CartModel cart)

getAnonymousCustomer

protected CustomerModel getAnonymousCustomer()

setCartEntryDeliveryMode

public boolean setCartEntryDeliveryMode(TypedObject cartEntry,
                                        TypedObject deliveryMode)

Description copied from interface: BasketController

Set the delivery mode for a cart entry

Specified by:

setCartEntryDeliveryMode in interface BasketController

Parameters:

cartEntry - the cart entry

deliveryMode - the delivery mode to set, set to null to clear

Returns:

true if the line's delivery mode has changed

setCartEntryDeliveryAddress

public boolean setCartEntryDeliveryAddress(TypedObject cartEntry,
                                           TypedObject deliveryAddress)

Description copied from interface: BasketController

Set the delivery address for a cart entry

Specified by:

setCartEntryDeliveryAddress in interface BasketController

Parameters:

cartEntry - the cart entry

deliveryAddress - the delivery address to set, set to null to clear.

Returns:

true if the line's deliver address has changed

setCartDeliveryMode

public boolean setCartDeliveryMode(TypedObject cart,
                                   TypedObject deliveryMode)

Description copied from interface: BasketController

Set the delivery mode for the whole cart. This applies to cart entries that do not have a specific delivery mode set.

Specified by:

setCartDeliveryMode in interface BasketController

Parameters:

cart - the cart

deliveryMode - the delivery mode for the cart

Returns:

true if the cart's delivery mode has changed

getDefaultDeliveryMode

public TypedObject getDefaultDeliveryMode()

Description copied from interface: BasketController

Get the default delivery mode.

Specified by:

getDefaultDeliveryMode in interface BasketController

Returns:

the default delivery mode

getAvailableDeliveryModes

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

Description copied from interface: BasketController

Get the available delivery modes for the current cart

Specified by:

getAvailableDeliveryModes in interface BasketController

Returns:

the list of available delivery modes

getAvailableDeliveryAddresses

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

Description copied from interface: BasketController

Get the available delivery addresses for the current cart

Specified by:

getAvailableDeliveryAddresses in interface BasketController

Returns:

the list of available delivery addresses

calculateCartInContext

protected void calculateCartInContext(CartModel cartModel)

createImpersonationContext

protected ImpersonationContext createImpersonationContext(CartModel cartModel)

clearCart

public void clearCart()

Description copied from interface: BasketController

Clear the current cart

Specified by:

clearCart in interface BasketController

activateAnonymousCartByCode

public boolean activateAnonymousCartByCode(java.lang.String cartCode)

Description copied from interface: BasketController

Find and load a cart owned by the anonymous customer for the given cart code.

Specified by:

activateAnonymousCartByCode in interface BasketController

Parameters:

cartCode - the cart code used to lookup the cart

Returns:

true if the cart has been loaded