OSID - osid.assessment.AssessmentNotificationSession Service Interface Definition

Interface	osid.assessment.AssessmentNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Assessment` objects in this `Bank.` 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 `AssessmentLookupSession.`
Method	getBankId
Description	Gets the `Bank` `Id` associated with this session.
Return	`osid.id.Id`		the `Bank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBank
Description	Gets the `Bank` associated with this session.
Return	`osid.assessment.Bank`		the `Bank` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAssessmentNotifications
Description	Tests if this user can register for `Assessment` 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	useFederatedBankView
Description	Federates the view for methods in this session. A federated view will include notifications for assessments in banks which are children of this bank in the bank hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBankView
Description	Isolates the view for methods in this session. An isolated view restricts notifications for assessments to this bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableAssessmentNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAssessmentNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAssessmentNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAssessmentNotification
Description	Acknowledge an assessment 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	registerForNewAssessments
Description	Register for notifications of new assessments. `AssessmentReceiver.newAssessments()` is invoked when a new `Assessment` appears in this assessment bank.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAssessments
Description	Registers for notification of updated assessments. `AssessmentReceiver.changedAssessments()` is invoked when an assessment in this assessment bank is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAssessment
Description	Registers for notification of an updated assessment. `AssessmentReceiver.changedAssessments()` is invoked when the specified assessment in this assessment bank is changed.
Parameters	`osid.id.Id`	`assessmentId`	the `Id` of the `Assessment` to monitor
Errors	NULL_ARGUMENT		`assessmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAssessments
Description	Registers for notification of deleted assessments. `AssessmentReceiver.deletedAssessments()` is invoked when an assessment is removed from this assessment bank.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAssessment
Description	Registers for notification of a deleted assessment. `AssessmentReceiver.deletedAssessments()` is invoked when the specified assessment is removed from this assessment bank.
Parameters	`osid.id.Id`	`assessmentId`	the `Id` of the `Assessment` to monitor
Errors	NULL_ARGUMENT		`assessmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.