OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.AcademyNotificationSession
Implementsosid.OsidSession
Used Byosid.recognition.RecognitionManager
osid.recognition.RecognitionProxyManager
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
Compliancemandatory This method must be implemented.
MethodreliableAcademyNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeAcademyNotification().

Compliancemandatory This method is must be implemented.
MethodunreliableAcademyNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

Compliancemandatory This method is must be implemented.
MethodacknowledgeAcademyNotification
Description

Acknowledge an academy notification.

Parametersosid.id.IdnotificationId the Id of the notification
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForNewAcademies
Description

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

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAcademies
Description

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

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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.IdacademyId the Id of the Academy to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedAcademies
Description

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

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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.IdacademyId the Id of the Academy to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAcademyHierarchy
Description

Registers for notification of an updated academy hierarchy structure. AcademyReceiver.changedChildOfAcademies() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAcademyHierarchyForAncestors
Description

Registers for notification of an updated academy hierarchy structure. AcademyReceiver.changedChildOfAcademies() is invoked when a node experiences a change in its children.

Parametersosid.id.IdacademyId the Id of the Academy node to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAcademyHierarchyForDescendants
Description

Registers for notification of an updated academy hierarchy structure. AcademyReceiver.changedChildOfAcademies() is invoked when a node experiences a change in its children.

Parametersosid.id.IdacademyId the Id of the Academy node to monitor
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.