OSID - osid.rules.EngineSearchSession Service Interface Definition

Interface	osid.rules.EngineSearchSession
Implements	`osid.rules.EngineQuerySession`
Description	This session provides methods for searching `Engine` objects. The search query is constructed using the `EngineQuery.` The engine record `Type` also specifies the recod for the engine query. `getEnginesByQuery()` is the basic search method and returns a list of `Engine` elements. A more advanced search may be performed with `getEnginesBySearch().` It accepts an `EngineSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getEnginesBySearch()` returns a `EngineSearchResults` that can be used to access the resulting `EngineList` or be used to perform a search within the result set through `EngineSearch.` Engines may have an engine query record indicated by their respective record types. The engine query record is accessed via the `EngineQuery.` The returns in this session may not be cast directly to these interfaces.
Method	getEngineSearch
Description	Gets an engine search.
Return	`osid.rules.EngineSearch`		the engine search
Compliance	`mandatory`		This method must be implemented.
Method	getEngineSearchOrder
Description	Gets an engine search order. The `EngineSearchOrder` is supplied to a `EngineSearch` to specify the ordering of results.
Return	`osid.rules.EngineSearchOrder`		the engine search order
Compliance	`mandatory`		This method must be implemented.
Method	getEnginesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.rules.EngineQuery`	`engineQuery`	the engine query
Parameters	`osid.rules.EngineSearch`	`engineSearch`	the engine search
Return	`osid.rules.EngineSearchResults`		the engine search results
Errors	NULL_ARGUMENT		`engineQuery` or `engineSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`engineQuery` or `engineSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEngineQueryFromInspector
Description	Gets an engine query from an inspector. The inspector is available from a `EngineSearchResults.`
Parameters	`osid.rules.EngineQueryInspector`	`engineQueryInspector`	an engine query inspector
Return	`osid.rules.EngineQuery`		the engine query
Errors	NULL_ARGUMENT		`engineQueryInspector` is `null`
Errors	UNSUPPORTED		`engineQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.