Interface | osid.grading.GradeEntryNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to The views defined in this session correspond to the views
in the | ||
Method | getGradebookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Gradebook Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebook | ||
Description |
Gets the | ||
Return | osid.grading.Gradebook | the Gradebook associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForGradeEntryNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedGradebookView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedGradebookView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this gradebook only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewGradeEntries | ||
Description |
Register for notifications of new grade entries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewGradeEntriesForGradebookColumn | ||
Description |
Registers for notification of a new grade entry for the
specified gradebook column. | ||
Parameters | osid.id.Id | gradebookColumnId | the Id of the GradebookColumn to monitor |
Errors | NULL_ARGUMENT | gradebookColumnId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewGradeEntriesForResource | ||
Description |
Registers for notification of a new grade entry for the
specified resource. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewGradeEntriesByGrader | ||
Description |
Registers for notification of a new grade entry for the
specified grader agent. | ||
Parameters | osid.id.Id | resourceId | the Id of the Agent to monitor |
Errors | NULL_ARGUMENT | agentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGradeEntries | ||
Description |
Registers for notification of updated grade entries.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGradeEntriesForGradebookColumn | ||
Description |
Registers for notification of an updated grade entry
for the specified gradebook column. | ||
Parameters | osid.id.Id | gradebookColumnId | the Id of the GradebookColumn to monitor |
Errors | NULL_ARGUMENT | gradebookColumnId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGradeEntriesForResource | ||
Description |
Registers for notification of an updated grade entry
for the specified key resource. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGradeEntriesByGrader | ||
Description |
Registers for notification of an updated grade entry
for the specified grader. | ||
Parameters | osid.id.Id | resourceId | the Id of the Agent to monitor |
Errors | NULL_ARGUMENT | agentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGradeEntry | ||
Description |
Registers for notification of an updated grade entry.
| ||
Parameters | osid.id.Id | gradeEntryId | the Id of the GradeEntry to monitor |
Errors | NULL_ARGUMENT | gradeEntryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGradeEntries | ||
Description |
Registers for notification of deleted grade entries.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGradeEntriesForGradebookColumn | ||
Description |
Registers for notification of a deleted grade entry for
the specified gradebook column. | ||
Parameters | osid.id.Id | gradebookColumnId | the Id of the GradebookColumn to monitor |
Errors | NULL_ARGUMENT | gradebookColumnId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGradeEntriesForResource | ||
Description |
Registers for notification of a deleted grade entry for
the specified key resource. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGradeEntriesByGrader | ||
Description |
Registers for notification of a deleted grade entry for
the specified grader. | ||
Parameters | osid.id.Id | resourceId | the Id of the Agent to monitor |
Errors | NULL_ARGUMENT | agentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGradeEntry | ||
Description |
Registers for notification of a deleted grade entry.
| ||
Parameters | osid.id.Id | gradeEntryId | the Id of the GradeEntry to monitor |
Errors | NULL_ARGUMENT | gradeEntryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |