org.csapi.jr.se.fw.fw_service.notification
Interface SvcEventNotification

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface SvcEventNotification
extends CsapiInterface

This interface is used by the framework to inform the service of a generic event. The Event Notification Framework will invoke methods on the Event Notification Service Interface that is specified when the Event Notification interface is obtained. If Event Notifications are supported by a Service, this interface and the reportNotification() and notificationTerminated() methods shall be supported.


Method Summary
 void notificationTerminated()
          This method indicates to the service that all generic event notifications have been terminated (for example, due to faults detected).
 void reportNotification(org.csapi.jr.se.fw.FwEventInfo eventInfo, int assignmentID)
          This method notifies the service of the arrival of a generic event.
 

Method Detail

reportNotification

public void reportNotification(org.csapi.jr.se.fw.FwEventInfo eventInfo,
                               int assignmentID)
                        throws CommonException,
                               InvalidAssignmentIdException
This method notifies the service of the arrival of a generic event.

Parameters:
eventInfo - Specifies specific data associated with this event.
assignmentID - Specifies the assignment id which was returned by the framework during the createNotification() method. The service can use the assignment id to associate events with event specific criteria and to act accordingly.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidAssignmentIdException - The assignment ID is invalid

notificationTerminated

public void notificationTerminated()
                            throws CommonException
This method indicates to the service that all generic event notifications have been terminated (for example, due to faults detected).

Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.