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

This session defines methods to receive notifications on adds/changes to Gradebook 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.

MethodcanRegisterForGradebookNotifications
Description

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

Register for notifications of new gradebooks. GradebookReceiver.newGradebooks() is invoked when a new Gradebook is created.

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

Registers for notification if an ancestor is added to the specified gradebook in the gradebook hierarchy. GradebookReceiver.newGradebookAncestor() is invoked when the specified gradebook experiences an addition in ancestry.

Parametersosid.id.IdgradebookIdthe Id of the gradebook to monitor
ErrorsNULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewGradebookDescendants
Description

Registers for notification if a descendant is added to the specified gradebook in the gradebook hierarchy. GradebookReceiver.newGradebookDescendant() is invoked when the specified gradebook experiences an addition in descendants.

Parametersosid.id.IdgradebookIdthe Id of the gradebook to monitor
ErrorsNULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedGradebooks
Description

Registers for notification of updated gradebooks. GradebookReceiver.changedGradebooks() is invoked when a gradebook is changed.

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

Registers for notification of an updated gradebook. GradebookReceiver.changedGradebooks() is invoked when the specified gradebook is changed.

Parametersosid.id.IdgradebookIdthe Id of the gradebook to monitor
ErrorsNULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedGradebooks
Description

Registers for notification of deleted gradebooks. GradebookReceiver.deletedGradebooks() is invoked when a calenedar is deleted.

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

Registers for notification of a deleted gradebook. GradebookReceiver.deletedGradebooks() is invoked when the specified gradebook is deleted.

Parametersosid.id.IdgradebookIdthe Id of the gradebook to monitor
ErrorsNULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedGradebookAncestors
Description

Registers for notification if an ancestor is removed from the specified gradebook in the gradebook hierarchy. GradebookReceiver.deletedGradebookAncestor() is invoked when the specified gradebook experiences a removal of an ancestor.

Parametersosid.id.IdgradebookIdthe Id of the gradebook to monitor
ErrorsNULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedGradebookDescendants
Description

Registers for notification if a descendant is removed from fthe specified gradebook in the calndar hierarchy. GradebookReceiver.deletedGradebookDescednant() is invoked when the specified gradebook experiences a removal of one of its descendants.

Parametersosid.id.IdgradebookIdthe Id of the gradebook to monitor
ErrorsNULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.