| Interface | osid.recognition.AcademyNotificationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.recognition.RecognitionManager | ||
osid.recognition.RecognitionProxyManager | |||
| Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the
| ||
| Method | canRegisterForAcademyNotifications | ||
| Description |
Tests if this user can register for
| ||
| Return | boolean | false if notification methods are not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | reliableAcademyNotifications | ||
| Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using
| ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | unreliableAcademyNotifications | ||
| Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | acknowledgeAcademyNotification | ||
| Description |
Acknowledge an academy notification. | ||
| Parameters | osid.id.Id | notificationId | the Id of the notification |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForNewAcademies | ||
| Description |
Register for notifications of new academies.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedAcademies | ||
| Description |
Registers for notification of updated academies.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedAcademy | ||
| Description |
Registers for notification of an updated academy.
| ||
| Parameters | osid.id.Id | academyId | the Id of the Academy to monitor |
| Errors | NULL_ARGUMENT | academyId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedAcademies | ||
| Description |
Registers for notification of deleted academies.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedAcademy | ||
| Description |
Registers for notification of a deleted academy.
| ||
| Parameters | osid.id.Id | academyId | the Id of the Academy to monitor |
| Errors | NULL_ARGUMENT | academyId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedAcademyHierarchy | ||
| Description |
Registers for notification of an updated academy
hierarchy structure.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedAcademyHierarchyForAncestors | ||
| Description |
Registers for notification of an updated academy
hierarchy structure.
| ||
| Parameters | osid.id.Id | academyId | the Id of the Academy node to monitor |
| Errors | NULL_ARGUMENT | academyId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedAcademyHierarchyForDescendants | ||
| Description |
Registers for notification of an updated academy
hierarchy structure.
| ||
| Parameters | osid.id.Id | academyId | the Id of the Academy node to monitor |
| Errors | NULL_ARGUMENT | academyId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |