OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.OntologySearch
Implementsosid.OsidSearch
Description

The interface for governing ontology searches.

MethodsearchAmongOntologies
Description

Execute this search among the given list of ontologies.

Parametersosid.id.IdListontologyIdslist of ontologies
ErrorsNULL_ARGUMENT ontologyIds is null
CompliancemandatoryThis method must be implemented.
MethodorderOntologyResults
Description

Specify an ordering to the search results.

Parametersosid.ontology.OntologySearchOrderontologySearchOrderontology search order
ErrorsNULL_ARGUMENT ontologySearchOrder is null
UNSUPPORTED ontologySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOntologySearchRecord
Description

Gets the ontology search record corresponding to the given ontology 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.OntologySearchRecordthe ontology search record
ErrorsNULL_ARGUMENT ontologySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(ontologySearchRecordType) is false
CompliancemandatoryThis method must be implemented.