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

This session defines methods to receive notifications on adds/changes to Award 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 Award object itself. Adding and removing conferrals result in notifications available from the notification session for conferrals.

MethodgetAcademyId
Description

Gets the Academy Id associated with this session.

Returnosid.id.Idthe Academy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAcademy
Description

Gets the Academy associated with this session.

Returnosid.recognition.Academythe academy
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAwardNotifications
Description

Tests if this user can register for Award 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.
MethoduseFederatedAcademyView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAcademyView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewAwards
Description

Register for notifications of new awards. AwardReceiver.newAwards() is invoked when a new Award is created.

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

Registers for notification of updated awards. AwardReceiver.changedAwards() is invoked when an award is changed.

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

Registers for notification of an updated award. AwardReceiver.changedAwards() is invoked when the specified award is changed.

Parametersosid.id.IdawardIdthe Id of the Award to monitor
ErrorsNULL_ARGUMENT awardId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAwards
Description

Registers for notification of deleted awards. AwardReceiver.deletedAwards() is invoked when an award is deleted.

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

Registers for notification of a deleted award. AwardReceiver.deletedAwards() is invoked when the specified award is deleted.

Parametersosid.id.IdawardIdthe Id of the Award to monitor
ErrorsNULL_ARGUMENT awardId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.