Interface | osid.grading.GradebookNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForGradebookNotifications | ||
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 | registerForNewGradebooks | ||
Description |
Register for notifications of new gradebooks. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewGradebookAncestors | ||
Description |
Registers for notification if an ancestor is added to
the specified gradebook in the gradebook hierarchy. | ||
Parameters | osid.id.Id | gradebookId | the Id of the gradebook to monitor |
Errors | NULL_ARGUMENT | gradebookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewGradebookDescendants | ||
Description |
Registers for notification if a descendant is added to
the specified gradebook in the gradebook hierarchy. | ||
Parameters | osid.id.Id | gradebookId | the Id of the gradebook to monitor |
Errors | NULL_ARGUMENT | gradebookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGradebooks | ||
Description |
Registers for notification of updated gradebooks.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedGradebook | ||
Description |
Registers for notification of an updated gradebook.
| ||
Parameters | osid.id.Id | gradebookId | the Id of the gradebook to monitor |
Errors | NULL_ARGUMENT | gradebookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGradebooks | ||
Description |
Registers for notification of deleted gradebooks.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGradebook | ||
Description |
Registers for notification of a deleted gradebook.
| ||
Parameters | osid.id.Id | gradebookId | the Id of the gradebook to monitor |
Errors | NULL_ARGUMENT | gradebookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGradebookAncestors | ||
Description |
Registers for notification if an ancestor is removed
from the specified gradebook in the gradebook hierarchy.
| ||
Parameters | osid.id.Id | gradebookId | the Id of the gradebook to monitor |
Errors | NULL_ARGUMENT | gradebookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedGradebookDescendants | ||
Description |
Registers for notification if a descendant is removed
from fthe specified gradebook in the calndar hierarchy.
| ||
Parameters | osid.id.Id | gradebookId | the Id of the gradebook to monitor |
Errors | NULL_ARGUMENT | gradebookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |