OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.DeviceSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetDevices
Description

Gets the device list resulting from a search.

Returnosid.control.DeviceListthe device list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDeviceQueryInspector
Description

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

Returnosid.control.DeviceQueryInspectorthe device query inspector
CompliancemandatoryThis 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.TypedeviceSearchRecordTypea device search record type
Returnosid.control.records.DeviceSearchResultsRecordthe device search results record
ErrorsNULL_ARGUMENT deviceSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(deviceSearchRecordType) is false
CompliancemandatoryThis method must be implemented.