OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.OntologySearchSession
Implementsosid.ontology.OntologyQuerySession
Description

This session provides methods for searching among Ontology objects. The search query is constructed using the OntologyQuery.

getOntologiesByQuery() is the basic search method and returns a list of Ontology objects.A more advanced search may be performed with getOntologiesBySearch(). It accepts an OntologySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getOntologiesBySearch() returns an OntologySearchResults that can be used to access the resulting OntologyList or be used to perform a search within the result set through OntologySearch.

Ontologies may have a query record indicated by their respective record types. The query record is accessed via the OntologyQuery.

MethodgetOntologySearch
Description

Gets an ontology search.

Returnosid.ontology.OntologySearchan ontology search
CompliancemandatoryThis method must be implemented.
MethodgetOntologySearchOrder
Description

Gets an ontology search order. The OntologySearchOrder is supplied to an OntologySearch to specify the ordering of results.

Returnosid.ontology.OntologySearchOrderthe ontology search order
CompliancemandatoryThis method must be implemented.
MethodgetOntologiesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.ontology.OntologyQueryontologyQuerythe ontology query
osid.ontology.OntologySearchontologySearchthe ontology search
Returnosid.ontology.OntologySearchResultsthe ontology search results
ErrorsNULL_ARGUMENT ontologyQuery or ontologySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED ontologyQuery or ontologySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOntologyQueryFromInspector
Description

Gets an ontology query from an inspector. The inspector is available from an OntologySearchResults.

Parametersosid.ontology.OntologyQueryInspectorontologyQueryInspectoran ontology query inspector
Returnosid.ontology.OntologyQuerythe ontology query
ErrorsNULL_ARGUMENT ontologyQueryInspector is null
UNSUPPORTED ontologyQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.