OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.DeviceEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledTriggerId
Description

Matches enablers mapped to the trigger.

Parametersosid.id.IdtriggerIdthe trigger Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT triggerId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledTriggerIdTerms
Description

Clears the trigger Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledTriggerQuery
Description

Tests if an TriggerQuery is available.

Returnboolean true if an trigger query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledTriggerQuery
Description

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

Returnosid.control.TriggerQuerythe trigger query
ErrorsUNIMPLEMENTED supportsRuledTriggerQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledTriggerQuery() is true.
MethodmatchAnyRuledTrigger
Description

Matches enablers mapped to any trigger.

Parametersbooleanmatch true for enablers mapped to any trigger, false to match enablers mapped to no triggers
CompliancemandatoryThis method must be implemented.
MethodclearRuledTriggerTerms
Description

Clears the trigger query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSystemId
Description

Matches enablers mapped to the system.

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.
MethodgetDeviceEnablerQueryRecord
Description

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

Parametersosid.type.TypedeviceEnablerRecordTypea device enabler record type
Returnosid.control.rules.records.DeviceEnablerQueryRecordthe device enabler query record
ErrorsNULL_ARGUMENT deviceEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(deviceEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.