Package org.cyclos.services.messaging
Interface NotificationService
-
- All Superinterfaces:
Service
- All Known Subinterfaces:
NotificationServiceLocal
public interface NotificationService extends Service
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description NotificationsStatusVOgetNotificationsStatus()Returns the notifications status containing the unread/new notifications and the last view date.
The last view date is updated through theBasicUserService.updateUserActivity(org.cyclos.model.users.users.UserActivityType)method with the parameterUserActivityType.NOTIFICATION.NotificationVOload(@NotNull Long id)Loads a vo by idvoidmarkAllRead()Marks as read all the notifications of the logged uservoidmarkAsRead(@NotNull List<Long> ids)Marks as read the given notification idsvoidremove(@NotNull Long id)Removes the given notification idvoidremoveAll(@NotNull Collection<Long> notificationIds)Removes a set of notificationsPage<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 theBasicUserService.updateUserActivity(org.cyclos.model.users.users.UserActivityType)method with the parameterUserActivityType.NOTIFICATION.- Throws:
FrameworkException
-
load
NotificationVO load(@NotNull @NotNull Long id) throws FrameworkException
Loads a vo by id- Throws:
FrameworkException
-
markAllRead
void markAllRead() throws FrameworkExceptionMarks as read all the notifications of the logged user- Throws:
FrameworkException
-
markAsRead
void markAsRead(@NotNull @NotNull List<Long> ids) throws FrameworkExceptionMarks as read the given notification ids- Throws:
FrameworkException
-
remove
void remove(@NotNull @NotNull Long id) throws FrameworkExceptionRemoves the given notification id- Throws:
FrameworkException
-
removeAll
void removeAll(@NotNull @NotNull Collection<Long> notificationIds) throws FrameworkExceptionRemoves 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
-
-