Interface | osid.control.DeviceQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching devices. Each method match
specifies an | ||
Method | matchSystemId | ||
Description |
Sets the system | ||
Parameters | osid.id.Id | systemId | the system Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | systemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSystemIdTerms | ||
Description |
Clears the system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a system query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystemQuery | ||
Description |
Gets the query for a system. Multiple retrievals
produce a nested | ||
Return | osid.control.SystemQuery | the system query | |
Errors | UNIMPLEMENTED | supportsSystemQuery() is false | |
Compliance | optional | This method must be implemented if supportsSystemQuery() is
true. | |
Method | clearSystemTerms | ||
Description |
Clears the system query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceQueryRecord | ||
Description |
Gets the device query record corresponding to the given
| ||
Parameters | osid.type.Type | deviceRecordType | a device record type |
Return | osid.control.records.DeviceQueryRecord | the device query record | |
Errors | NULL_ARGUMENT | deviceRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(deviceRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |