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

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

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.