public interface RuleSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
RuleQueryInspector |
getRuleQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
RuleList |
getRules()
Gets the rule list resulting from a search.
|
RuleSearchResultsRecord |
getRuleSearchResultsRecord(Type ruleSearchRecordType)
Gets the rule search results record corresponding to the given rule
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
RuleList getRules()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. RuleQueryInspector getRuleQueryInspector()
mandatory
- This method must be implemented. RuleSearchResultsRecord getRuleSearchResultsRecord(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.