Package ch.tocco.nice2.notificationcenter.api

Interface NotificationService

All Known Implementing Classes:

NotificationServiceImpl

public interface NotificationService

Method Summary

Modifier and Type	Method	Description
Notification	createNotification(String title, String message, Notification.NotificationType notificationType)	Creates a notification that is displayed on the client.
void	createNotificationAfterCommit(String title, String message, Notification.NotificationType notificationType, Collection<Entity> resultEntities)	Creates a notification (in an after commit listener) that is displayed on the client Note: E.g.
NotificationWithProgress	createNotificationWithProgress(String title, String message, Notification.NotificationType notificationType, boolean supportsCancellation)	Creates a notification that is displayed on the client.
NotificationWithProgress	findNotificationWithProgressByTaskId(String taskId)

Method Details

createNotification

Notification createNotification(String title,
 String message,
 Notification.NotificationType notificationType)

Creates a notification that is displayed on the client. This method should primarily be used for static events ('entity has been created'). Note: The notifications are only created if the request context is set up correctly.

createNotificationAfterCommit

void createNotificationAfterCommit(String title,
 String message,
 Notification.NotificationType notificationType,
 Collection<Entity> resultEntities)

Creates a notification (in an after commit listener) that is displayed on the client Note: E.g. This method should be used if in a listener a notification should be sent to the user. The notification is only sent if the transaction is committed. Note: The notifications are only created if the request context is set up correctly.

createNotificationWithProgress

NotificationWithProgress createNotificationWithProgress(String title,
 String message,
 Notification.NotificationType notificationType,
 boolean supportsCancellation)

Creates a notification that is displayed on the client. This method should primarily be used for background tasks, as the progress can be updated while the task is running. Note: The notifications are only created if the request context is set up correctly.

findNotificationWithProgressByTaskId

NotificationWithProgress findNotificationWithProgressByTaskId(String taskId)