org.csapi.jr.se.fw.fw_application.notification
Interface EventNotification

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface EventNotification
extends CsapiInterface

The event notification mechanism is used to notify the application of generic service related 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 enable generic notifications so that events can be sent to the application.
 void destroyNotification(int assignmentID)
          This method is used by the application to delete generic notifications from the framework.
 

Method Detail

createNotification

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

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

destroyNotification

public void destroyNotification(int assignmentID)
                         throws CommonException,
                                AccessDeniedException,
                                InvalidAssignmentIdException,
                                PlatformException
This method is used by the application 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_ASSIGNMENTID.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
AccessDeniedException - The client is not currently authenticated with the framework
InvalidAssignmentIdException - The assignment ID is invalid
PlatformException - The implementation detected an internal (for example, communication) error