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

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface FwEventNotification
extends CsapiInterface

The event notification mechanism is used to notify the service of generic events that have occurred. If Event Notifications are supported by a Framework, this interface and the createNotification() and destroyNotification() methods shall be supported.


Method Summary
 int createNotification(org.csapi.jr.se.fw.FwEventCriteria eventCriteria)
          This method is used to install generic notifications so that events can be sent to the service.
 void destroyNotification(int assignmentID)
          This method is used by the service to delete generic notifications from the framework.
 

Method Detail

createNotification

public int createNotification(org.csapi.jr.se.fw.FwEventCriteria eventCriteria)
                       throws CommonException,
                              InvalidEventTypeException,
                              InvalidCriteriaException,
                              PlatformException
This method is used to install generic notifications so that events can be sent to the service. Returns : Specifies the ID assigned by the framework for this newly installed event notification.

Parameters:
eventCriteria - Specifies the event specific criteria used by the service to define the event required.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidEventTypeException - Invalid event type.
InvalidCriteriaException - Invalid criteria specified.
PlatformException - The implementation detected an internal (for example, communication) error

destroyNotification

public void destroyNotification(int assignmentID)
                         throws CommonException,
                                InvalidAssignmentIdException,
                                PlatformException
This method is used by the service to delete generic notifications from the framework.

Parameters:
assignmentID - Specifies the assignment ID given by the framework when the previous createNotification() was called. If the assignment ID does not correspond to one of the valid assignment IDs, the framework will return the error code P_INVALID_ASSIGNMENT_ID.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidAssignmentIdException - The assignment ID is invalid
PlatformException - The implementation detected an internal (for example, communication) error