Package com.hybris.backoffice.widgets.notificationarea

Class DefaultNotificationService

java.lang.Object

com.hybris.backoffice.widgets.notificationarea.DefaultNotificationService

All Implemented Interfaces:

NotificationService

Direct Known Subclasses:

DefaultNotificationService

@Deprecated(since="1811",
            forRemoval=true)
public class DefaultNotificationService
extends java.lang.Object
implements NotificationService

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811

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

See Also:

DefaultNotificationService

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SETTING_NOTIFICATION_SOURCE	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
DefaultNotificationService()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	clearNotifications(java.lang.String source)	Deprecated, for removal: This API element is subject to removal in a future version. Sends clear event which will remove all notifications from specified source.
void	clearNotifications(java.lang.String source, NotificationEvent.Level level)	Deprecated, for removal: This API element is subject to removal in a future version. Sends clear event which will remove all notifications from specified source of specified importance level.
java.lang.String	getWidgetNotificationSource(ActionContext<?> context)	Deprecated, for removal: This API element is subject to removal in a future version. Gets default source for each notification sent by specified action.
java.lang.String	getWidgetNotificationSource(WidgetInstanceManager widgetInstanceManager)	Deprecated, for removal: This API element is subject to removal in a future version. Gets default source for each notification sent by specified widget.
void	notifyUser(java.lang.String source, java.lang.String eventType, NotificationEvent.Level level, java.lang.Object... referenceObjects)	Deprecated, for removal: This API element is subject to removal in a future version. 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

Field Detail

SETTING_NOTIFICATION_SOURCE

public static final java.lang.String SETTING_NOTIFICATION_SOURCE

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

Constructor Detail

DefaultNotificationService

public DefaultNotificationService()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

notifyUser

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

Deprecated, for removal: This API element is subject to removal in a future version.

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(java.lang.String source)

Deprecated, for removal: This API element is subject to removal in a future version.

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(java.lang.String source,
                               NotificationEvent.Level level)

Deprecated, for removal: This API element is subject to removal in a future version.

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 java.lang.String getWidgetNotificationSource(WidgetInstanceManager widgetInstanceManager)

Deprecated, for removal: This API element is subject to removal in a future version.

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 java.lang.String getWidgetNotificationSource(ActionContext<?> context)

Deprecated, for removal: This API element is subject to removal in a future version.

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.