OSID - osid.grading.GradeSystemSearchSession Service Interface Definition

Interface	osid.grading.GradeSystemSearchSession
Implements	`osid.grading.GradeSystemQuerySession`
Description	This session provides methods for searching among `GradeSystems.` The search query is constructed using the `GradeSystemQuery.` `getGradeSystemsByQuery()` is the basic search method and returns a list of `GradeSystems.` A more advanced search may be performed with `getGradeSystemsBySearch().` It accepts a `GradeSystemSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getGradeSystemsBySearch()` returns a `GradeSystemSearchResults` that can be used to access the resulting `GradeSystemList` or be used to perform a search within the result set through `GradeSystemSearch.` This session defines views that offer differing behaviors for searching. federated gradebook view: searches include grade systems in gradebooks of which this gradebook is a ancestor in the gradebook hierarchy isolated gradebook view: searches are restricted to grade systems in this gradebook Grade systems may have a query record indicated by their respective record types. The query record is accessed via the `GradeSystemQuery.`
Method	getGradeSystemSearch
Description	Gets a grade system search.
Return	`osid.grading.GradeSystemSearch`		a grade system search
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemSearchOrder
Description	Gets a grade system search order. The `GradeSystemSearchOrder` is supplied to a `GradeSystemSearch` to specify the ordering of results.
Return	`osid.grading.GradeSystemSearchOrder`		the grade system search order
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.grading.GradeSystemQuery`	`gradeSystemQuery`	the grade system query
Parameters	`osid.grading.GradeSystemSearch`	`gradeSystemSearch`	the grade system search
Return	`osid.grading.GradeSystemSearchResults`		the grade system search results
Errors	NULL_ARGUMENT		`gradeSystemQuery` or `gradeSystemSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeSystemQuery` or `gradeSystemSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemQueryFromInspector
Description	Gets a grade system query from an inspector. The inspector is available from an `GradeSystemSearchResults.`
Parameters	`osid.grading.GradeSystemQueryInspector`	`gradeSystemQueryInspector`	a grade system query inspector
Return	`osid.grading.GradeSystemQuery`		the grade system query
Errors	NULL_ARGUMENT		`gradeSystemQueryInspector` is `null`
Errors	UNSUPPORTED		`gradeSystemQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.