OSID - osid.grading.GradeEntryNotificationSession Service Interface Definition

Interface	osid.grading.GradeEntryNotificationSession
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 `GradeEntry` 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 `GradeEntryLookupSession`.
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	canRegisterForGradeEntryNotifications
Description	Tests if this user can register for `GradeEntry` 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 entries 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	reliableGradeEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeGradeEntryNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableGradeEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeGradeEntryNotification
Description	Acknowledge a grade entry 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	registerForNewGradeEntries
Description	Register for notifications of new grade entries. `GradeEntryReceiver.newGradeEntries()` is invoked when a new grade entry is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewGradeEntriesForGradebookColumn
Description	Registers for notification of a new grade entry for the specified gradebook column. `GradeEntryReceiver.newGradeEntries()` is invoked when a new entry for the resource is created.
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	registerForNewGradeEntriesForResource
Description	Registers for notification of a new grade entry for the specified resource. `GradeEntryReceiver.newGradeEntries()` is invoked when a new entry for the resource is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewGradeEntriesByGrader
Description	Registers for notification of a new grade entry for the specified grader agent. `GradeEntryReceiver.newGradeEntries()` is invoked when a new entry for the grader is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Agent` to monitor
Errors	NULL_ARGUMENT		`agentId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradeEntries
Description	Registers for notification of updated grade entries. `GradeEntryReceiver.changedGradeEntries()` is invoked when a grade entry is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradeEntriesForGradebookColumn
Description	Registers for notification of an updated grade entry for the specified gradebook column. `GradeEntryReceiver.changedGradeEntries()` is invoked when an entry for the column is updated.
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	registerForChangedGradeEntriesForResource
Description	Registers for notification of an updated grade entry for the specified key resource. `GradeEntryReceiver.changedGradeEntries()` is invoked when an entry for the resource is updated.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradeEntriesByGrader
Description	Registers for notification of an updated grade entry for the specified grader. `GradeEntryReceiver.changedGradeEntries()` is invoked when an entry for the agent is updated.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Agent` to monitor
Errors	NULL_ARGUMENT		`agentId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradeEntry
Description	Registers for notification of an updated grade entry. `GradeEntryReceiver.changedGradeEntries()` is invoked when the specified grade entry is changed.
Parameters	`osid.id.Id`	`gradeEntryId`	the `Id` of the `GradeEntry` to monitor
Errors	NULL_ARGUMENT		`gradeEntryId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGradeEntries
Description	Registers for notification of deleted grade entries. `GradeEntryReceiver.deletedGradeEntries()` is invoked when a grade entry is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGradeEntriesForGradebookColumn
Description	Registers for notification of a deleted grade entry for the specified gradebook column. `GradeEntryReceiver.changedGradeEntries()` is invoked when an entry for the column is removed from this 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.
Method	registerForDeletedGradeEntriesForResource
Description	Registers for notification of a deleted grade entry for the specified key resource. `GradeEntryReceiver.changedGradeEntries()` is invoked when an entry for the resource is removed from this gradebook.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGradeEntriesByGrader
Description	Registers for notification of a deleted grade entry for the specified grader. `GradeEntryReceiver.changedGradeEntries()` is invoked when an entry for the agent is removed from this gradebook.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Agent` to monitor
Errors	NULL_ARGUMENT		`agentId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGradeEntry
Description	Registers for notification of a deleted grade entry. `GradeEntryReceiver.deletedGradeEntries()` is invoked when the specified entry is deleted.
Parameters	`osid.id.Id`	`gradeEntryId`	the `Id` of the `GradeEntry` to monitor
Errors	NULL_ARGUMENT		`gradeEntryId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.