OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.DeviceSearch
Implementsosid.OsidSearch
Description

The search interface for governing device searches.

MethodsearchAmongDevices
Description

Execute this search among the given list of devices.

Parametersosid.id.IdListdeviceIdslist of devices
ErrorsNULL_ARGUMENT deviceIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDeviceResults
Description

Specify an ordering to the search results.

Parametersosid.control.DeviceSearchOrderdeviceSearchOrderdevice search order
ErrorsNULL_ARGUMENT deviceSearchOrder is null
UNSUPPORTED deviceSearchOrder is not of this service
CompliancemandatoryThis 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.TypedeviceSearchRecordTypea device search record type
Returnosid.control.records.DeviceSearchRecordthe device search record
ErrorsNULL_ARGUMENT deviceSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(deviceSearchRecordType) is false
CompliancemandatoryThis method must be implemented.