OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.AcademyNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Academy objects. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

Notifications are triggered with changes to the Academy object itself. Adding and removing conferrals result in notifications available from the notification session for conferrals.

MethodcanRegisterForAcademyNotifications
Description

Tests if this user can register for Academy notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAcademies
Description

Register for notifications of new academies. AcademyReceiver.newAcademies() is invoked when a new Academy is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAcademyAncestors
Description

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified academy. AcademyReceiver.newAncestorAcademy() is invoked when the specified academy node gets a new ancestor.

Parametersosid.id.IdacademyIdthe Id of the Academy node to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAcademyDescendants
Description

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified academy. AcademyReceiver.newDescendantAcademy() is invoked when the specified academy node gets a new descendant.

Parametersosid.id.IdacademyIdthe Id of the Academy node to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAcademies
Description

Registers for notification of updated academies. AcademyReceiver.changedAcademies() is invoked when an academy is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAcademy
Description

Registers for notification of an updated academy. AcademyReceiver.changedAcademies() is invoked when the specified academy is changed.

Parametersosid.id.IdacademyIdthe Id of the Academy to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAcademies
Description

Registers for notification of deleted academies. AcademyReceiver.deletedAcademies() is invoked when an academy is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAcademy
Description

Registers for notification of a deleted academy. AcademyReceiver.deletedAcademies() is invoked when the specified academy is deleted.

Parametersosid.id.IdacademyIdthe Id of the Academy to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAcademyAncestors
Description

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified academy AcademyReceiver.deletedAncestor() is invoked when the specified academy node loses an ancestor.

Parametersosid.id.IdacademyIdthe Id of the Academy to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAcademyDescendants
Description

Registers for notification of an updated hierarchy structure that removes a descendant of the specified academy. AcademyReceiver.deletedDescendant() is invoked when the specified academy node loses a descendant.

Parametersosid.id.IdacademyIdthe Id of the Academy to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.