OSID - osid.control.InputSearchSession Service Interface Definition

Interface	osid.control.InputSearchSession
Implements	`osid.control.InputQuerySession`
Description	This session provides methods for searching among `Input` objects. The search query is constructed using the `InputQuery.` `getInputsByQuery()` is the basic search method and returns a list of `Inputs.` A more advanced search may be performed with `getInputsBySearch().` It accepts a `InputSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getInputsBySearch()` returns a `InputSearchResults` that can be used to access the resulting `InputList` or be used to perform a search within the result set through `InputSearch.` This session defines views that offer differing behaviors for searching. federated trigger view: searches include inputs in triggers of which this trigger is an ancestor in the trigger hierarchy isolated trigger view: searches are restricted to inputs in this trigger Inputs may have a query record indicated by their respective record types. The query record is accessed via the `InputQuery.`
Method	getInputSearch
Description	Gets an input search.
Return	`osid.control.InputSearch`		the input search
Compliance	`mandatory`		This method must be implemented.
Method	getInputSearchOrder
Description	Gets an input search order. The `InputSearchOrder` is supplied to a `InputSearch` to specify the ordering of results.
Return	`osid.control.InputSearchOrder`		the input search order
Compliance	`mandatory`		This method must be implemented.
Method	getInputsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.InputQuery`	`inputQuery`	the input query
Parameters	`osid.control.InputSearch`	`inputSearch`	the input search
Return	`osid.control.InputSearchResults`		the input search results
Errors	NULL_ARGUMENT		`inputQuery` or `inputSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inputQuery` or `inputSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInputQueryFromInspector
Description	Gets an input query from an inspector. The inspector is available from a `InputSearchResults.`
Parameters	`osid.control.InputQueryInspector`	`inputQueryInspector`	an input query inspector
Return	`osid.control.InputQuery`		the input query
Errors	NULL_ARGUMENT		`inputQueryInspector` is `null`
Errors	UNSUPPORTED		`inputQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.