OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.InputQuery
Implementsosid.OsidRuleQuery
Description

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

MethodmatchDeviceId
Description

Sets the device Id for this query.

Parametersosid.id.IddeviceIdthe device Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT deviceId is null
CompliancemandatoryThis method must be implemented.
MethodclearDeviceIdTerms
Description

Clears the device Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceQuery
Description

Tests if a DeviceQuery is available.

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

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

Returnosid.control.DeviceQuerythe device query
ErrorsUNIMPLEMENTED supportsDeviceQuery() is false
ComplianceoptionalThis method must be implemented if supportsDeviceQuery() is true.
MethodclearDeviceTerms
Description

Clears the device query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchControllerId
Description

Sets the controller Id for this query.

Parametersosid.id.IdcontrollerIdthe controller Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT controllerId is null
CompliancemandatoryThis method must be implemented.
MethodclearControllerIdTerms
Description

Clears the controller Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsControllerQuery
Description

Tests if a ControllerQuery is available.

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

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

Returnosid.control.ControllerQuerythe controller query
ErrorsUNIMPLEMENTED supportsControllerQuery() is false
ComplianceoptionalThis method must be implemented if supportsControllerQuery() is true.
MethodclearControllerTerms
Description

Clears the controller query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSystemId
Description

Sets the system Id for this query to match inputs assigned to systems.

Parametersosid.id.IdsystemIdthe system Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT sustemId 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.
MethodgetInputQueryRecord
Description

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

Parametersosid.type.TypeinputRecordTypean input record type
Returnosid.control.records.InputQueryRecordthe input query record
ErrorsNULL_ARGUMENT inputRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inputRecordType) is false
CompliancemandatoryThis method must be implemented.