OSID - osid.rules.check.CheckSearchSession Service Interface Definition

Interface	osid.rules.check.CheckSearchSession
Implements	`osid.rules.check.CheckQuerySession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session provides methods for searching among `Check` objects. The search query is constructed using the `CheckQuery`. `getChecksByQuery()` is the basic search method and returns a list of `Checks`. A more advanced search may be performed with `getChecksBySearch()`. It accepts a `CheckSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getChecksBySearch()` returns a `CheckSearchResults` that can be used to access the resulting `CheckList` or be used to perform a search within the result set through `CheckSearch`. This session defines views that offer differing behaviors for searching. federated engine view: searches include checks in engines of which this engine is an ancestor in the engine hierarchy isolated engine view: searches are restricted to checks in this engine Checks may have a query record indicated by their respective record types. The query record is accessed via the `CheckQuery`.
Method	getCheckSearch
Description	Gets a check search.
Return	`osid.rules.check.CheckSearch`		the check search
Compliance	`mandatory`		This method must be implemented.
Method	getCheckSearchOrder
Description	Gets a check search order. The `CheckSearchOrder` is supplied to a `CheckSearch` to specify the ordering of results.
Return	`osid.rules.check.CheckSearchOrder`		the check search order
Compliance	`mandatory`		This method must be implemented.
Method	getChecksBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.rules.check.CheckQuery`	`checkQuery`	the check query
Parameters	`osid.rules.check.CheckSearch`	`checkSearch`	the check search
Return	`osid.rules.check.CheckSearchResults`		the check search results
Errors	NULL_ARGUMENT		`checkQuery` or `checkSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`checkQuery` or `checkSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCheckQueryFromInspector
Description	Gets a check query from an inspector. The inspector is available from a `CheckSearchResults`.
Parameters	`osid.rules.check.CheckQueryInspector`	`checkQueryInspector`	a check query inspector
Return	`osid.rules.check.CheckQuery`		the check query
Errors	NULL_ARGUMENT		`checkQueryInspector` is `null`
Errors	UNSUPPORTED		`checkQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.