OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidRuleQuery
Implementsosid.OsidObjectQuery
osid.OsidOperableQuery
Description

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

MethodmatchRuleId
Description

Match the Id of the rule.

Parametersosid.id.IdruleId Id to match
booleanmatch true if for a positive match, false for a negative match
ErrorsNULL_ARGUMENT ruleId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuleIdTerms
Description

Clears all rule Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuleQuery
Description

Tests if a RuleQuery for the rule is available.

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

Gets the query for the rule. Each retrieval performs a boolean OR.

Parametersbooleanmatch true if for a positive match, false for a negative match
Returnosid.rules.RuleQuerythe rule query
ErrorsUNIMPLEMENTED supportsRuleQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuleQuery() is true.
MethodmatchAnyRule
Description

Match any associated rule.

Parametersbooleanmatch true to match any rule, false to match no rules
CompliancemandatoryThis method must be implemented.
MethodclearRuleTerms
Description

Clears all rule terms.

CompliancemandatoryThis method must be implemented.