org.alfresco.service.cmr.notification

Interface NotificationService

All Known Implementing Classes:

NotificationServiceImpl

public interface NotificationService

Notification Service Interface.

Since:

4.0

Author:

Roy Wetherall

Method Summary

Modifier and Type	Method and Description
boolean	exists(String notificationProvider) Indicates whether a notification provider exists or not.
List<String>	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(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
List<String> getNotificationProviders()

Gets a list of all the currently available notification providers.

Returns:

List<String> notification provider names

exists

@NotAuditable
boolean exists(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(String notificationProvider,
                                    NotificationContext notificationContext)

Send notification using the names notification provider and notification context.

Parameters:

notificationProvider - notification provider

notificationContext - notification context