OSID - osid.assessment.AssessmentSearchSession Service Interface Definition

Interface	osid.assessment.AssessmentSearchSession
Implements	`osid.assessment.AssessmentQuerySession`
Used By	`osid.assessment.AssessmentManager`
Used By	`osid.assessment.AssessmentProxyManager`
Description	This session provides methods for searching among `Assessment` objects. The search query is constructed using the `AssessmentQuery` . `getAssessmentsByQuery()` is the basic search method and returns a list of `Assessments` . A more advanced search may be performed with `getAssessmentsBySearch()` .It accepts an `AssessmentSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAssessmentsBySearch()` returns an `AssessmentSearchResults` that can be used to access the resulting `AssessmentList` or be used to perform a search within the result set through `AssessmentSearch` . 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` .
Method	getAssessmentSearch
Description	Gets an assessment search.
Return	`osid.assessment.AssessmentSearch`		the assessment search
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentSearchOrder
Description	Gets an assessment search order. The `AssessmentSearchOrder` is supplied to an `AssessmentSearch` to specify the ordering of results.
Return	`osid.assessment.AssessmentSearchOrder`		the assessment search order
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.assessment.AssessmentQuery`	`assessmentQuery`	the assessment query
Parameters	`osid.assessment.AssessmentSearch`	`assessmentSearch`	the assessment search
Return	`osid.assessment.AssessmentSearchResults`		the search results
Errors	NULL_ARGUMENT		`assessmentQuery` or `assessmentSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`assessmentQuery` or `assessmentSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentQueryFromInspector
Description	Gets an assessment query from an inspector. The inspector is available from an `AssessmentSearchResults` .
Parameters	`osid.assessment.AssessmentQueryInspector`	`assessmentQueryInspector`	an assessment query inspector
Return	`osid.assessment.AssessmentQuery`		the assessment query
Errors	NULL_ARGUMENT		`assessmentQueryInspector` is `null`
Errors	UNSUPPORTED		`assessmentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.