OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.InquirySearchResults
Implementsosid.OsidSearchResults
Used Byosid.inquiry.InquirySearchSession
Description

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

MethodgetInquiries
Description

Gets the inquiry list resulting from a search.

Returnosid.inquiry.InquiryList the inquiry list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetInquiryQueryInspector
Description

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

Returnosid.inquiry.InquiryQueryInspector the inquiry query inspector
Compliancemandatory This method must be implemented.
MethodgetInquirySearchResultsRecord
Description

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.

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