OSID - osid.grading.GradebookSearchSession Service Interface Definition

Interface	osid.grading.GradebookSearchSession
Implements	`osid.grading.GradebookQuerySession`
Description	This session provides methods for searching among `Gradebook` objects. The search query is constructed using the `GradebookQuery.` `getGradebooksByQuery()` is the basic search method and returns a list of `Gradebook` objects.A more advanced search may be performed with `getGradebooksBySearch().` It accepts a `GradebookSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getGradebooksBySearch()` returns a `GradebookSearchResults` that can be used to access the resulting `GradebookList` or be used to perform a search within the result set through `GradebookSearch.` Gradebooks may have a query record indicated by their respective record types. The query record is accessed via the `GradebookQuery.`
Method	getGradebookSearch
Description	Gets a gradebook search.
Return	`osid.grading.GradebookSearch`		a gradebook search
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookSearchOrder
Description	Gets a gradebook search order. The `GradebookSearchOrder` is supplied to a `GradebookSearch` to specify the ordering of results.
Return	`osid.grading.GradebookSearchOrder`		the gradebook search order
Compliance	`mandatory`		This method must be implemented.
Method	getGradebooksBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.grading.GradebookQuery`	`gradebookQuery`	the gradebook query
Parameters	`osid.grading.GradebookSearch`	`gradebookSearch`	the gradebook search
Return	`osid.grading.GradebookSearchResults`		the gradebook search results
Errors	NULL_ARGUMENT		`gradebookQuery` or `gradebookSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradebookQuery` or `gradebookSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookQueryFromInspector
Description	Gets a gradebook query from an inspector. The inspector is available from an `GradenookSearchResults.`
Parameters	`osid.grading.GradebookQueryInspector`	`gradebookQueryInspector`	a gradebook query inspector
Return	`osid.grading.GradebookQuery`		the gradebook query
Errors	NULL_ARGUMENT		`gradebookQueryInspector` is `null`
Errors	UNSUPPORTED		`gradebookQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.