OSID - osid.assessment.ItemLookupSession Service Interface Definition

Interface	osid.assessment.ItemLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Item` objects. This session defines two sets of views which offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete and ordered result set or is an error condition isolated assessment bank view: All assessment item methods in this session operate, retrieve and pertain to assessment items defined explicitly in the current bank. Using an isolated view is useful for managing items with the `ItemAdminSession.` federated assessment bank view: All assessment item methods in this session operate, retrieve and pertain to all assessment items defined in this assessment bank and any other assessment banks implicitly available in this assessment bank through assessment bank inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there a particular element is inaccessible. For example, a hierarchy output can be plugged into a lookup method to retrieve all objects known to a hierarchy, but it may not be necessary to break execution if a node from the hierarchy no longer exists. However, some administrative applications may need to know whether it had retrieved an entire set of objects and may sacrifice some interoperability for the sake of precision. Items may have an additional records indicated by their respective record types.
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	canLookupItems
Description	Tests if this user can perform `Item` lookups. 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 lookup operations.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeItemView
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	usePlenaryItemView
Description	A complete view of the `Item` 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	useFederatedBankView
Description	Federates the view for methods in this session. A federated view will include assessment items in assessment banks which are children of this assessment bank in the assessment 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 lookups to this assessment bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	getItem
Description	Gets the `Item` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Item` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Item` and retained for compatibility.
Parameters	`osid.id.Id`	`itemId`	the `Id` of the `Item` to retrieve
Return	`osid.assessment.Item`		the returned `Item`
Errors	NOT_FOUND		no `Item` found with the given `Id`
	NULL_ARGUMENT		`itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByIds
Description	Gets an `ItemList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the items specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Items` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`itemIds`	the list of `Ids` to retrieve
Return	`osid.assessment.ItemList`		the returned `Item` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`itemIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByGenusType
Description	Gets an `ItemList` corresponding to the given assessment item genus `Type` which does not include assessment items of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known assessment items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
Parameters	`osid.type.Type`	`itemGenusType`	an assessment item genus type
Return	`osid.assessment.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`itemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByParentGenusType
Description	Gets an `ItemList` corresponding to the given assessment item genus `Type` and include any additional assessment items with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known assessment items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
Parameters	`osid.type.Type`	`itemGenusType`	an assessment item genus type
Return	`osid.assessment.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`itemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByRecordType
Description	Gets an `ItemList` containing the given assessment item record `Type.` In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
Parameters	`osid.type.Type`	`itemRecordType`	an item record type
Return	`osid.assessment.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`itemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByQuestion
Description	Gets an `ItemList` containing the given question. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
Parameters	`osid.id.Id`	`questionId`	a question `Id`
Return	`osid.assessment.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`questionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByAnswer
Description	Gets an `ItemList` containing the given answer. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
Parameters	`osid.id.Id`	`answerId`	an answer `Id`
Return	`osid.assessment.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`answerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByLearningObjective
Description	Gets an `ItemList` containing the given learning objective. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
Parameters	`osid.id.Id`	`objectiveId`	a learning objective `Id`
Return	`osid.assessment.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`objectiveId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByLearningObjectives
Description	Gets an `ItemList` containing the given learning objectives. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
Parameters	`osid.id.IdList`	`objectiveIds`	a list of learning objective `Ids`
Return	`osid.assessment.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`objectiveIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getItems
Description	Gets all `Items.` In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
Return	`osid.assessment.ItemList`		a list of `Items`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.