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

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

MethodgetInquiries
Description

Gets the inquiry list resulting from a search.

Returnosid.inquiry.InquiryListthe inquiry list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetInquiryQueryInspector
Description

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

Returnosid.inquiry.InquiryQueryInspectorthe inquiry query inspector
CompliancemandatoryThis 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.TypeinquirySearchRecordTypean inquiry search record type
Returnosid.inquiry.records.InquirySearchResultsRecordthe inquiry search results record
ErrorsNULL_ARGUMENT inquirySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inquirySearchRecordType) is false
CompliancemandatoryThis method must be implemented.