org.osivia.portal.api.notifications

Interface INotificationsService

public interface INotificationsService

Notifications service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME MBean name.

Method Summary

Modifier and Type	Method and Description
void	addNotifications(PortalControllerContext portalControllerContext, Notifications notifications) Add notifications.
void	addSimpleNotification(PortalControllerContext portalControllerContext, String message, NotificationsType type) Add a simple notification.
void	addSimpleNotification(PortalControllerContext portalControllerContext, String message, NotificationsType type, Long errorCode) Add a simple notification.
List<Notifications>	getNotificationsList(PortalControllerContext portalControllerContext) Get notifications list.
List<Notifications>	readNotificationsList(PortalControllerContext portalControllerContext) Read and remove notifications.
void	setNotificationsList(PortalControllerContext portalControllerContext, List<Notifications> notificationsList) Set notifications list.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

MBean name.

See Also:

Constant Field Values

Method Detail

addSimpleNotification

void addSimpleNotification(PortalControllerContext portalControllerContext,
                           String message,
                           NotificationsType type)

Add a simple notification.

Parameters:

portalControllerContext - portal controller context

message - notification message

type - notification type

addSimpleNotification

void addSimpleNotification(PortalControllerContext portalControllerContext,
                           String message,
                           NotificationsType type,
                           Long errorCode)

Add a simple notification.

Parameters:

portalControllerContext - portal controller context

message - notification message

type - notification type

errorCode - errorCode

addNotifications

void addNotifications(PortalControllerContext portalControllerContext,
                      Notifications notifications)

Add notifications.

Parameters:

portalControllerContext - portal controller context

notifications - notifications

getNotificationsList

List<Notifications> getNotificationsList(PortalControllerContext portalControllerContext)

Get notifications list.

Parameters:

portalControllerContext - portal controller context

Returns:

notifications list

setNotificationsList

void setNotificationsList(PortalControllerContext portalControllerContext,
                          List<Notifications> notificationsList)

Set notifications list.

Parameters:

portalControllerContext - portal controller context

notificationsList - notifications list

readNotificationsList

List<Notifications> readNotificationsList(PortalControllerContext portalControllerContext)

Read and remove notifications.

Parameters:

portalControllerContext - portal controller context

Returns:

notifications list