de.hybris.platform.cscockpit.widgets.controllers

Interface BasketController

All Superinterfaces:

WidgetController

All Known Implementing Classes:

DefaultBasketController, DefaultSubscriptionBasketController

public interface BasketController
extends WidgetController

Interface for the basket controller

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BasketController.CartSummary Interface type returned by getCartSummary().

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 qty) Add product to the cart
void	cleanupAnonymousCart() Clear the agent's anonymous cart
void	clearCart() Clear the current cart
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
TypedObject	getCart() Get the current cart
TypedObject	getCartCurrency() Get the current cart's currency
BasketController.CartSummary	getCartSummary() Get summary and totals information for the current cart
WidgetBrowserModel	getCheckoutBrowser() Get the checkout browser
CheckoutController	getCheckoutController() Get the checkout controller
TypedObject	getDefaultDeliveryMode() Get the default delivery mode.
java.util.List<TypedObject>	getEntries() Get the cart entries
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.
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	setDeliveryAddress(TypedObject address) Set the delivery address for the cart
void	setPaymentAddress(TypedObject address) Set the payment address for the cart
void	setQuantity(TypedObject cartEntry, long qty) Change the quantity for a cart entry
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.

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

addCockpitEventAcceptor, dispatchEvent, removeCockpitEventAcceptor, setCockpitEventAcceptors

Method Detail

addToCart

void addToCart(TypedObject product,
               long qty)

Add product to the cart

Parameters:

product - the product to add

qty - the quantity of the product to add

setQuantity

void setQuantity(TypedObject cartEntry,
                 long qty)

Change the quantity for a cart entry

Parameters:

cartEntry - the cart entry

qty - the new quantity for the cart entry

getEntries

java.util.List<TypedObject> getEntries()

Get the cart entries

Returns:

a list of cart entries

getPromotionalCartLineItems

java.util.List<CartLineItem> getPromotionalCartLineItems()

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.

Returns:

the cart line items

getPotentialOrderPromotions

java.util.List<TypedObject> getPotentialOrderPromotions()

Get potential order level promotion results

Returns:

the list of potential order level promotion results

getAppliedOrderPromotions

java.util.List<TypedObject> getAppliedOrderPromotions()

Get the applied order level promotion results

Returns:

the list of applied order level promotion results

getCart

TypedObject getCart()

Get the current cart

Returns:

the cart

getCartSummary

BasketController.CartSummary getCartSummary()

Get summary and totals information for the current cart

Returns:

summary cart info

getCartCurrency

TypedObject getCartCurrency()

Get the current cart's currency

Returns:

the cart currency

setCartCurrency

boolean setCartCurrency(TypedObject currency)

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

Parameters:

currency - the new currency

Returns:

true if the currency has been changed

cleanupAnonymousCart

void cleanupAnonymousCart()

Clear the agent's anonymous cart

transferAnonymousCartToCustomer

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

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.

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

triggerCheckout

void triggerCheckout()
              throws ValidationException

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.

Throws:

ValidationException - thrown on validation error

setDeliveryAddress

void setDeliveryAddress(TypedObject address)

Set the delivery address for the cart

Parameters:

address - the delivery address

setPaymentAddress

void setPaymentAddress(TypedObject address)

Set the payment address for the cart

Parameters:

address - the payment address

setCartEntryDeliveryMode

boolean setCartEntryDeliveryMode(TypedObject cartEntry,
                                 TypedObject deliveryMode)

Set the delivery mode for a cart entry

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

boolean setCartEntryDeliveryAddress(TypedObject cartEntry,
                                    TypedObject deliveryAddress)

Set the delivery address for a cart entry

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

boolean setCartDeliveryMode(TypedObject cart,
                            TypedObject deliveryMode)

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

Parameters:

cart - the cart

deliveryMode - the delivery mode for the cart

Returns:

true if the cart's delivery mode has changed

getDefaultDeliveryMode

TypedObject getDefaultDeliveryMode()

Get the default delivery mode.

Returns:

the default delivery mode

getAvailableDeliveryModes

java.util.List<TypedObject> getAvailableDeliveryModes()

Get the available delivery modes for the current cart

Returns:

the list of available delivery modes

getAvailableDeliveryAddresses

java.util.List<TypedObject> getAvailableDeliveryAddresses()

Get the available delivery addresses for the current cart

Returns:

the list of available delivery addresses

clearCart

void clearCart()

Clear the current cart

activateAnonymousCartByCode

boolean activateAnonymousCartByCode(java.lang.String cartCode)

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

Parameters:

cartCode - the cart code used to lookup the cart

Returns:

true if the cart has been loaded

getCheckoutBrowser

WidgetBrowserModel getCheckoutBrowser()

Get the checkout browser

Returns:

the checkout browser

getCheckoutController

CheckoutController getCheckoutController()

Get the checkout controller

Returns:

the checkout controller