OSID - osid.grading.GradebookColumnNotificationSession Service Interface Definition

Interface	osid.grading.GradebookColumnNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
Description	This session defines methods to receive asynchronous notifications on adds/changes to `GradebookColumn` 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 `GradebookColumnLookupSession`.
Method	getGradebookId
Description	Gets the `Gradebook` `Id` associated with this session.
Return	`osid.id.Id`		the `Gradebook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getGradebook
Description	Gets the `Gradebook` associated with this session.
Return	`osid.grading.Gradebook`		the `Gradebook` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForGradebookColumnNotifications
Description	Tests if this user can register for `GradebookColumn` 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	useFederatedGradebookView
Description	Federates the view for methods in this session. A federated view will include notifications for gradebook columns 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	reliableGradebookColumnNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeGradebookColumnNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableGradebookColumnNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeGradebookColumnNotification
Description	Acknowledge a gradebook column 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	registerForNewGradebookColumns
Description	Register for notifications of new gradebook columns. `GradebookColumnReceiver.newGradebookColumns()` is invoked when a new column is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradebookColumns
Description	Registers for notification of updated gradebook columns. `GradebookColumnReceiver.changedGradebookColumns()` is invoked when a gradebook column is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradebookColumn
Description	Registers for notification of an updated gradebook column. `GradebookColumnReceiver.changedGradebookColumns()` is invoked when the specified gradebook column is changed.
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	registerForDeletedGradebookColumns
Description	Registers for notification of deleted gradebook columns. `GradebookColumnReceiver.deletedGradebookColumns()` is invoked when a gradebook column is removed from this gradebook.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGradebookColumn
Description	Registers for notification of a deleted gradebook column. `GradebookColumnReceiver.deletedGradebookColumns()` is invoked when the specified column is removed from thia gradebook.
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.