org.osid.inquiry

Interface InquirySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface InquirySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
InquiryList	getInquiries() Gets the inquiry list resulting from a search.
InquiryQueryInspector	getInquiryQueryInspector() Gets the inspector for the query to examine the terms used in the search.
InquirySearchResultsRecord	getInquirySearchResultsRecord(Type inquirySearchRecordType) Gets the inquiry search results record corresponding to the given inquiry 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

getInquiries

InquiryList getInquiries()

Gets the inquiry list resulting from a search.

Returns:

the inquiry list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getInquiryQueryInspector

InquiryQueryInspector getInquiryQueryInspector()

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

Returns:

the inquiry query inspector

Compliance:

mandatory - This method must be implemented.

getInquirySearchResultsRecord

InquirySearchResultsRecord getInquirySearchResultsRecord(Type inquirySearchRecordType)
                                                         throws OperationFailedException

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

Parameters:

inquirySearchRecordType - an inquiry search record type

Returns:

the inquiry search results record

Throws:

NullArgumentException - inquirySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquirySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.