OSID - osid.grading.GradebookNotificationSession Service Interface Definition

Interface	osid.grading.GradebookNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
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.
Method	canRegisterForGradebookNotifications
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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	reliableGradebookNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeGradebookNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableGradebookNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeGradebookNotification
Description	Acknowledge a gradebook notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewGradebooks
Description	Register for notifications of new gradebooks. `GradebookReceiver.newGradebooks()` is invoked when a new `Gradebook` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradebooks
Description	Registers for notification of updated gradebooks. `GradebookReceiver.changedGradebooks()` is invoked when a gradebook is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradebook
Description	Registers for notification of an updated gradebook. `GradebookReceiver.changedGradebooks()` is invoked when the specified gradebook is changed.
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. `GradebookReceiver.deletedGradebooks()` is invoked when a calenedar is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGradebook
Description	Registers for notification of a deleted gradebook. `GradebookReceiver.deletedGradebooks()` is invoked when the specified gradebook is deleted.
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	registerForChangedGradebookHierarchy
Description	Registers for notification of an updated gradebook hierarchy structure. `GradebookReceiver.changedChildOfGradebooks()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradebookHierarchyForAncestors
Description	Registers for notification of an updated gradebook hierarchy structure. `GradebookReceiver.changedChildOfGradebooks()` is invoked when a node experiences a change in its ancestors.
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of the `Gradebook` node 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	registerForChangedGradebookHierarchyForDescendants
Description	Registers for notification of an updated gradebook hierarchy structure. `GradebookReceiver.changedChildOfGradebooks()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`gradebookId`	the `Id` of the `Gradebook` node 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.