Interface | osid.control.DeviceSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing device searches. | ||
Method | searchAmongDevices | ||
Description |
Execute this search among the given list of devices. | ||
Parameters | osid.id.IdList | deviceIds | list of devices |
Errors | NULL_ARGUMENT | deviceIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderDeviceResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.control.DeviceSearchOrder | deviceSearchOrder | device search order |
Errors | NULL_ARGUMENT | deviceSearchOrder is null | |
UNSUPPORTED | deviceSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceSearchRecord | ||
Description |
Gets the device search record corresponding to the
given device search record | ||
Parameters | osid.type.Type | deviceSearchRecordType | a device search record type |
Return | osid.control.records.DeviceSearchRecord | the device search record | |
Errors | NULL_ARGUMENT | deviceSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(deviceSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |