Interface | osid.control.DeviceSearchSession | ||
---|---|---|---|
Implements | osid.control.DeviceQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Devices may have a record indicated by their respective
record types. The query record is accessed via the | ||
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 | ||
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 |
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 | ||
Parameters | osid.control.DeviceQueryInspector | deviceQueryInspector | a device query inspector |
Return | osid.control.DeviceQuery | the device query | |
Errors | NULL_ARGUMENT | deviceQueryInspector is null | |
UNSUPPORTED | deviceQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |