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

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

The views defined in this session correspond to the views in the GradeEntryLookupSession.

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.
MethodcanRegisterForGradeEntryNotifications
Description

Tests if this user can register for GradeEntry 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 entries 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.
MethodregisterForNewGradeEntries
Description

Register for notifications of new grade entries. GradeEntryReceiver.newGradeEntries() is invoked when a new grade entry is created.

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

Registers for notification of a new grade entry for the specified gradebook column. GradeEntryReceiver.newGradeEntries() is invoked when a new entry for the resource is created.

Parametersosid.id.IdgradebookColumnIdthe Id of the GradebookColumn to monitor
ErrorsNULL_ARGUMENT gradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewGradeEntriesForResource
Description

Registers for notification of a new grade entry for the specified resource. GradeEntryReceiver.newGradeEntries() is invoked when a new entry for the resource is created.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewGradeEntriesByGrader
Description

Registers for notification of a new grade entry for the specified grader agent. GradeEntryReceiver.newGradeEntries() is invoked when a new entry for the grader is created.

Parametersosid.id.IdresourceIdthe Id of the Agent to monitor
ErrorsNULL_ARGUMENT agentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedGradeEntries
Description

Registers for notification of updated grade entries. GradeEntryReceiver.changedGradeEntries() is invoked when a grade entry is changed.

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

Registers for notification of an updated grade entry for the specified gradebook column. GradeEntryReceiver.changedGradeEntries() is invoked when an entry for the column is updated.

Parametersosid.id.IdgradebookColumnIdthe Id of the GradebookColumn to monitor
ErrorsNULL_ARGUMENT gradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedGradeEntriesForResource
Description

Registers for notification of an updated grade entry for the specified key resource. GradeEntryReceiver.changedGradeEntries() is invoked when an entry for the resource is updated.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedGradeEntriesByGrader
Description

Registers for notification of an updated grade entry for the specified grader. GradeEntryReceiver.changedGradeEntries() is invoked when an entry for the agent is updated.

Parametersosid.id.IdresourceIdthe Id of the Agent to monitor
ErrorsNULL_ARGUMENT agentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedGradeEntry
Description

Registers for notification of an updated grade entry. GradeEntryReceiver.changedGradeEntries() is invoked when the specified grade entry is changed.

Parametersosid.id.IdgradeEntryIdthe Id of the GradeEntry to monitor
ErrorsNULL_ARGUMENT gradeEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedGradeEntries
Description

Registers for notification of deleted grade entries. GradeEntryReceiver.deletedGradeEntries() is invoked when a grade entry is deleted.

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

Registers for notification of a deleted grade entry for the specified gradebook column. GradeEntryReceiver.changedGradeEntries() is invoked when an entry for the column is removed from this gradebook.

Parametersosid.id.IdgradebookColumnIdthe Id of the GradebookColumn to monitor
ErrorsNULL_ARGUMENT gradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedGradeEntriesForResource
Description

Registers for notification of a deleted grade entry for the specified key resource. GradeEntryReceiver.changedGradeEntries() is invoked when an entry for the resource is removed from this gradebook.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedGradeEntriesByGrader
Description

Registers for notification of a deleted grade entry for the specified grader. GradeEntryReceiver.changedGradeEntries() is invoked when an entry for the agent is removed from this gradebook.

Parametersosid.id.IdresourceIdthe Id of the Agent to monitor
ErrorsNULL_ARGUMENT agentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedGradeEntry
Description

Registers for notification of a deleted grade entry. GradeEntryReceiver.deletedGradeEntries() is invoked when the specified entry is deleted.

Parametersosid.id.IdgradeEntryIdthe Id of the GradeEntry to monitor
ErrorsNULL_ARGUMENT gradeEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.