OSID - osid.assessment.AssessmentTakenNotificationSession Service Interface Definition

Interface	osid.assessment.AssessmentTakenNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `AssessmentTaken` 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 `AssessmentTakenLookupSession.`
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	canRegisterForAssessmentTakenNotifications
Description	Tests if this user can register for `AssessmentTaken` 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 taken 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 taken to this bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableAssessmentTakenNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAssessmentTakenNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAssessmentTakenNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAssessmentTakenNotification
Description	Acknowledge an assessment taken 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	registerForNewAssessmentsTaken
Description	Register for notifications of new assessments taken in this assessment bank. `AssessmentTakenReceiver.newAssessmentsTaken()` is invoked when a new `AssessmentTaken` 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	registerForNewAssessmentsTakenForTaker
Description	Register for notifications of new assessments taken for a resource. `AssessmentTakenReceiver.newAssessmenstTaken()` is invoked when a new `AssessmentTaken` appears in this assessment bank.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`assessmentOfferedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAssessmentsTakenForAssessmentOffered
Description	Register for notifications of new assessments taken for an assessment offered. `AssessmentTakenReceiver.newAssessmentsTaken()` is invoked when a new `AssessmentTaken` appears in this assessment bank.
Parameters	`osid.id.Id`	`assessmentOfferedId`	the `Id` of the `AssessmentOffered` to monitor
Errors	NULL_ARGUMENT		`assessmentOfferedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAssessmentsTakenForAssessment
Description	Register for notifications of new assessments taken for an assessment. `AssessmentTakenReceiver.newAssessmentsTaken()` is invoked when a new `AssessmentTaken` appears in 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.
Method	registerForChangedAssessmentsTaken
Description	Registers for notification of updated assessments taken. `AssessmentTakenReceiver.changedAssessmentsTaken()` is invoked when an assessment taken 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	registerForChangedAssessmentsTakenForTaker
Description	Register for notifications of changed assessments taken for a resource. `AssessmentTakenReceiver.changedAssessmentsTaken()` is invoked when an `AssessmentTaken` is changed in this assessment bank.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`assessmentOfferedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAssessmentsTakenForAssessmentOffered
Description	Register for notifications of changed assessments taken for an assessment offered. `AssessmentTakenReceiver.changedAssessmentsTaken()` is invoked when an `AssessmentTaken` is changed in this assessment bank.
Parameters	`osid.id.Id`	`assessmentOfferedId`	the `Id` of the `AssessmentOffered` to monitor
Errors	NULL_ARGUMENT		`assessmentOfferedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAssessmentsTakenForAssessment
Description	Register for notifications of changed assessments taken for an assessment. `AssessmentTakenReceiver.changedAssessmentsTaken()` is invoked when an `AssessmentTaken` is changed in 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.
Method	registerForChangedAssessmentTaken
Description	Registers for notification of an updated assessment taken. `AssessmentTakenReceiver.changedAssessmentsTaken()` is invoked when the specified assessment taken in this assessment bank is changed.
Parameters	`osid.id.Id`	`assessmentTakenId`	the `Id` of the `AssessmentTaken` to monitor
Errors	NULL_ARGUMENT		`assessmentTakenId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAssessmentsTaken
Description	Registers for notification of deleted assessments taken. `AssessmentTakenReceiver.deletedAssessmentsTaken()` is invoked when an assessment taken 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	registerForDeletedAssessmentsTakenForTaker
Description	Register for notifications of deleted assessments taken for a resource. `AssessmentTakenReceiver.deletedAssessmentsTaken()` is invoked when an `AssessmentTaken` is removed from this assessment bank.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`assessmentOfferedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAssessmentsTakenForAssessmentOffered
Description	Register for notifications of deleted assessments taken for an assessment offered. `AssessmentTakenReceiver.deletedAssessmentsTaken()` is invoked when an `AssessmentTaken` is removed from this assessment bank.
Parameters	`osid.id.Id`	`assessmentOfferedId`	the `Id` of the `AssessmentOffered` to monitor
Errors	NULL_ARGUMENT		`assessmentOfferedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAssessmentsTakenForAssessment
Description	Register for notifications of deleted assessments taken for an assessment. `AssessmentTakenReceiver.deletedAssessmentsTaken()` is invoked when an `AssessmentTaken` 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.
Method	registerForDeletedAssessmentTaken
Description	Registers for notification of a deleted assessment taken. `AssessmentTakenReceiver.deletedAssessmentsTaken()` is invoked when the specified assessment taken is removed from this assessment bank.
Parameters	`osid.id.Id`	`assessmentTakenId`	the `Id` of the `AssessmentTaken` to monitor
Errors	NULL_ARGUMENT		`assessmentTakenId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.