de.hybris.platform.cockpit.widgets.controllers

Interface WidgetController

All Known Subinterfaces:

BasketController, CallContextController, CancellationController, CardPaymentController, CheckoutController, CustomerController, CustomerCreateController, FacetedPageableSearchResults, OrderController, OrderFraudController, OrderManagementActionsWidgetController, PageableSearchResults, ReturnsController, SearchCommandController<SC>, TicketController

All Known Implementing Classes:

AbstractCallContextDependantController, AbstractCsWidgetController, AbstractWidgetController, DefaultBasketController, DefaultCallContextController, DefaultCancellationController, DefaultCheckoutController, DefaultCustomerCreateController, DefaultOrderController, DefaultOrderFraudController, DefaultOrderManagementActionsWidgetController, DefaultReturnsController, DefaultSearchCommandController, DefaultSubscriptionBasketController, DefaultSubscriptionCheckoutController, DefaultTicketController

public interface WidgetController

Controller used by Cockpit Widget components.

A WidgetController typically acts as a conventional controller as well as a Publish-Subscribe-Channel used for inter-widget communication. A widget controller is typically a Spring bean defined in the session scope.

See Also:

Widget, WidgetAdapter

Method Summary

Modifier and Type	Method and Description
void	addCockpitEventAcceptor(String context, CockpitEventAcceptor acceptor) Registers the event acceptor acceptor so that it receives notifications when an event with the matching context context is dispatched.
void	dispatchEvent(String context, Object source, Map<String,Object> params) Notifies all event acceptors which are registered for events with the context code context.
void	removeCockpitEventAcceptor(String context, CockpitEventAcceptor acceptor) Unregisters the event acceptor acceptor for events with the specified context code context .
void	setCockpitEventAcceptors(Map<String,List<CockpitEventAcceptor>> acceptorMap) Sets the event acceptors to register with this controller.

Method Detail

addCockpitEventAcceptor

void addCockpitEventAcceptor(String context,
                             CockpitEventAcceptor acceptor)

Registers the event acceptor acceptor so that it receives notifications when an event with the matching context context is dispatched.

Parameters:

context - event context

acceptor - event acceptor

removeCockpitEventAcceptor

void removeCockpitEventAcceptor(String context,
                                CockpitEventAcceptor acceptor)

Unregisters the event acceptor acceptor for events with the specified context code context .

Parameters:

context - event context

acceptor - event acceptor

setCockpitEventAcceptors

void setCockpitEventAcceptors(Map<String,List<CockpitEventAcceptor>> acceptorMap)

Sets the event acceptors to register with this controller.

Parameters:

acceptorMap - acceptor map where the key is the controller context code and the value a list of acceptors

dispatchEvent

void dispatchEvent(String context,
                   Object source,
                   Map<String,Object> params)

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

Parameters:

context - event context

source - event source

params - parameters to be be passed to registered listeners