org.cyclos.impl.messaging

Interface NotificationSettingsServiceLocal

All Superinterfaces:

NotificationSettingsService, Service

public interface NotificationSettingsServiceLocal
extends NotificationSettingsService

Method Summary

Modifier and Type	Method and Description
NotificationTypeSettingsDTO	getNotificationTypeSettings(Notification notification) Returns the notifications settings for an already generated notification. This method never return null, if the user hasn't saved his preferences it creates a default one.
AdminNotificationType	getTypeBasedOnSetting(AdminNotificationType type) Returns the notification type which the given type is based on. This method must be used when the given type does not have a corresponding setting, but uses settings from another type. E.g: AdminNotificationType.USER_IMPORT_REGISTRATION is based on AdminNotificationType.USER_REGISTRATION
boolean	isAllowedNotificationType(AdminNotificationType type, User user, java.lang.Object option) It checks if the user has the Permission.MY_NOTIFICATIONS_ENABLE permission and is allowed to be notified by the specified type and the selected option.
boolean	isEnabled(UserNotificationType type, User user) It returns true if the notification type is enabled by permission and if the user had selected being notified by that type
com.mysema.commons.lang.CloseableIterator<User>	usersToForwardMessageIterator(IncomingMessage message) It returns an iterator over all users allowed to forward the corresponding incoming message.

Methods inherited from interface org.cyclos.services.messaging.NotificationSettingsService

getAdminNotificationSettingsData, getUserNotificationSettingsData, saveAdmin, saveUser

Method Detail

getNotificationTypeSettings

NotificationTypeSettingsDTO getNotificationTypeSettings(Notification notification)

Returns the notifications settings for an already generated notification.
This method never return null, if the user hasn't saved his preferences it creates a default one.

getTypeBasedOnSetting

AdminNotificationType getTypeBasedOnSetting(AdminNotificationType type)

Returns the notification type which the given type is based on.
This method must be used when the given type does not have a corresponding setting, but uses settings from another type.
E.g: AdminNotificationType.USER_IMPORT_REGISTRATION is based on AdminNotificationType.USER_REGISTRATION

isAllowedNotificationType

boolean isAllowedNotificationType(AdminNotificationType type,
                                  User user,
                                  java.lang.Object option)

It checks if the user has the Permission.MY_NOTIFICATIONS_ENABLE permission and is allowed to be notified by the specified type and the selected option. It assumes the user has selected being notified by the specified type
For example: if type is AdminNotificationType.PAYMENT_PERFORMED (option must be a TransferTypeVO) then this method will return true if that TT is contained in the available TT list.

Parameters:

type - the notification type to be checked

user - the user to check if he/she is allowed to be notified

option - (optional) the selected option to be notified by (chosen by the user). If it's null this method only checks if there are any available options.

Returns:

true if the user can be notified.

isEnabled

boolean isEnabled(UserNotificationType type,
                  User user)

It returns true if the notification type is enabled by permission and if the user had selected being notified by that type

usersToForwardMessageIterator

com.mysema.commons.lang.CloseableIterator<User> usersToForwardMessageIterator(IncomingMessage message)

It returns an iterator over all users allowed to forward the corresponding incoming message.