org.alfresco.service.cmr.notification
Interface NotificationService

All Known Implementing Classes:

NotificationServiceImpl

public interface NotificationService

Notification Service Interface.

Since:

4.0

Method Summary

boolean	exists(java.lang.String notificationProvider) Indicates whether a notification provider exists or not.
java.util.List	getNotificationProviders() Gets a list of all the currently available notification providers.
void	register(NotificationProvider notificationProvider) Registers a notification provider with the notification service.
void	sendNotification(java.lang.String notificationProvider, NotificationContext notificationContext) Send notification using the names notification provider and notification context.

Method Detail

register

@NotAuditable
void register(NotificationProvider notificationProvider)

Registers a notification provider with the notification service.

Parameters:

notificationProvider - notification provider

getNotificationProviders

@NotAuditable
java.util.List getNotificationProviders()

Gets a list of all the currently available notification providers.

Returns:

List<String> notification provider names

exists

@NotAuditable
boolean exists(java.lang.String notificationProvider)

Indicates whether a notification provider exists or not.

Parameters:

notificationProvider - notification provider

Returns:

boolean true if exists, false otherwise

sendNotification

@NotAuditable
void sendNotification(java.lang.String notificationProvider,
                                   NotificationContext notificationContext)

Send notification using the names notification provider and notification context.

Parameters:

notificationProvider - notification provider

notificationContext - notification context