OSID Logo
OSID Specifications
rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.RuleQuery
Implementsosid.OsidRuleQuery
Description

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

MethodmatchEngineId
Description

Sets the engine Id for this query to match rules assigned to engines.

Parametersosid.id.IdengineIdan engine Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT engineId is null
CompliancemandatoryThis method must be implemented.
MethodclearEngineIdTerms
Description

Clears the engine Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEngineQuery
Description

Tests if an EngineQuery is available.

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

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

Returnosid.rules.EngineQuerythe engine query
ErrorsUNIMPLEMENTED supportsEngineQuery() is false
ComplianceoptionalThis method must be implemented if supportsEngineQuery() is true.
MethodclearEngineTerms
Description

Clears the engine query terms.

CompliancemandatoryThis method must be implemented.
MethodgetRuleQueryRecord
Description

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

Parametersosid.type.TyperuleRecordTypea rule record type
Returnosid.rules.records.RuleQueryRecordthe rule query record
ErrorsNULL_ARGUMENT ruleRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(ruleRecordType) is false
CompliancemandatoryThis method must be implemented.