OSID - osid.grading.transform.GradeSystemTransformNotificationSession Service Interface Definition

Interface	osid.grading.transform.GradeSystemTransformNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.grading.transform.GradingTransformManager`
Used By	`osid.grading.transform.GradingTransformProxyManager`
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	canRegisterForGradeSystemTransformNotifications
Description	Tests if this user can register for `GradeSystemTransform` 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 system transforms 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	acknowledgeGradeSystemTransformNotification
Description	Acknowledge a grade system transform 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	registerForNewGradeSystemTransforms
Description	Register for notifications of new grade system transforms. `GradeSystemTransformReceiver.newGradeSystemTransforms()` is invoked when a new `GradeSystemTransform` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradeSystemTransforms
Description	Registers for notification of updated grade system transforms. `GradeSystemTransformReceiver.changedGradeSystemTransforms()` is invoked when a transform is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGradeSystemTransform
Description	Registers for notification of an updated grade system transform. `GradeSystemTransformReceiver.changedGradeSystemTransforms()` is invoked when the specified grade system transform is changed.
Parameters	`osid.id.Id`	`gradeSystemTransformId`	the `Id` of the grade system transform to monitor
Errors	NULL_ARGUMENT		`gradeSystemTransformId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGradeSystemTransforms
Description	Registers for notification of deleted grade system transforms. `GradeSystemTransformReceiver.deletedGradeSystemTransforms()` is invoked when a grade system transform 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	registerForDeletedGradeSystemTransform
Description	Registers for notification of a deleted grade system transform. `GradeSystemTransformReceiver.deletedGradeSystemTransforms()` is invoked when the specified system transform is removed from this gradebook.
Parameters	`osid.id.Id`	`gradeSystemTransformId`	the `Id` of the grade system transform to monitor
Errors	NULL_ARGUMENT		`gradeSystemTransformId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.