OSID - osid.control.ControllerSearchSession Service Interface Definition

Interface	osid.control.ControllerSearchSession
Implements	`osid.control.ControllerQuerySession`
Description	This session provides methods for searching among `Controller` objects. The search query is constructed using the `ControlleryQuery.` `getControllersByQuery()` is the basic search method and returns a list of `Controllers.` A more advanced search may be performed with `getControllersBySearch().` It accepts a `ControllerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getControllersBySearch()` returns a `ControllerSearchResults` that can be used to access the resulting `ControllerList` or be used to perform a search within the result set through `ControllerSearch.` This session defines views that offer differing behaviors for searching. federated trigger view: searches include controllers in triggers of which this trigger is an ancestor in the trigger hierarchy isolated trigger view: searches are restricted to controllers in this trigger Controllers may have a controller record indicated by their respective record types. The controller record is accessed via the `ControllerQuery.`
Method	getControllerSearch
Description	Gets a controller search.
Return	`osid.control.ControllerSearch`		the controller search
Compliance	`mandatory`		This method must be implemented.
Method	getControllerSearchOrder
Description	Gets a controller search order. The `ControllerSearchOrder` is supplied to a `ControllerSearch` to specify the ordering of results.
Return	`osid.control.ControllerSearchOrder`		the controller search order
Compliance	`mandatory`		This method must be implemented.
Method	getControllersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.ControllerQuery`	`controllerQuery`	the controller query
Parameters	`osid.control.ControllerSearch`	`controllerSearch`	the controller search
Return	`osid.control.ControllerSearchResults`		the controller search results
Errors	NULL_ARGUMENT		`controllerQuery` or `controllerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`controllerQuery` or `controllerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getControllerQueryFromInspector
Description	Gets a controller query from an inspector. The inspector is available from a `ControllerSearchResults.`
Parameters	`osid.control.ControllerQueryInspector`	`controllerQueryInspector`	a controller query inspector
Return	`osid.control.ControllerQuery`		the controller query
Errors	NULL_ARGUMENT		`controllerQueryInspector` is `null`
Errors	UNSUPPORTED		`controllerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.