OSID - osid.assessment.AssessmentQuerySession Service Interface Definition

Interface	osid.assessment.AssessmentQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.assessment.AssessmentSearchSession`
Used By	`osid.assessment.AssessmentManager`
Used By	`osid.assessment.AssessmentProxyManager`
Description	This session provides methods for querying `Assessment` objects. The search query is constructed using the `AssessmentQuery`. This session defines views that offer differing behaviors for searching. federated bank view: searches include assessments in banks of which this bank is an ancestor in the bank hierarchy isolated bank view: searches are restricted to assessments in this bank Assessments may have a query record indicated by their respective record types. The query record is accessed via the `AssessmentQuery`. The returns in this session may not be cast directly to these interfaces.
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	canSearchAssessments
Description	Tests if this user can perform `Assessment` searches. 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 wish not to offer search 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 assessments 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 searches to this bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAssessmentQuery
Description	Gets an assessment query.
Return	`osid.assessment.AssessmentQuery`		the assessment query
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsByQuery
Description	Gets a list of `Assessments` matching the given assessment query.
Parameters	`osid.assessment.AssessmentQuery`	`assessmentQuery`	the assessment query
Return	`osid.assessment.AssessmentList`		the returned `AssessmentList`
Errors	NULL_ARGUMENT		`assessmentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`assessmentQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.