org.sakaiproject.service.legacy.notification
Interface Notification

All Superinterfaces:
Entity
All Known Subinterfaces:
NotificationEdit
All Known Implementing Classes:
BaseNotificationService.BaseNotification, BaseNotificationService.BaseNotificationEdit

public interface Notification
extends Entity

Notification the interface for classes that act to notify, used with the GenericNotificationService.

Version:
$Revision: 2371 $
Author:
University of Michigan, CHEF Software Development Team

Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 boolean containsFunction(String function)
          Check if the notification watches for events with this function code.
 NotificationAction getAction()
          Get the action helper that handles the notify() action.
 String getFunction()
          Get the Event function.
 List getFunctions()
          Get all the Event functions for this notification.
 String getResourceFilter()
          Get the resource reference filter.
 void notify(Event event)
          Do the notification.
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 

Method Detail

notify

public void notify(Event event)
Do the notification.

Parameters:
event - The event that matched criteria to cause the notification.

getFunction

public String getFunction()
Get the Event function. Only Events with this function code will trigger the notification.

Returns:
The Event function to watch for.

getFunctions

public List getFunctions()
Get all the Event functions for this notification.

Returns:
a List (String) of Event functions to watch for.

containsFunction

public boolean containsFunction(String function)
Check if the notification watches for events with this function code.

Returns:
true if this notification watches for evens with this function code, false if not.

getResourceFilter

public String getResourceFilter()
Get the resource reference filter. Only Events with references matching this will trigger the notification.

Returns:
The resource reference filter.

getAction

public NotificationAction getAction()
Get the action helper that handles the notify() action.

Returns:
The action helper that handles the notify() action.