com.netscape.pm.model
Interface INotification

All Superinterfaces:
IPMElement

public interface INotification
extends IPMElement

Defines an object to act as a notification dispatcher. An INotification object is bound to a node element and can be asked to fire a notification to interested parties when a work item is created at the node.

Currently, the only format used for notifications in the Process Manager server is mail, although this framework is generic enough to support additional formats in the future (for instance, HTTP).


Method Summary
 void fire(IWorkItem wi)
          Fires the notification in the scope of the defined work item.
 
Methods inherited from interface com.netscape.pm.model.IPMElement
dumpState, getDescription, getName, getParent, getPrettyName, getProperty, isLocked, lockObject, postCreation, setParent, setProperties, toString
 

Method Detail

fire

public void fire(IWorkItem wi)
          throws PMException
Fires the notification in the scope of the defined work item.
Parameters:
wi - the current work item
Throws:
PMException - if there is a problem with composing or sending the notification.
Since:
PAE 4.0
See Also:
IWorkItem