Interface InquestSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface InquestSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
InquestQueryInspector	getInquestQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
InquestList	getInquests()	Gets the inquest list resulting from a search.
InquestSearchResultsRecord	getInquestSearchResultsRecord(Type inquestSearchRecordType)	Gets the inquest search results record corresponding to the given inquest 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

getInquests

InquestList getInquests()

Gets the inquest list resulting from a search.

Returns:

the inquest list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getInquestQueryInspector

InquestQueryInspector getInquestQueryInspector()

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

Returns:

the inquest query inspector

Compliance:

mandatory - This method must be implemented.

getInquestSearchResultsRecord

InquestSearchResultsRecord getInquestSearchResultsRecord(Type inquestSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

inquestSearchRecordType - an inquest search record type

Returns:

the inquest search results record

Throws:

NullArgumentException - inquestSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquestSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.