OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradeSystemNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to GradeSystems and the Grades defined within.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.

MethodgetGradebookId
Description

Gets the Gradebook Id associated with this session.

Returnosid.id.Idthe Gradebook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGradebook
Description

Gets the Gradebook associated with this session.

Returnosid.grading.Gradebookthe Gradebook associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForGradeSystemNotifications
Description

Tests if this user can register for GradeSystem 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.
MethoduseFederatedGradebookView
Description

Federates the view for methods in this session. A federated view will include notifications for grade systems in gradebooks which are children of this gradebook in the gradebook hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedGradebookView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this gradebook only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewGradeSystems
Description

Register for notifications of new grade systems. GradeSystemReceiver.newGradeSystems() is invoked when a new GradeSystem is created.

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

Registers for notification of updated grade systems. GradeSystemReceiver.changedGradeSystems() is invoked when a system is changed or grades are changed within it.

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

Registers for notification of an updated grade system. GradeSystemReceiver.changedGradeSystems() is invoked when the specified grade system is changed or grades are changed within it.

Parametersosid.id.IdgradeSystemIdthe Id of the grade system to monitor
ErrorsNULL_ARGUMENT gradeSystemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedGradeSystems
Description

Registers for notification of deleted grade systems. GradeSystemReceiver.deletedGradeSystems() is invoked when a grade system is removed from this gradebook.

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

Registers for notification of a deleted grade system. GradeSystemReceiver.deletedGradeSystems() is invoked when the specified system is removed from this gradebook.

Parametersosid.id.IdgradeSystemIdthe Id of the grade system to monitor
ErrorsNULL_ARGUMENT gradeSystemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.