OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.InquestSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetInquests
Description

Gets the inquest list resulting from a search.

Returnosid.inquiry.InquestListthe inquest list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetInquestQueryInspector
Description

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

Returnosid.inquiry.InquestQueryInspectorthe inquest query inspector
CompliancemandatoryThis 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.TypeinquestSearchRecordTypean inquest search record type
Returnosid.inquiry.records.InquestSearchResultsRecordthe inquest search results record
ErrorsNULL_ARGUMENT inquestSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inquestSearchRecordType) is false
CompliancemandatoryThis method must be implemented.