OSID - osid.grading.GradeSearchSession Service Interface Definition

Interface	osid.grading.GradeSearchSession
Implements	`osid.grading.GradeQuerySession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
Description	This session provides methods for searching among `Grades` . The search query is constructed using the `GradeQuery` . `getGradesByQuery()` is the basic search method and returns a list of `Grades` . A more advanced search may be performed with `getGradesBySearch()` . It accepts a `GradeSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getGradesBySearch()` returns a `GradeSearchResults` that can be used to access the resulting `GradeList` or be used to perform a search within the result set through Gra `deSearch` . This session defines views that offer differing behaviors for searching. federated gradebook view: searches include grades in gradebooks of which this gradebook is an ancestor in the gradebook hierarchy isolated gradebook view: searches are restricted to grades in this gradebook Grades may have a query record indicated by their respective record types. The query record is accessed via the `GradeQuery` .
Method	getGradeSearch
Description	Gets a grade search.
Return	`osid.grading.GradeSearch`		the grade search
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSearchOrder
Description	Gets a grade search order. The `GradeSearchOrder` is supplied to a `GradeSearch` to specify the ordering of results.
Return	`osid.grading.GradeSearchOrder`		the grade search order
Compliance	`mandatory`		This method must be implemented.
Method	getGradesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.grading.GradeQuery`	`gradeQuery`	the grade query
Parameters	`osid.grading.GradeSearch`	`gradeSearch`	the grade search
Return	`osid.grading.GradeSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`gradeQuery` or `gradeSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeQuery` or `gradeSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGradeQueryFromInspector
Description	Gets a grade query from an inspector. The inspector is available from a `GradeSearchResults` .
Parameters	`osid.grading.GradeQueryInspector`	`gradeQueryInspector`	a grade query inspector
Return	`osid.grading.GradeQuery`		the grade query
Errors	NULL_ARGUMENT		`gradeQueryInspector` is `null`
Errors	UNSUPPORTED		`gradeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.