OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.DeviceSearchResults
Implementsosid.OsidSearchResults
Used Byosid.control.DeviceSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetDevices
Description

Gets the device list resulting from a search.

Returnosid.control.DeviceList the device list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetDeviceQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.control.DeviceQueryInspector the device query inspector
Compliancemandatory This method must be implemented.
MethodgetDeviceSearchResultsRecord
Description

Gets the device search results record corresponding to the given device search record Type.This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypedeviceSearchRecordType a device search record type
Returnosid.control.records.DeviceSearchResultsRecord the device search results record
ErrorsNULL_ARGUMENT deviceSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(deviceSearchRecordType) is false
Compliancemandatory This method must be implemented.