com.hybris.backoffice.widgets.notificationarea

Class DefaultNotificationService

java.lang.Object

com.hybris.backoffice.widgets.notificationarea.DefaultNotificationService

All Implemented Interfaces:

NotificationService

public class DefaultNotificationService
extends Object
implements NotificationService

Service responsible for sending user notifications. It uses NotificationEvent to publish notifications and ClearNotificationsEvent to clear them.

Constructor Summary

Constructors

Constructor and Description
DefaultNotificationService()

Method Summary

Modifier and Type	Method and Description
void	clearNotifications(String source) Sends clear event which will remove all notifications from specified source.
void	clearNotifications(String source, NotificationEvent.Level level) Sends clear event which will remove all notifications from specified source of specified importance level.
String	getWidgetNotificationSource(ActionContext<?> context) Gets default source for each notification sent by specified action.
String	getWidgetNotificationSource(WidgetInstanceManager widgetInstanceManager) Gets default source for each notification sent by specified widget.
void	notifyUser(String source, String eventType, NotificationEvent.Level level, Object... referenceObjects) Sends a notification to end user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.backoffice.widgets.notificationarea.NotificationService

notifyUser, notifyUser

Constructor Detail

DefaultNotificationService

public DefaultNotificationService()

Method Detail

notifyUser

public void notifyUser(String source,
                       String eventType,
                       NotificationEvent.Level level,
                       Object... referenceObjects)

Description copied from interface: NotificationService

Sends a notification to end user.

Specified by:

notifyUser in interface NotificationService

Parameters:

source - identity of notification source.

eventType - type of notification to be sent NotificationEventTypes.

level - importance level of notification.

referenceObjects - optional array of objects that are related to event.

clearNotifications

public void clearNotifications(String source)

Description copied from interface: NotificationService

Sends clear event which will remove all notifications from specified source.

Specified by:

clearNotifications in interface NotificationService

Parameters:

source - identity of notification source.

clearNotifications

public void clearNotifications(String source,
                               NotificationEvent.Level level)

Description copied from interface: NotificationService

Sends clear event which will remove all notifications from specified source of specified importance level.

Specified by:

clearNotifications in interface NotificationService

Parameters:

source - identity of notification source.

level - importance level of notifications to be removed.

getWidgetNotificationSource

public String getWidgetNotificationSource(WidgetInstanceManager widgetInstanceManager)

Description copied from interface: NotificationService

Gets default source for each notification sent by specified widget.

Specified by:

getWidgetNotificationSource in interface NotificationService

Parameters:

widgetInstanceManager - instance manager of a widget which sends notification.

Returns:

source name for notification.

getWidgetNotificationSource

public String getWidgetNotificationSource(ActionContext<?> context)

Description copied from interface: NotificationService

Gets default source for each notification sent by specified action.

Specified by:

getWidgetNotificationSource in interface NotificationService

Parameters:

context - action context.

Returns:

source name for notification.