com.hybris.cockpitng.events.impl

Class DefaultCockpitEventQueue

java.lang.Object

com.hybris.cockpitng.events.impl.DefaultCockpitEventQueue

All Implemented Interfaces:

CockpitEventQueue

public class DefaultCockpitEventQueue
extends Object
implements CockpitEventQueue

Constructor Summary

Constructors

Constructor and Description
DefaultCockpitEventQueue()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkScope(ScopeContext currentContext, ListenerInfo listenerInfo)
List<CockpitEvent>	fetchEvents(String widgetID) Returns all events available for the specified widget and removes them from the queue.
protected ScopeContext	getCurrentScopeContext()
void	publishEvent(CockpitEvent event) Adds an event to the event queue.
void	registerListener(String widgetID, String eventName, String scope) Registers the widget as a listener for the specified event.
void	removeListener(String widgetID) Remove the specified widget from the set of listeners.
void	setCockpitUserService(CockpitUserService cockpitUserService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCockpitEventQueue

public DefaultCockpitEventQueue()

Method Detail

publishEvent

public void publishEvent(CockpitEvent event)

Description copied from interface: CockpitEventQueue

Adds an event to the event queue.

Specified by:

publishEvent in interface CockpitEventQueue

Parameters:

event - The event to publish.

checkScope

protected boolean checkScope(ScopeContext currentContext,
                             ListenerInfo listenerInfo)

getCurrentScopeContext

protected ScopeContext getCurrentScopeContext()

fetchEvents

public List<CockpitEvent> fetchEvents(String widgetID)

Description copied from interface: CockpitEventQueue

Returns all events available for the specified widget and removes them from the queue.

Specified by:

fetchEvents in interface CockpitEventQueue

Parameters:

widgetID - The widget for which the events should be fetched.

Returns:

The events being published since the last call of this method or an empty list, if the widget has not been registered.

registerListener

public void registerListener(String widgetID,
                             String eventName,
                             String scope)

Description copied from interface: CockpitEventQueue

Registers the widget as a listener for the specified event.

Specified by:

registerListener in interface CockpitEventQueue

Parameters:

widgetID - A string that represents the widget.

eventName - A string that defines the event.

removeListener

public void removeListener(String widgetID)

Description copied from interface: CockpitEventQueue

Remove the specified widget from the set of listeners. If the widget is not registered, this method does nothing.

Specified by:

removeListener in interface CockpitEventQueue

Parameters:

widgetID - The widget to remove from the listeners.

setCockpitUserService

public void setCockpitUserService(CockpitUserService cockpitUserService)