Interface | osid.rules.RuleQuery | ||
---|---|---|---|
Implements | osid.OsidRuleQuery | ||
Description |
This is the query for searching rules. Each method
specifies an | ||
Method | matchEngineId | ||
Description |
Sets the engine | ||
Parameters | osid.id.Id | engineId | an engine Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | engineId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearEngineIdTerms | ||
Description |
Clears the engine | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsEngineQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an engine query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngineQuery | ||
Description |
Gets the query for an engine query. Multiple retrievals
produce a nested | ||
Return | osid.rules.EngineQuery | the engine query | |
Errors | UNIMPLEMENTED | supportsEngineQuery() is false | |
Compliance | optional | This method must be implemented if supportsEngineQuery() is
true. | |
Method | clearEngineTerms | ||
Description |
Clears the engine query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRuleQueryRecord | ||
Description |
Gets the rule query record corresponding to the given
| ||
Parameters | osid.type.Type | ruleRecordType | a rule record type |
Return | osid.rules.records.RuleQueryRecord | the rule query record | |
Errors | NULL_ARGUMENT | ruleRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(ruleRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |