Interface | osid.rules.RuleSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRules | ||
Description |
Gets the rule list resulting from a search. | ||
Return | osid.rules.RuleList | the rule list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuleQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.rules.RuleQueryInspector | the rule query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuleSearchResultsRecord | ||
Description |
Gets the rule search results record corresponding to
the given rule search record | ||
Parameters | osid.type.Type | ruleSearchRecordType | a rule search record type |
Return | osid.rules.records.RuleSearchResultsRecord | the rule search results 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. |