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

Interface	osid.assessment.authoring.AssessmentPartQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `AssessmentPart` objects. The search query is constructed using the `AssessmentPartQuery.` This session defines views that offer differing behaviors for searching. federated bank view: searches include assessment parts in bank of which this bank is an ancestor in the bank hierarchy isolated bank view: searches are restricted to assessment parts in this bank sequestered assessment part viiew: All assessment part methods suppress sequestered assessment parts. unsequestered assessment part view: All assessment part methods return all assessment parts. Assessment parts may have a query record indicated by their respective record types. The query record is accessed via the `AssessmentPartQuery.`
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchAssessmentParts
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 search 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 assessment part in banks which are children of this step 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 lookups to this bank only.
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	getAssessmentPartQuery
Description	Gets an assessment part query.
Return	`osid.assessment.authoring.AssessmentPartQuery`		the assessment part query
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartsByQuery
Description	Gets a list of `AssessmentParts` matching the given assessment part query.
Parameters	`osid.assessment.authoring.AssessmentPartQuery`	`assessmentPartQuery`	the assessment part query
Return	`osid.assessment.authoring.AssessmentPartList`		the returned `AssessmentPartList`
Errors	NULL_ARGUMENT		`assessmentPartQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`assessmentPartQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.