Interface RuleSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RuleSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getRules

RuleList getRules()

Gets the rule list resulting from a search.

Returns:

the rule list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRuleQueryInspector

RuleQueryInspector getRuleQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the rule query inspector

Compliance:

mandatory - This method must be implemented.

getRuleSearchResultsRecord

RuleSearchResultsRecord getRuleSearchResultsRecord(Type ruleSearchRecordType)
                                            throws OperationFailedException

Gets the rule search results record corresponding to the given rule search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

ruleSearchRecordType - a rule search record type

Returns:

the rule search results record

Throws:

NullArgumentException - ruleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ruleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.