Interface | osid.control.DeviceSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getDevices | ||
Description |
Gets the device list resulting from a search. | ||
Return | osid.control.DeviceList | the device list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.control.DeviceQueryInspector | the device query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceSearchResultsRecord | ||
Description |
Gets the device search results record corresponding to
the given device search record | ||
Parameters | osid.type.Type | deviceSearchRecordType | a device search record type |
Return | osid.control.records.DeviceSearchResultsRecord | the device search results 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. |