OSID - osid.assessment.authoring.AssessmentPartLookupSession Service Interface Definition

Interface	osid.assessment.authoring.AssessmentPartLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving assessment parts. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated bank view: All assessment part methods in this session operate, retrieve and pertain to assessment parts defined explicitly in the current bank. federated bank view: All assessment part lookup methods in this session operate, retrieve and pertain to all assessment part defined in this bank and any other assessment parts implicitly available in this bank through bank inheritence. active assessment part view: All assessment part lookup methods return active assessment parts. any status assessment part view: Assessment parts of any active or inactive status are returned from methods. sequestered assessment part viiew: All assessment part methods suppress sequestered assessment parts. unsequestered assessment part view: All assessment part methods return all assessment parts. The methods `useFederatedBankView()` and `useIsolatedBankView()` behave as a radio group and one should be selected before invoking any lookup methods. Assessment parts may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `AssessmentPart.`
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	canLookupAssessmentParts
Description	Tests if this user can perform `AssessmentPart` 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeAssessmentPartView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, 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	usePlenaryAssessmentPartView
Description	A complete view of the `AssessmentPart` 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 parts in catalogs which are children of this catalog 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 retrievals to this bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveAssessmentPartView
Description	Only active assessment parts are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusAssessmentPartView
Description	All active and inactive assessment parts are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useSequesteredAssessmentPartView
Description	The methods in this session omit sequestered assessment parts.
Compliance	`mandatory`		This method is must be implemented.
Method	useUnsequesteredAssessmentPartView
Description	The methods in this session return all assessment parts, including sequestered assessment parts.
Compliance	`mandatory`		This method is must be implemented.
Method	getAssessmentPart
Description	Gets the `AssessmentPart` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `AssessmentPart` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `AssessmentPart` and retained for compatibility. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart` to retrieve
Return	`osid.assessment.authoring.AssessmentPart`		the returned `AssessmentPart`
Errors	NOT_FOUND		no `AssessmentPart` found with the given `Id`
	NULL_ARGUMENT		`assessmentPartId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartsByIds
Description	Gets an `AssessmentPartList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the assessment parts 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 `AssessmentParts` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
Parameters	`osid.id.IdList`	`assessmentPartIds`	the list of `Ids` to retrieve
Return	`osid.assessment.authoring.AssessmentPartList`		the returned `AssessmentPart` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`assessmentPartIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartsByGenusType
Description	Gets an `AssessmentPartList` corresponding to the given assessment part genus `Type` which does not include assessment parts of types derived from the specified `Type.` In plenary mode, the returned list contains all known assessment parts or an error results. Otherwise, the returned list may contain only those assessment parts that are accessible through this session. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
Parameters	`osid.type.Type`	`assessmentPartGenusType`	an assessment part genus type
Return	`osid.assessment.authoring.AssessmentPartList`		the returned `AssessmentPart` list
Errors	NULL_ARGUMENT		`assessmentPartGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartsByParentGenusType
Description	Gets an `AssessmentPartList` corresponding to the given assessment part genus `Type` and include any additional assessment parts with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known assessment parts or an error results. Otherwise, the returned list may contain only those assessment parts that are accessible through this session. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
Parameters	`osid.type.Type`	`assessmentGenusType`	an assessment part genus type
Return	`osid.assessment.authoring.AssessmentPartList`		the returned `AssessmentPart` list
Errors	NULL_ARGUMENT		`assessmentPartGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartsByRecordType
Description	Gets an `AssessmentPart` containing the given assessment part record `Type.` In plenary mode, the returned list contains all known assessment parts or an error results. Otherwise, the returned list may contain only those assessment parts that are accessible through this session. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
Parameters	`osid.type.Type`	`assessmentPartRecordType`	an assessment part record type
Return	`osid.assessment.authoring.AssessmentPartList`		the returned `AssessmentPart` list
Errors	NULL_ARGUMENT		`assessmentPartRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartsForAssessment
Description	Gets an `AssessmentPart` for the given assessment. In plenary mode, the returned list contains all known assessment parts or an error results. Otherwise, the returned list may contain only those assessment parts that are accessible through this session. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
Parameters	`osid.id.Id`	`assessmentId`	an assessment `Id`
Return	`osid.assessment.authoring.AssessmentPartList`		the returned `AssessmentPart` list
Errors	NULL_ARGUMENT		`assessmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentParts
Description	Gets all `AssessmentParts.` In plenary mode, the returned list contains all known assessment parts or an error results. Otherwise, the returned list may contain only those assessment parts that are accessible through this session. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
Return	`osid.assessment.authoring.AssessmentPartList`		a list of `AssessmentParts`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.