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

Class DefaultCallContextController

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

All Implemented Interfaces:

WidgetController, CallContextController, CustomerController

public class DefaultCallContextController
extends AbstractCsWidgetController
implements CallContextController, CustomerController

The default implementation of the CallContextController interface.

Field Summary

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

CONTROLLER_CONTEXT

Constructor Summary

Constructors

Constructor and Description
DefaultCallContextController()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	clearCallContextCurrency()
protected void	clearCurrentCustomer()
protected void	clearCurrentOrder()
protected void	clearCurrentTicket()
protected void	clearImpersonationContextChanged()
protected boolean	compare(java.lang.Object instance1, java.lang.Object instance2)
TypedObject	createNewCustomerAddress(ObjectValueContainer addressContainer, java.lang.String addressTypeCode) Create a new customer address
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.
boolean	endCall() End the current call.
<R,T extends java.lang.Throwable> R	executeInContext(ImpersonationService.Executor<R,T> wrapper) Execute the wrapper in the call centre context specified in context
protected java.util.List<CreditCardPaymentInfoModel>	filterOutInvalidTokenisedCreditCards(java.util.List<CreditCardPaymentInfoModel> savedCards)
java.lang.String	getAnonymousCartCode() Get the cart code for the currently loaded anonymous cart.
TypedObject	getAnonymousCustomer() Get the anonymous customer
java.util.List<TypedObject>	getAvailableCurrencies() Get the available session currencies
java.util.List<TypedObject>	getAvailableSites()
BaseSiteService	getBaseSiteService()
protected BasketController	getBasketController()
protected BeanFactory	getBeanFactory()
protected WidgetBrowserModel	getBrowserToSwitchOnEndCall()
TypedObject	getCallContextCurrency() Get the current call context currency.
protected CommerceCommonI18NService	getCommerceCommonI18NService()
protected CommonI18NService	getCommonI18NService()
TypedObject	getCurrentCustomer() Get the current customer
protected CustomerModel	getCurrentCustomerModelOrAnonymousModel()
protected Customer	getCurrentCustomerOrAnonymous() Deprecated. since ages use getCurrentCustomerModelOrAnonymousModel instead
TypedObject	getCurrentOrder() Get the current order
TypedObject	getCurrentSite()
TypedObject	getCurrentTicket() Get the current ticket
protected CustomerAccountService	getCustomerAccountService()
java.util.List<TypedObject>	getCustomerAddresses() Get the list of addresses for the customer
java.util.List<TypedObject>	getCustomerOrders() Get the customers list of historic orders
protected CustomerOrdersStrategy	getCustomerOrdersStrategy()
java.util.List<TypedObject>	getCustomerTickets() Gets the list of tickets associated with this customer
protected java.util.Collection<AbstractCallContextDependantController>	getDependantControllers() Lookup the CallContext dependant controllers by asking the spring bean factory for all beans defined of that type.
protected ImpersonationService	getImpersonationService()
protected NewItemService	getNewItemService()
protected PropertyDescriptor	getPropertyDescriptor(java.util.Set<PropertyDescriptor> properties, java.lang.String qualifier)
protected CurrencyModel	getSiteDefaultCurrency()
protected TicketStrategy	getTicketStrategy()
CommentTypeModel	getTicketType(java.lang.String ticketType)
java.util.List<TypedObject>	getTokenisedCreditCards() Gets the list of tokenised credit cards of this customer
protected UserService	getUserService()
protected WidgetHelper	getWidgetHelper()
protected java.lang.String	getWidgetToFocusOnEndCall()
protected boolean	hasProperCurrency()
protected void	initialiseCurrentSite()
boolean	isAnonymousCustomer(TypedObject customer) Test if a specified customer is the anonymous customer
protected boolean	isAnonymousCustomerCart(TypedObject cartObject)
protected boolean	isImpersonationContextChanged()
protected boolean	isValidSite(BaseSiteModel baseSite)
protected WidgetBrowserModel	lookupBrowserToSwitchOnEndCall() Must be overwritten! Use <lookup-method> in spring.
void	removeCustomerAddress(TypedObject address) Delete a customer address
void	setAnonymousCartCode(java.lang.String anonymousCartCode) Set the current anonymous cart based on the specified cart code.
void	setBaseSiteService(BaseSiteService baseSiteService)
void	setBasketController(BasketController basketController)
void	setBeanFactory(BeanFactory beanFactory)
boolean	setCallContextCurrency(TypedObject currency) Set the current currency.
void	setCommerceCommonI18NService(CommerceCommonI18NService commerceCommonI18NService)
void	setCommonI18NService(CommonI18NService commonI18NService)
boolean	setCurrentCustomer(TypedObject customer) Set the current customer.
boolean	setCurrentOrder(TypedObject order) Set the current order in the call context.
boolean	setCurrentSite(TypedObject baseSite)
boolean	setCurrentTicket(TypedObject ticket) Set the current ticket in the call context.
void	setCustomerAccountService(CustomerAccountService customerAccountService)
void	setCustomerOrdersStrategy(CustomerOrdersStrategy customerOrdersStrategy)
boolean	setDefaultShipmentAddress(TypedObject address) Set the customer's default shipment address
protected void	setImpersonationContextChanged()
void	setImpersonationService(ImpersonationService impersonationService)
void	setNewItemService(NewItemService newItemService)
void	setTicketStrategy(TicketStrategy ticketStrategy)
void	setUserService(UserService userService)
void	setWidgetHelper(WidgetHelper widgetHelper)
void	setWidgetToFocusOnEndCall(java.lang.String widgetToFocusOnEndCall)
protected void	transferAnonymousCartToCustomer(TypedObject customer)

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

DefaultCallContextController

public DefaultCallContextController()

Method Detail

getWidgetHelper

protected WidgetHelper getWidgetHelper()

setWidgetHelper

public void setWidgetHelper(WidgetHelper widgetHelper)

getImpersonationService

protected ImpersonationService getImpersonationService()

setImpersonationService

public void setImpersonationService(ImpersonationService impersonationService)

getWidgetToFocusOnEndCall

protected java.lang.String getWidgetToFocusOnEndCall()

setWidgetToFocusOnEndCall

public void setWidgetToFocusOnEndCall(java.lang.String widgetToFocusOnEndCall)

getBrowserToSwitchOnEndCall

protected WidgetBrowserModel getBrowserToSwitchOnEndCall()

lookupBrowserToSwitchOnEndCall

protected WidgetBrowserModel lookupBrowserToSwitchOnEndCall()

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

Returns:

The WidgetBrowserModel to show when end call button is pressed

getBasketController

protected BasketController getBasketController()

setBasketController

public void setBasketController(BasketController basketController)

getCustomerOrdersStrategy

protected CustomerOrdersStrategy getCustomerOrdersStrategy()

setCustomerOrdersStrategy

public void setCustomerOrdersStrategy(CustomerOrdersStrategy customerOrdersStrategy)

getTicketStrategy

protected TicketStrategy getTicketStrategy()

setTicketStrategy

public void setTicketStrategy(TicketStrategy ticketStrategy)

getUserService

protected UserService getUserService()

setUserService

public void setUserService(UserService userService)

getCustomerAccountService

protected CustomerAccountService getCustomerAccountService()

setCustomerAccountService

public void setCustomerAccountService(CustomerAccountService customerAccountService)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getCommerceCommonI18NService

protected CommerceCommonI18NService getCommerceCommonI18NService()

setCommerceCommonI18NService

public void setCommerceCommonI18NService(CommerceCommonI18NService commerceCommonI18NService)

getBeanFactory

protected BeanFactory getBeanFactory()

getBaseSiteService

public BaseSiteService getBaseSiteService()

setBaseSiteService

public void setBaseSiteService(BaseSiteService baseSiteService)

getNewItemService

protected NewItemService getNewItemService()

setNewItemService

public void setNewItemService(NewItemService newItemService)

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Throws:

BeansException

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

getCurrentCustomer

public TypedObject getCurrentCustomer()

Description copied from interface: CallContextController

Get the current customer

Specified by:

getCurrentCustomer in interface CallContextController

Specified by:

getCurrentCustomer in interface CustomerController

Returns:

the current customer

getAnonymousCustomer

public TypedObject getAnonymousCustomer()

Description copied from interface: CallContextController

Get the anonymous customer

Specified by:

getAnonymousCustomer in interface CallContextController

Returns:

the anonymous customer

isAnonymousCustomer

public boolean isAnonymousCustomer(TypedObject customer)

Description copied from interface: CallContextController

Test if a specified customer is the anonymous customer

Specified by:

isAnonymousCustomer in interface CallContextController

Parameters:

customer - the customer to test

Returns:

true if the customer is the anonymous customer

getAnonymousCartCode

public java.lang.String getAnonymousCartCode()

Description copied from interface: CallContextController

Get the cart code for the currently loaded anonymous cart.

Specified by:

getAnonymousCartCode in interface CallContextController

Returns:

the cart code

setAnonymousCartCode

public void setAnonymousCartCode(java.lang.String anonymousCartCode)

Description copied from interface: CallContextController

Set the current anonymous cart based on the specified cart code. The cart it looked up with the cart code specified and must be owned by the anonymous customer. If a cart is found it is loaded in to the call context.

Specified by:

setAnonymousCartCode in interface CallContextController

Parameters:

anonymousCartCode - the cart code

transferAnonymousCartToCustomer

protected void transferAnonymousCartToCustomer(TypedObject customer)

setCurrentCustomer

public boolean setCurrentCustomer(TypedObject customer)

Description copied from interface: CallContextController

Set the current customer. Changing the current customer will also clear any loaded order or ticket unless these are associated with the new customer.

Specified by:

setCurrentCustomer in interface CallContextController

Parameters:

customer - the new customer

Returns:

true if the call context state has changed

clearCurrentCustomer

protected void clearCurrentCustomer()

setDefaultShipmentAddress

public boolean setDefaultShipmentAddress(TypedObject address)

Description copied from interface: CustomerController

Set the customer's default shipment address

Specified by:

setDefaultShipmentAddress in interface CustomerController

Parameters:

address - The address to set as the default shipment address

Returns:

true if the address has changed

getCurrentOrder

public TypedObject getCurrentOrder()

Description copied from interface: CallContextController

Get the current order

Specified by:

getCurrentOrder in interface CallContextController

Returns:

the current order

setCurrentOrder

public boolean setCurrentOrder(TypedObject order)

Description copied from interface: CallContextController

Set the current order in the call context. Changing the current order may clear the tickets loaded and will load the customer for the order into the call context.

Specified by:

setCurrentOrder in interface CallContextController

Parameters:

order - the order

Returns:

true if the call context state has changed

clearCurrentOrder

protected void clearCurrentOrder()

getCurrentTicket

public TypedObject getCurrentTicket()

Description copied from interface: CallContextController

Get the current ticket

Specified by:

getCurrentTicket in interface CallContextController

Returns:

the current ticket

setCurrentTicket

public boolean setCurrentTicket(TypedObject ticket)

Description copied from interface: CallContextController

Set the current ticket in the call context. Changing the ticket may clear the current order

Specified by:

setCurrentTicket in interface CallContextController

Parameters:

ticket - the ticket

Returns:

true if the call context state has changed

clearCurrentTicket

protected void clearCurrentTicket()

removeCustomerAddress

public void removeCustomerAddress(TypedObject address)

Description copied from interface: CustomerController

Delete a customer address

Specified by:

removeCustomerAddress in interface CustomerController

Parameters:

address - The address to delete

getCustomerOrders

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

Description copied from interface: CustomerController

Get the customers list of historic orders

Specified by:

getCustomerOrders in interface CustomerController

Returns:

The list of orders

getTokenisedCreditCards

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

Description copied from interface: CustomerController

Gets the list of tokenised credit cards of this customer

Specified by:

getTokenisedCreditCards in interface CustomerController

Returns:

The list of tokenised credit cards

filterOutInvalidTokenisedCreditCards

protected java.util.List<CreditCardPaymentInfoModel> filterOutInvalidTokenisedCreditCards(java.util.List<CreditCardPaymentInfoModel> savedCards)

getCustomerTickets

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

Description copied from interface: CustomerController

Gets the list of tickets associated with this customer

Specified by:

getCustomerTickets in interface CustomerController

Returns:

The list of tickets

getTicketType

public CommentTypeModel getTicketType(java.lang.String ticketType)

getCustomerAddresses

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

Description copied from interface: CustomerController

Get the list of addresses for the customer

Specified by:

getCustomerAddresses in interface CustomerController

Returns:

The list of addresses

executeInContext

public <R,T extends java.lang.Throwable> R executeInContext(ImpersonationService.Executor<R,T> wrapper)
                                                     throws T extends java.lang.Throwable

Description copied from interface: CallContextController

Execute the wrapper in the call centre context specified in context

Specified by:

executeInContext in interface CallContextController

Parameters:

wrapper - The code to execute in that context

Returns:

The result of method being executed

Throws:

T - The exception

T extends java.lang.Throwable

getAvailableCurrencies

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

Description copied from interface: CallContextController

Get the available session currencies

Specified by:

getAvailableCurrencies in interface CallContextController

Returns:

the list of available session currencies

getCurrentCustomerModelOrAnonymousModel

protected CustomerModel getCurrentCustomerModelOrAnonymousModel()

getCurrentCustomerOrAnonymous

@Deprecated
protected Customer getCurrentCustomerOrAnonymous()

Deprecated. since ages use getCurrentCustomerModelOrAnonymousModel instead

isAnonymousCustomerCart

protected boolean isAnonymousCustomerCart(TypedObject cartObject)

compare

protected boolean compare(java.lang.Object instance1,
                          java.lang.Object instance2)

endCall

public boolean endCall()

Description copied from interface: CallContextController

End the current call. Clear all the call context state.

Specified by:

endCall in interface CallContextController

Returns:

true if the call context state has changed

hasProperCurrency

protected boolean hasProperCurrency()

getCallContextCurrency

public TypedObject getCallContextCurrency()

Description copied from interface: CallContextController

Get the current call context currency.

Specified by:

getCallContextCurrency in interface CallContextController

Returns:

the current currency

setCallContextCurrency

public boolean setCallContextCurrency(TypedObject currency)

Description copied from interface: CallContextController

Set the current currency. The call context currency is used to control the currency shown in the product search results.

Specified by:

setCallContextCurrency in interface CallContextController

Parameters:

currency - the currency

Returns:

true if the call context state has changed

clearCallContextCurrency

protected void clearCallContextCurrency()

createNewCustomerAddress

public TypedObject createNewCustomerAddress(ObjectValueContainer addressContainer,
                                            java.lang.String addressTypeCode)
                                     throws ValueHandlerException

Description copied from interface: CustomerController

Create a new customer address

Specified by:

createNewCustomerAddress in interface CustomerController

Parameters:

addressContainer - The value container

addressTypeCode - The object template type code

Returns:

The newly created address

Throws:

ValueHandlerException - If the address cannot be created

getAvailableSites

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

Specified by:

getAvailableSites in interface CallContextController

isValidSite

protected boolean isValidSite(BaseSiteModel baseSite)

initialiseCurrentSite

protected void initialiseCurrentSite()

getCurrentSite

public TypedObject getCurrentSite()

Specified by:

getCurrentSite in interface CallContextController

setCurrentSite

public boolean setCurrentSite(TypedObject baseSite)

Specified by:

setCurrentSite in interface CallContextController

getSiteDefaultCurrency

protected CurrencyModel getSiteDefaultCurrency()

getPropertyDescriptor

protected PropertyDescriptor getPropertyDescriptor(java.util.Set<PropertyDescriptor> properties,
                                                   java.lang.String qualifier)

setImpersonationContextChanged

protected void setImpersonationContextChanged()

isImpersonationContextChanged

protected boolean isImpersonationContextChanged()

clearImpersonationContextChanged

protected void clearImpersonationContextChanged()

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Throws:

java.lang.Exception

getDependantControllers

protected java.util.Collection<AbstractCallContextDependantController> getDependantControllers()

Lookup the CallContext dependant controllers by asking the spring bean factory for all beans defined of that type.

Returns:

the collection of AbstractCallContextDependantController controller beans