OSID - osid.assessment.AssessmentTakenSearchSession Service Interface Definition

Interface	osid.assessment.AssessmentTakenSearchSession
Implements	`osid.assessment.AssessmentTakenQuerySession`
Used By	`osid.assessment.AssessmentManager`
Used By	`osid.assessment.AssessmentProxyManager`
Description	This session provides methods for searching among `AssessmentTaken` objects. The search query is constructed using the `AssessmentTakenQuery` . `getAssessmentsTakenByQuery()` is the basic search method and returns a list of `AssessmentTaken` elements. A more advanced search may be performed with `getAssessmentsTakenBySearch()` . It accepts an `AssessmentTakenSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAssessmentsTakenBySearch()` returns an `AssessmentTakenSearchResults` that can be used to access the resulting `AssessmenTakenList` or be used to perform a search within the result set through `AssessmentTakenSearch` . This session defines views that offer differing behaviors for searching. federated bank view: searches include assessments taken in banks of which this bank is an ancestor in the bank hierarchy isolated bank view: searches are restricted to assessments taken in this bank Assessments taken may have query records indicated by their respective record types. The query record is accessed via the `AssessmentTakenQuery` .
Method	getAssessmentTakenSearch
Description	Gets an assessment taken search.
Return	`osid.assessment.AssessmentTakenSearch`		the assessment taken search
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentTakenSearchOrder
Description	Gets an assessment taken search order. The `AssessmentTakenSearchOrder` is supplied to an `AssessmentTakenSearch` to specify the ordering of results.
Return	`osid.assessment.AssessmentTakenSearchOrder`		the assessment taken search order
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenBySearch
Description	Gets the search results matching the given search query using the given assessment taken query.
Parameters	`osid.assessment.AssessmentTakenQuery`	`assessmentTakenQuery`	the assessment taken query
Parameters	`osid.assessment.AssessmentTakenSearch`	`assessmentTakenSearch`	the assessment taken search
Return	`osid.assessment.AssessmentTakenSearchResults`		the assessment taken search results
Errors	NULL_ARGUMENT		`assessmentTakenQuery` or `assessmentTakenSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`assessmentTakenQuery` or `assessmentTakenSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentTakenQueryFromInspector
Description	Gets an assessment taken query from an inspector. The inspector is available from an `AssessmentTakenSearchResults` .
Parameters	`osid.assessment.AssessmentTakenQueryInspector`	`assessmentTakenQueryInspector`	an assessment taken query inspector
Return	`osid.assessment.AssessmentTakenQuery`		the assessment taken query
Errors	NULL_ARGUMENT		`assessmentTakenQueryInspector` is `null`
Errors	UNSUPPORTED		`assessmentTakenQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.