Interface | osid.OsidRuleQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidOperableQuery | |||
Description |
This is the query interface for searching rules. Each
method specifies an | ||
Method | matchRuleId | ||
Description |
Match the | ||
Parameters | osid.id.Id | ruleId | Id to match |
boolean | match | true if for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | ruleId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuleIdTerms | ||
Description |
Clears all rule | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuleQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a rule query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuleQuery | ||
Description |
Gets the query for the rule. Each retrieval performs a
boolean | ||
Parameters | boolean | match | true if for a positive match, false for a
negative match |
Return | osid.rules.RuleQuery | the rule query | |
Errors | UNIMPLEMENTED | supportsRuleQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuleQuery() is
true. | |
Method | matchAnyRule | ||
Description |
Match any associated rule. | ||
Parameters | boolean | match | true to match any rule, false to match no
rules |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuleTerms | ||
Description |
Clears all rule terms. | ||
Compliance | mandatory | This method must be implemented. |