org.osid.inquiry

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

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.