OSID - osid.assessment.AssessmentTakenBankSession Service Interface Definition

Interface	osid.assessment.AssessmentTakenBankSession
Implements	`osid.OsidSession`
Used By	`osid.assessment.AssessmentManager`
Used By	`osid.assessment.AssessmentProxyManager`
Description	This session provides methods to retrieve `AssessmentTaken` to `Bank` mappings. An `AssessmentTaken` may appear in multiple `Banks` . Each `Bank` may have its own authorizations governing who is allowed to look at it. This lookup session defines two views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupAssessmentTakenBankMappings
Description	Tests if this user can perform lookups of assessment taken/bank mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBankView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as assessment, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryBankView
Description	A complete view of the `AssessmentTaken` and `Bank` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getAssessmentTakenIdsByBank
Description	Gets the list of `AssessmentTaken` `Ids` associated with a `Bank` .
Parameters	`osid.id.Id`	`bankId`	`Id` of the `Bank`
Return	`osid.id.IdList`		list of related assessment taken `Ids`
Errors	NOT_FOUND		`bankId` is not found
	NULL_ARGUMENT		`bankId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByBank
Description	Gets the list of `AssessmentTakens` associated with a `Bank` .
Parameters	`osid.id.Id`	`bankId`	`Id` of the `Bank`
Return	`osid.assessment.AssessmentTakenList`		list of related assessments taken
Errors	NOT_FOUND		`bankId` is not found
	NULL_ARGUMENT		`bankId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentTakenIdsByBanks
Description	Gets the list of `AssessmentTakenIds` corresponding to a list of `Banks` .
Parameters	`osid.id.IdList`	`bankIds`	list of bank `Ids`
Return	`osid.id.IdList`		list of bank `Ids`
Errors	NULL_ARGUMENT		`bankIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByBanks
Description	Gets the list of `AssessmentTaken` objects corresponding to a list of `Banks` .
Parameters	`osid.id.IdList`	`bankIds`	list of bank `Ids`
Return	`osid.assessment.AssessmentTakenList`		list of assessments taken
Errors	NULL_ARGUMENT		`bankIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getBankIdsByAssessmentTaken
Description	Gets the list of `Bank` `Ids` mapped to an `AssessmentTaken` .
Parameters	`osid.id.Id`	`assessmentTakenId`	`Id` of an `AssessmentTaken`
Return	`osid.id.IdList`		list of bank `Ids`
Errors	NOT_FOUND		`assessmentTakenId` is not found
	NULL_ARGUMENT		`assessmentTakenId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getBanksByAssessmentTaken
Description	Gets the list of `Banks` mapped to an `AssessmentTaken` .
Parameters	`osid.id.Id`	`assessmentTakenId`	`Id` of an `AssessmentTaken`
Return	`osid.assessment.BankList`		list of banks
Errors	NOT_FOUND		`assessmentTakenId` is not found
	NULL_ARGUMENT		`assessmentTakenId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.