org.cyclos.services.messaging

Interface NotificationService

All Superinterfaces:

Service

All Known Subinterfaces:

NotificationServiceLocal

All Known Implementing Classes:

NotificationServiceSecurity

public interface NotificationService
extends Service

Method Summary

Modifier and Type	Method and Description
NotificationsStatusVO	getNotificationsStatus() Returns the notifications status containing the unread/new notifications and the last view date.
NotificationVO	load(@NotNull java.lang.Long id) Loads a vo by id
void	markAllRead() Marks as read all the notifications of the logged user
void	markAsRead(@NotNull java.util.List<java.lang.Long> ids) Marks as read the given notification ids
void	remove(@NotNull java.lang.Long id) Removes the given notification id
void	removeAll(@NotNull java.util.Collection<java.lang.Long> notificationIds) Removes a set of notifications
Page<NotificationVO>	search(@NotNull NotificationQuery params) Searches for notifications for the logged user

Method Detail

getNotificationsStatus

NotificationsStatusVO getNotificationsStatus()
                                      throws FrameworkException

Returns the notifications status containing the unread/new notifications and the last view date.
The last view date is updated through the UserValidationService.updateUserActivity(org.cyclos.model.users.users.UserActivityType) method with the parameter UserActivityType.NOTIFICATION.

Throws:

FrameworkException

load

NotificationVO load(@NotNull
                    @NotNull java.lang.Long id)
             throws FrameworkException

Loads a vo by id

Throws:

FrameworkException

markAllRead

void markAllRead()
          throws FrameworkException

Marks as read all the notifications of the logged user

Throws:

FrameworkException

markAsRead

void markAsRead(@NotNull
                @NotNull java.util.List<java.lang.Long> ids)
         throws FrameworkException

Marks as read the given notification ids

Throws:

FrameworkException

remove

void remove(@NotNull
            @NotNull java.lang.Long id)
     throws FrameworkException

Removes the given notification id

Throws:

FrameworkException

removeAll

void removeAll(@NotNull
               @NotNull java.util.Collection<java.lang.Long> notificationIds)
        throws FrameworkException

Removes a set of notifications

Throws:

FrameworkException

search

Page<NotificationVO> search(@NotNull
                            @NotNull NotificationQuery params)
                     throws FrameworkException

Searches for notifications for the logged user

Throws:

FrameworkException