OSID - osid.search.EngineQuerySession Service Interface Definition

Interface	osid.search.EngineQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.search.EngineSearchSession`
Used By	`osid.search.SearchManager`
Used By	`osid.search.SearchProxyManager`
Description	This session provides methods for searching `Engines`. The search query is constructed using the `EngineQuery`. The engine record `Type` also specifies the record for the engine query. Engines may have a query record indicated by their respective record types. The query record is accessed via the `EngineQuery`. The returns in this session may not be cast directly to these interfaces.
Method	canSearchEngines
Description	Tests if this user can perform `Engine` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEngineQuery
Description	Gets an engine query.
Return	`osid.search.EngineQuery`		the engine query
Compliance	`mandatory`		This method must be implemented.
Method	getEnginesByQuery
Description	Gets a list of `Engines` matching the given engine query.
Parameters	`osid.search.EngineQuery`	`engineQuery`	the engine query
Return	`osid.search.EngineList`		the returned `EngineList`
Errors	NULL_ARGUMENT		`engineQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`engineQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.