OSID Logo
OSID Specifications
ontology package
Version 3.1.0
Interfaceosid.ontology.RelevancySearchResults
Implementsosid.OsidSearchResults
Used Byosid.ontology.RelevancySearchSession
Description

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

MethodgetRelevancies
Description

Gets the relevancy list resulting from the search.

Returnosid.ontology.RelevancyList the relevancy list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetRelevancyQueryInspector
Description

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

Returnosid.ontology.RelevancyQueryInspector the relevancy query inspector
Compliancemandatory This method must be implemented.
MethodgetRelevancySearchResultsRecord
Description

Gets the relevancy search results record corresponding to the given relevancy search record Type .This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TyperelevancySearchRecordType a relevancy search record type
Returnosid.ontology.records.RelevancySearchResultsRecord the relevancy search results record
ErrorsNULL_ARGUMENT relevancySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(relevancySearchRecordType) is false
Compliancemandatory This method must be implemented.