Interface | osid.recognition.AwardNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | getAcademyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Academy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAcademy | ||
Description |
Gets the | ||
Return | osid.recognition.Academy | the academy | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForAwardNotifications | ||
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 | useFederatedAcademyView | ||
Description |
Federates the view for methods in this session. A federated view will include awards in academies which are children of this academy in the academy hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedAcademyView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewAwards | ||
Description |
Register for notifications of new awards. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAwards | ||
Description |
Registers for notification of updated awards. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAward | ||
Description |
Registers for notification of an updated award. | ||
Parameters | osid.id.Id | awardId | the Id of the Award to monitor |
Errors | NULL_ARGUMENT | awardId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAwards | ||
Description |
Registers for notification of deleted awards. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAward | ||
Description |
Registers for notification of a deleted award. | ||
Parameters | osid.id.Id | awardId | the Id of the Award to monitor |
Errors | NULL_ARGUMENT | awardId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |