OSID - osid.grading.GradeSystemNotificationSession Service Interface Definition

Interface	osid.grading.GradeSystemNotificationSession
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 `GradeSystems` and the Grades defined within.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	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	canRegisterForGradeSystemNotifications
Description	Tests if this user can register for `GradeSystem` 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 grade systems 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	reliableGradeSystemNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeGradeSystemNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableGradeSystemNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeGradeSystemNotification
Description	Acknowledge a grade system 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	registerForNewGradeSystems
Description	Register for notifications of new grade systems. `GradeSystemReceiver.newGradeSystems()` is invoked when a new `GradeSystem` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradeSystems
Description	Registers for notification of updated grade systems. `GradeSystemReceiver.changedGradeSystems()` is invoked when a system is changed or grades are changed within it.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradeSystem
Description	Registers for notification of an updated grade system. `GradeSystemReceiver.changedGradeSystems()` is invoked when the specified grade system is changed or grades are changed within it.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of the grade system to monitor
Errors	NULL_ARGUMENT		`gradeSystemId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGradeSystems
Description	Registers for notification of deleted grade systems. `GradeSystemReceiver.deletedGradeSystems()` is invoked when a grade system 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	registerForDeletedGradeSystem
Description	Registers for notification of a deleted grade system. `GradeSystemReceiver.deletedGradeSystems()` is invoked when the specified system is removed from this gradebook.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of the grade system to monitor
Errors	NULL_ARGUMENT		`gradeSystemId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.