| org.sakaiproject.event.api.NotificationService
All known Subclasses: org.sakaiproject.event.impl.BaseNotificationService,
| NotificationService | | public interface NotificationService (Code) | |
NotificationService is ...
|
| Field Summary | |
| final static int | NOTI_NONE
Notification option value for undefined or no notification. | | final static int | NOTI_OPTIONAL
Notification option value for optional notification. | | final static int | NOTI_REQUIRED
Notification option value for required notification. | | final static String | PREFS_DEFAULT
Preferences key for default notification prefs. | | final static String | PREFS_NOTI
Preferences key for a specific notification - append the notification id. | | final static String | PREFS_SITE
Preferences key for default for a site notification prefs - append the site id. | | final static String | PREFS_TYPE
Preferences key for default for a resource type notification prefs - append the resource type. | | final static int | PREF_DIGEST
Notification preference value for digest notification. | | final static int | PREF_IGNORE
Notification preference value for blocking notification. | | final static int | PREF_IMMEDIATE
Notification preference value for immediate notification. | | final static int | PREF_NONE
Notification option value for undefined notification. | | final static String | REFERENCE_ROOT
This string starts the references to resources in this service. | | final static String | SECURE_ADD_NOTIFICATION
ability / event for notification add. | | final static String | SECURE_REMOVE_NOTIFICATION
ability / event for notification removal. | | final static String | SECURE_UPDATE_NOTIFICATION
ability / event for notification update. | | final static String | SERVICE_NAME
This string can be used to find the service in the service manager. |
| NOTI_NONE | | final static int NOTI_NONE(Code) | | Notification option value for undefined or no notification.
|
| NOTI_OPTIONAL | | final static int NOTI_OPTIONAL(Code) | | Notification option value for optional notification.
|
| NOTI_REQUIRED | | final static int NOTI_REQUIRED(Code) | | Notification option value for required notification.
|
| PREFS_DEFAULT | | final static String PREFS_DEFAULT(Code) | | Preferences key for default notification prefs.
|
| PREFS_NOTI | | final static String PREFS_NOTI(Code) | | Preferences key for a specific notification - append the notification id.
|
| PREFS_SITE | | final static String PREFS_SITE(Code) | | Preferences key for default for a site notification prefs - append the site id.
|
| PREFS_TYPE | | final static String PREFS_TYPE(Code) | | Preferences key for default for a resource type notification prefs - append the resource type.
|
| PREF_DIGEST | | final static int PREF_DIGEST(Code) | | Notification preference value for digest notification.
|
| PREF_IGNORE | | final static int PREF_IGNORE(Code) | | Notification preference value for blocking notification.
|
| PREF_IMMEDIATE | | final static int PREF_IMMEDIATE(Code) | | Notification preference value for immediate notification.
|
| PREF_NONE | | final static int PREF_NONE(Code) | | Notification option value for undefined notification.
|
| REFERENCE_ROOT | | final static String REFERENCE_ROOT(Code) | | This string starts the references to resources in this service.
|
| SECURE_ADD_NOTIFICATION | | final static String SECURE_ADD_NOTIFICATION(Code) | | ability / event for notification add.
|
| SECURE_REMOVE_NOTIFICATION | | final static String SECURE_REMOVE_NOTIFICATION(Code) | | ability / event for notification removal.
|
| SECURE_UPDATE_NOTIFICATION | | final static String SECURE_UPDATE_NOTIFICATION(Code) | | ability / event for notification update.
|
| SERVICE_NAME | | final static String SERVICE_NAME(Code) | | This string can be used to find the service in the service manager.
|
| addNotification | | NotificationEdit addNotification()(Code) | | Establish a new notification, locked for edit. Must commitEdit() to make official, or cancelEdit() when done!
a new Notification, locked for edit. |
| addTransientNotification | | NotificationEdit addTransientNotification()(Code) | | Establish a new transient notification. Transient notifications are processed by the service but not stored in storage. Modification to the notification can be done at any time, do not use edit(), commit() or remove() on it.
a new transient Notification. |
| cancelEdit | | void cancelEdit(NotificationEdit notification)(Code) | | Cancel the changes made to a NotificationEdit object, and release the lock. The NotificationEdit is disabled, and not to be used after this call.
Parameters:
notification - The NotificationEdit object to commit. |
| commitEdit | | void commitEdit(NotificationEdit notification)(Code) | | Commit the changes made to a NotificationEdit object, and release the lock. The NotificationEdit is disabled, and not to be used after this call.
Parameters:
notification - The NotificationEdit object to commit. |
| findNotification | | Notification findNotification(String function, String filter)(Code) | | Find a notification object.
Parameters:
function - The function setting of the notification object.
Parameters:
filter - The resourceFilter setting of the notification object. A notification object matching the criteria, or null if none found. |
| isNotificationFromReplyable | | boolean isNotificationFromReplyable()(Code) | | Check if an email notification should be reply-able in the From: field
true if email notifications should be reply-able in the From: field, false if not. |
| isNotificationToReplyable | | boolean isNotificationToReplyable()(Code) | | Check if an email notification should be reply-able in the To: field
true if email notifications should be reply-able in the To: field, false if not. |
| notificationReference | | String notificationReference(String id)(Code) | | Access the internal reference which can be used to access the resource from within the system.
Parameters:
id - The notification id. The the internal reference which can be used to access the resource from within the system. |
| removeNotification | | void removeNotification(NotificationEdit notification)(Code) | | Remove this notification - it must be a notification with a lock from editNotification(). The NotificationEdit is disabled, and not to be used after this call.
Parameters:
id - The notification id.
exception:
PermissionException - if the current notification does not have permission to remove this notification. |
|
|