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

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

MethodgetOntologies
Description

Gets the ontology list resulting from the search.

Returnosid.ontology.OntologyListthe ontology list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetOntologyQueryInspector
Description

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

Returnosid.ontology.OntologyQueryInspectorthe ontology query inspector
CompliancemandatoryThis method must be implemented.
MethodgetOntologySearchResultsRecord
Description

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

Parametersosid.type.TypeontologySearchRecordTypean ontology search record type
Returnosid.ontology.records.OntologySearchResultsRecordthe ontology search results record
ErrorsNULL_ARGUMENT ontologySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(ontologySearchRecordType) is false
CompliancemandatoryThis method must be implemented.