OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.InquestSearchResults
Implementsosid.OsidSearchResults
Used Byosid.inquiry.InquestSearchSession
Description

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

MethodgetInquests
Description

Gets the inquest list resulting from a search.

Returnosid.inquiry.InquestList the inquest list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetInquestQueryInspector
Description

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

Returnosid.inquiry.InquestQueryInspector the inquest query inspector
Compliancemandatory This method must be implemented.
MethodgetInquestSearchResultsRecord
Description

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.

Parametersosid.type.TypeinquestSearchRecordType an inquest search record type
Returnosid.inquiry.records.InquestSearchResultsRecord the inquest search results record
ErrorsNULL_ARGUMENT inquestSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(inquestSearchRecordType) is false
Compliancemandatory This method must be implemented.