OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.DeviceSearch
Implementsosid.OsidSearch
Used Byosid.control.DeviceSearchSession
Description

The search interface for governing device searches.

MethodsearchAmongDevices
Description

Execute this search among the given list of devices.

Parametersosid.id.IdListdeviceIds list of devices
ErrorsNULL_ARGUMENT deviceIds is null
Compliancemandatory This method must be implemented.
MethodorderDeviceResults
Description

Specify an ordering to the search results.

Parametersosid.control.DeviceSearchOrderdeviceSearchOrder device search order
ErrorsNULL_ARGUMENT deviceSearchOrder is null
UNSUPPORTED deviceSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetDeviceSearchRecord
Description

Gets the device search 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.DeviceSearchRecord the device search record
ErrorsNULL_ARGUMENT deviceSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(deviceSearchRecordType) is false
Compliancemandatory This method must be implemented.