|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public int createNotification(org.csapi.jr.se.fw.FwEventCriteria eventCriteria) throws CommonException, InvalidEventTypeException, InvalidCriteriaException, PlatformException
eventCriteria
- Specifies the event specific criteria used by the service to define the event required.
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) errorpublic void destroyNotification(int assignmentID) throws CommonException, InvalidAssignmentIdException, PlatformException
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.
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
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |