org.sakaiproject.service.legacy.notification
Interface NotificationEdit

All Superinterfaces:
Edit, Entity, Notification
All Known Implementing Classes:
BaseNotificationService.BaseNotificationEdit

public interface NotificationEdit
extends Notification, Edit

NotificationEdit is a modifiable Notification.

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
 void addFunction(String function)
          Add another Event function.
 void notify(Event event)
          Do the notification.
 void setAction(NotificationAction action)
          Set the action helper that handles the notify() action.
 void setFunction(String function)
          Set the Event function, clearing any that have already been set.
 void setResourceFilter(String filter)
          Set the resource reference filter.
 
Methods inherited from interface org.sakaiproject.service.legacy.notification.Notification
containsFunction, getAction, getFunction, getFunctions, getResourceFilter
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Edit
getPropertiesEdit, isActiveEdit
 

Method Detail

notify

public void notify(Event event)
Do the notification.

Specified by:
notify in interface Notification
Parameters:
event - The event that matched criteria to cause the notification.

setFunction

public void setFunction(String function)
Set the Event function, clearing any that have already been set.


addFunction

public void addFunction(String function)
Add another Event function.


setResourceFilter

public void setResourceFilter(String filter)
Set the resource reference filter.

Parameters:
filter - The resource reference filter.

setAction

public void setAction(NotificationAction action)
Set the action helper that handles the notify() action.

Parameters:
action - The action helper that handles the notify() action.