Interface NotificationManagementService

All Known Implementing Classes:

NotificationSubscriptionManagementServiceImpl

public interface NotificationManagementService

Service interface for managing notification subscriptions.

Since:

8.5.0

Author:

tobias

Method Summary

Modifier and Type	Method	Description
List<NotificationSubscription>	findAll(NotificationType notificationType, NotificationUser user)	Finds all notification subscriptions for a given notification type.
NotificationSubscriptionSettings	findSettingsByAssignee(NotificationAssignee assignee, NotificationUser user)	Finds the notification subscription settings for a given assignee.
NotificationSubscriptionSettings	saveSettings(NotificationSubscriptionSettings settings, NotificationUser user)	Saves the notification subscription settings.

Method Details

findAll

List<NotificationSubscription> findAll(NotificationType notificationType,
 NotificationUser user)
                                throws FcNotificationsManagementException

Finds all notification subscriptions for a given notification type.

Parameters:

notificationType - The type of notification.

user - The user requesting the subscriptions.

Returns:

A list of notification subscriptions.

Throws:

FcNotificationsManagementException - If an error occurs while retrieving the subscriptions.

findSettingsByAssignee

NotificationSubscriptionSettings findSettingsByAssignee(NotificationAssignee assignee,
 NotificationUser user)
                                                 throws FcNotificationsManagementException

Finds the notification subscription settings for a given assignee.

Parameters:

assignee - The assignee whose settings are to be retrieved.

user - The user requesting the settings.

Returns:

The notification subscription settings for the assignee.

Throws:

FcNotificationsManagementException - If an error occurs while retrieving the settings.

saveSettings

NotificationSubscriptionSettings saveSettings(NotificationSubscriptionSettings settings,
 NotificationUser user)
                                       throws FcNotificationsManagementException

Saves the notification subscription settings.

Parameters:

settings - The notification subscription settings to be saved.

user - The user requesting the save operation.

Returns:

The saved notification subscription settings.

Throws:

FcNotificationsManagementException - If an error occurs while saving the settings.