OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.DeviceQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching devices. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchSystemId
Description

Sets the system Id for this query.

Parametersosid.id.IdsystemIdthe system Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT systemId is null
CompliancemandatoryThis method must be implemented.
MethodclearSystemIdTerms
Description

Clears the system Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSystemQuery
Description

Tests if a SystemQuery is available.

Returnboolean true if a system query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSystemQuery
Description

Gets the query for a system. Multiple retrievals produce a nested OR term.

Returnosid.control.SystemQuerythe system query
ErrorsUNIMPLEMENTED supportsSystemQuery() is false
ComplianceoptionalThis method must be implemented if supportsSystemQuery() is true.
MethodclearSystemTerms
Description

Clears the system query terms.

CompliancemandatoryThis method must be implemented.
MethodgetDeviceQueryRecord
Description

Gets the device query record corresponding to the given Device record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypedeviceRecordTypea device record type
Returnosid.control.records.DeviceQueryRecordthe device query record
ErrorsNULL_ARGUMENT deviceRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(deviceRecordType) is false
CompliancemandatoryThis method must be implemented.