de.hybris.platform.cscockpit.widgets.controllers

Interface CallContextController

All Superinterfaces:

WidgetController

All Known Implementing Classes:

DefaultCallContextController

public interface CallContextController
extends WidgetController

Interface for the call context controller. The call context controller holds global session state for the loaded customer, order, and ticket.

Method Summary

Modifier and Type	Method and Description
boolean	endCall() End the current call.
<R,T extends Throwable> R	executeInContext(<any> wrapper) Execute the wrapper in the call centre context specified in context
String	getAnonymousCartCode() Get the cart code for the currently loaded anonymous cart.
TypedObject	getAnonymousCustomer() Get the anonymous customer
List<TypedObject>	getAvailableCurrencies() Get the available session currencies
List<TypedObject>	getAvailableSites()
TypedObject	getCallContextCurrency() Get the current call context currency.
TypedObject	getCurrentCustomer() Get the current customer
TypedObject	getCurrentOrder() Get the current order
TypedObject	getCurrentSite()
TypedObject	getCurrentTicket() Get the current ticket
boolean	isAnonymousCustomer(TypedObject customer) Test if a specified customer is the anonymous customer
void	setAnonymousCartCode(String cartCode) Set the current anonymous cart based on the specified cart code.
boolean	setCallContextCurrency(TypedObject currency) Set the current currency.
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.

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

addCockpitEventAcceptor, dispatchEvent, removeCockpitEventAcceptor, setCockpitEventAcceptors

Method Detail

getCurrentCustomer

TypedObject getCurrentCustomer()

Get the current customer

Returns:

the current customer

setCurrentCustomer

boolean setCurrentCustomer(TypedObject customer)

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

Parameters:

customer - the new customer

Returns:

true if the call context state has changed

getAnonymousCartCode

String getAnonymousCartCode()

Get the cart code for the currently loaded anonymous cart.

Returns:

the cart code

setAnonymousCartCode

void setAnonymousCartCode(String cartCode)

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.

Parameters:

cartCode - the cart code

getCurrentOrder

TypedObject getCurrentOrder()

Get the current order

Returns:

the current order

setCurrentOrder

boolean setCurrentOrder(TypedObject order)

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.

Parameters:

order - the order

Returns:

true if the call context state has changed

getCurrentTicket

TypedObject getCurrentTicket()

Get the current ticket

Returns:

the current ticket

setCurrentTicket

boolean setCurrentTicket(TypedObject ticket)

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

Parameters:

ticket - the ticket

Returns:

true if the call context state has changed

getAvailableCurrencies

List<TypedObject> getAvailableCurrencies()

Get the available session currencies

Returns:

the list of available session currencies

getCallContextCurrency

TypedObject getCallContextCurrency()

Get the current call context currency.

Returns:

the current currency

setCallContextCurrency

boolean setCallContextCurrency(TypedObject currency)

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

Parameters:

currency - the currency

Returns:

true if the call context state has changed

endCall

boolean endCall()

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

Returns:

true if the call context state has changed

executeInContext

<R,T extends Throwable> R executeInContext(<any> wrapper)
                                    throws T extends Throwable

Execute the wrapper in the call centre context specified in context

Parameters:

wrapper - The code to execute in that context

Returns:

The result of method being executed

Throws:

T - The exception

T extends Throwable

getAnonymousCustomer

TypedObject getAnonymousCustomer()

Get the anonymous customer

Returns:

the anonymous customer

isAnonymousCustomer

boolean isAnonymousCustomer(TypedObject customer)

Test if a specified customer is the anonymous customer

Parameters:

customer - the customer to test

Returns:

true if the customer is the anonymous customer

getAvailableSites

List<TypedObject> getAvailableSites()

getCurrentSite

TypedObject getCurrentSite()

setCurrentSite

boolean setCurrentSite(TypedObject baseSite)