com.hybris.backoffice.widgets.notificationarea

Interface NotificationService

All Known Implementing Classes:

DefaultNotificationService

public interface NotificationService

Notification service responsible for sending user notifications.

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.
default void	notifyUser(ActionContext<?> context, String eventType, NotificationEvent.Level level, Object... referenceObjects) Sends a notification to end user.
void	notifyUser(String source, String eventType, NotificationEvent.Level level, Object... referenceObjects) Sends a notification to end user.
default void	notifyUser(WidgetInstanceManager widgetInstanceManager, String eventType, NotificationEvent.Level level, Object... referenceObjects) Sends a notification to end user.

Method Detail

notifyUser

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

Sends a notification to end user.

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

void clearNotifications(String source)

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

Parameters:

source - identity of notification source.

clearNotifications

void clearNotifications(String source,
                        NotificationEvent.Level level)

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

Parameters:

source - identity of notification source.

level - importance level of notifications to be removed.

getWidgetNotificationSource

String getWidgetNotificationSource(WidgetInstanceManager widgetInstanceManager)

Gets default source for each notification sent by specified widget.

Parameters:

widgetInstanceManager - instance manager of a widget which sends notification.

Returns:

source name for notification.

notifyUser

default void notifyUser(WidgetInstanceManager widgetInstanceManager,
                        String eventType,
                        NotificationEvent.Level level,
                        Object... referenceObjects)

Sends a notification to end user.

Parameters:

widgetInstanceManager - instance manager of a widget which sends notification.

eventType - type of notification to be sent NotificationEventTypes.

level - importance level of notification.

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

See Also:

getWidgetNotificationSource(WidgetInstanceManager)

getWidgetNotificationSource

String getWidgetNotificationSource(ActionContext<?> context)

Gets default source for each notification sent by specified action.

Parameters:

context - action context.

Returns:

source name for notification.

notifyUser

default void notifyUser(ActionContext<?> context,
                        String eventType,
                        NotificationEvent.Level level,
                        Object... referenceObjects)

Sends a notification to end user.

Parameters:

context - action context.

eventType - type of notification to be sent NotificationEventTypes.

level - importance level of notification.

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

See Also:

getWidgetNotificationSource(ActionContext)