OSID - osid.control.DeviceSearchSession Service Interface Definition

Interface	osid.control.DeviceSearchSession
Implements	`osid.control.DeviceQuerySession`
Description	This session provides methods for searching among `Device` objects. The search query is constructed using the `DeviceQuery.` `getDevicesByQuery()` is the basic search method and returns a list of `Devices.` A more advanced search may be performed with `getDevicesBySearch().` It accepts a `DeviceSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDevicesBySearch()` returns a `DeviceSearchResults` that can be used to access the resulting `DeviceList` or be used to perform a search within the result set through `DeviceSearch.` This session defines views that offer differing behaviors for searching. federated system view: searches include devices in systems of which this system is an ancestor in the system hierarchy isolated system view: searches are restricted to devices in this system Devices may have a record indicated by their respective record types. The query record is accessed via the `DeviceQuery.`
Method	getDeviceSearch
Description	Gets a device search.
Return	`osid.control.DeviceSearch`		the device search
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceSearchOrder
Description	Gets a device search order. The `DeviceSearchOrder` is supplied to a `DeviceSearch` to specify the ordering of results.
Return	`osid.control.DeviceSearchOrder`		the device search order
Compliance	`mandatory`		This method must be implemented.
Method	getDevicesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.DeviceQuery`	`deviceQuery`	the device query
Parameters	`osid.control.DeviceSearch`	`deviceSearch`	the device search
Return	`osid.control.DeviceSearchResults`		the device search results
Errors	NULL_ARGUMENT		`deviceQuery` or `deviceSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`deviceQuery` or `deviceSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceQueryFromInspector
Description	Gets a device query from an inspector. The inspector is available from a `DeviceSearchResults.`
Parameters	`osid.control.DeviceQueryInspector`	`deviceQueryInspector`	a device query inspector
Return	`osid.control.DeviceQuery`		the device query
Errors	NULL_ARGUMENT		`deviceQueryInspector` is `null`
Errors	UNSUPPORTED		`deviceQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.