OSID - osid.control.rules.InputEnablerSearchSession Service Interface Definition

Interface	osid.control.rules.InputEnablerSearchSession
Implements	`osid.control.rules.InputEnablerQuerySession`
Description	This session provides methods for searching among `InputEnabler` objects. The search query is constructed using the `InputEnableryQuery.` `getInputEnablersByQuery()` is the basic search method and returns a list of `InputEnablers.` A more advanced search may be performed with `getInputEnablersBySearch().` It accepts an `InputEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. `getInputEnablersBySearch()` returns an `InputEnablerSearchResults` that can be used to access the resulting `InputEnablerList` or be used to perform a search within the result set through `InputEnablerSearch.` This session defines views that offer differing behaviors for searching. federated system view: searches include input enablers in systems of which this system is an ancestor in the system hierarchy isolated system view: searches are restricted to input enablers in this system `InputEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `InputEnablerQuery.`
Method	getInputEnablerSearch
Description	Gets an input enabler search.
Return	`osid.control.rules.InputEnablerSearch`		the input enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablerSearchOrder
Description	Gets an input enabler search order. The `InputEnablerSearchOrder` is supplied to an `InputEnablerSearch` to specify the ordering of results.
Return	`osid.control.rules.InputEnablerSearchOrder`		the input enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.rules.InputEnablerQuery`	`inputEnablerQuery`	the input enabler query
Parameters	`osid.control.rules.InputEnablerSearch`	`inputEnablerSearch`	the input enabler search
Return	`osid.control.rules.InputEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`inputEnablerQuery` or `inputEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inputEnablerQuery` or `inputEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablerQueryFromInspector
Description	Gets an input enabler query from an inspector. The inspector is available from an `InputEnablerSearchResults.`
Parameters	`osid.control.rules.InputEnablerQueryInspector`	`inputEnablerQueryInspector`	an input enabler query inspector
Return	`osid.control.rules.InputEnablerQuery`		the input enabler query
Errors	NULL_ARGUMENT		`inputEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`inputEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.