OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.RelevancySearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetRelevancies
Description

Gets the relevancy list resulting from the search.

Returnosid.ontology.RelevancyListthe relevancy list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyQueryInspector
Description

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

Returnosid.ontology.RelevancyQueryInspectorthe relevancy query inspector
CompliancemandatoryThis 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.TyperelevancySearchRecordTypea relevancy search record type
Returnosid.ontology.records.RelevancySearchResultsRecordthe relevancy search results record
ErrorsNULL_ARGUMENT relevancySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(relevancySearchRecordType) is false
CompliancemandatoryThis method must be implemented.