public interface RuleSearch extends OsidSearch
The search interface for governing rule searches.
Modifier and Type | Method and Description |
---|---|
RuleSearchRecord |
getRuleSearchRecord(Type ruleSearchRecordType)
Gets the rule search record corresponding to the given rule search
record
Type. |
void |
orderRuleResults(RuleSearchOrder ruleSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRules(IdList ruleIds)
Execute this search among the given list of rules.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRules(IdList ruleIds)
ruleIds
- list of rulesNullArgumentException
- ruleIds
is
null
mandatory
- This method must be implemented. void orderRuleResults(RuleSearchOrder ruleSearchOrder)
ruleSearchOrder
- rule search orderNullArgumentException
- ruleSearchOrder
is null
UnsupportedException
- ruleSearchOrder
is not of this servicemandatory
- This method must be implemented. RuleSearchRecord getRuleSearchRecord(Type ruleSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.ruleSearchRecordType
- a rule search record typeNullArgumentException
- ruleSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(ruleSearchRecordType)
is false
mandatory
- This method must be implemented.