Interface | osid.rules.RuleSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing rule searches. | ||
Method | searchAmongRules | ||
Description |
Execute this search among the given list of rules. | ||
Parameters | osid.id.IdList | ruleIds | list of rules |
Errors | NULL_ARGUMENT | ruleIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderRuleResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.rules.RuleSearchOrder | ruleSearchOrder | rule search order |
Errors | NULL_ARGUMENT | ruleSearchOrder is null | |
UNSUPPORTED | ruleSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRuleSearchRecord | ||
Description |
Gets the rule search record corresponding to the given
rule search record | ||
Parameters | osid.type.Type | ruleSearchRecordType | a rule search record type |
Return | osid.rules.records.RuleSearchRecord | the rule search record | |
Errors | NULL_ARGUMENT | ruleSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(ruleSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |