OSID - osid.grading.GradeNotificationSession Service Interface Definition

Interface	osid.grading.GradeNotificationSession
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 `Grades` in this `Gradebook` . This also includes existing grades that may appear or disappear due to changes in the `Gradebook hiera` rchy, 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 two views defined in this session correspond to the views in the GradeLookupSession.
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForGradeNotifications
Description	Tests if this user can register for `Grade` 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 grades 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	reliableGradeNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeGradeNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableGradeNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeGradeNotification
Description	Acknowledge a grade 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	registerForNewGrades
Description	Register for notifications of new grades. `GradeReceiver.newGrades()` is invoked when a new `Grade` appears in this gradebook.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewGradesForGradeSystem
Description	Register for notifications of new grades for the given grade system. `GradeReceiver.newGrades()` is invoked when a new `Grade` appears in this gradebook.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of the `GradeSystem` 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	registerForChangedGrades
Description	Register for notifications of updated grades. `GradeReceiver.changedGrades()` is invoked when a `Grade` in this gradebook is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradesForGradeSystem
Description	Register for notifications of updated grades for the given grade system. `GradeReceiver.changedGrades()` is invoked when a `Grade` in this gradebook is changed.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of the `GradeSystem` 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	registerForChangedGrade
Description	Register for notifications of an updated grade. `GradeReceiver.changedGrades()` is invoked when the specified `Grade` in this gradebook is changed.
Parameters	`osid.id.Id`	`gradeId`	the `Id` of the `Grade` to monitor
Errors	NULL_ARGUMENT		`gradeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGrades
Description	Registers for notification of deleted grades. `GradeReceiver.deletedGrades()` is invoked when a grade is deleted or removed from this gradebook.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGradesForGradeSystem
Description	Register for notifications of deleted grades for the given grade system. `GradeReceiver.deletedGrades()` is invoked when a `Grade` in this gradebook is deleted or removed.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of the `GradeSystem` 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	registerForDeletedGrade
Description	Registers for notification of a deleted grade. `GradeReceiver.deletedGrades()` is invoked when the specified grade is deleted or removed from this gradebook.
Parameters	`osid.id.Id`	`gradeId`	the `Id` of the `Grade` to monitor
Errors	NULL_ARGUMENT		`gradeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.