OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ValueEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledValueId
Description

Matches enablers mapped to the value.

Parametersosid.id.IdvalueIdthe value Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT valueId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledValueIdTerms
Description

Clears the value Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledValueQuery
Description

Tests if a ValueQuery is available.

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

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

Returnosid.configuration.ValueQuerythe value query
ErrorsUNIMPLEMENTED supportsRuleValueQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledValueQuery() is true.
MethodmatchAnyRuledValue
Description

Matches enablers mapped to any value.

Parametersbooleanmatch true for enablers mapped to any value, false to match enablers mapped to no value
CompliancemandatoryThis method must be implemented.
MethodclearRuledValueTerms
Description

Clears the value query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchConfigurationId
Description

Matches enablers mapped to the configuration.

Parametersosid.id.IdconfigurationIdthe configuration Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT configurationId is null
CompliancemandatoryThis method must be implemented.
MethodclearConfigurationIdTerms
Description

Clears the configuration Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsConfigurationQuery
Description

Tests if a ConfigurationQuery is available.

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

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

Returnosid.configuration.ConfigurationQuerythe configuration query
ErrorsUNIMPLEMENTED supportsConfigurationQuery() is false
ComplianceoptionalThis method must be implemented if supportsConfigurationQuery() is true.
MethodclearConfigurationTerms
Description

Clears the configuration query terms.

CompliancemandatoryThis method must be implemented.
MethodgetValueEnablerQueryRecord
Description

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

Parametersosid.type.TypevalueEnablerRecordTypea value enabler record type
Returnosid.configuration.rules.records.ValueEnablerQueryRecordthe value enabler query record
ErrorsNULL_ARGUMENT valueEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(valueEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.