OSID - osid.grading.GradebookColumnSearchSession Service Interface Definition

Interface	osid.grading.GradebookColumnSearchSession
Implements	`osid.grading.GradebookColumnQuerySession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
Description	This session provides methods for searching `GradebookColumn` objects. The search query is constructed using the `GradebookColumnQuery`. `getGradebookColumnsByQuery()` is the basic search method and returns a list of `GradebookColumn` objects.A more advanced search may be performed with `getGradebookColumnsBySearch()`. It accepts a `GradebookColumnSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getGradebookColumnsBySearch()` returns a `GradebookColumnSearchResults` that can be used to access the resulting `GradebookColumnList` or be used to perform a search within the result set through `GradebookColumnSearch`. This session defines views that offer differing behaviors for searching. federated gradebook view: searches include columns in gradebooks of which this gradebook is an ancestor in the gradebook hierarchy isolated gradebook view: searches are restricted to columns in this gradebook Gradebook columns may have a query record indicated by their respective record types. The query record is accessed via the `GradebookColumnQuery`.
Method	getGradebookColumnSearch
Description	Gets a gradebook column search.
Return	`osid.grading.GradebookColumnSearch`		the gradebook column search
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnSearchOrder
Description	Gets a gradebook column search order. The `GradebookColumnSearchOrder` is supplied to a `GradebookColumnSearch` to specify the ordering of results.
Return	`osid.grading.GradebookColumnSearchOrder`		the gradebook column search order
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.grading.GradebookColumnQuery`	`gradebookColumnQuery`	the gradebook column query
Parameters	`osid.grading.GradebookColumnSearch`	`gradebookColumnSearch`	the gradebook column search
Return	`osid.grading.GradebookColumnSearchResults`		the gradebook column search results
Errors	NULL_ARGUMENT		`gradebookColumnQuery` or `gradebookColumnSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradebookColumnSearch` or `gradebookColumnQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnQueryFromInspector
Description	Gets a gradebook column query from an inspector. The inspector is available from an `GradebookColumnSearchResults`.
Parameters	`osid.grading.GradebookColumnQueryInspector`	`gradebookColumnQueryInspector`	a gradebook column query inspector
Return	`osid.grading.GradebookColumnQuery`		the gradebook column query
Errors	NULL_ARGUMENT		`gradebookColumnQueryInspector` is `null`
Errors	UNSUPPORTED		`gradebookColumnQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.