OSID Specifications
ontology package
Version 3.0.0
ontology package
Version 3.0.0
| Interface | osid.ontology.OntologySearchSession | ||
|---|---|---|---|
| Implements | osid.ontology.OntologyQuerySession | ||
| Used By | osid.ontology.OntologyManager | ||
osid.ontology.OntologyProxyManager | |||
| Description |
This session provides methods for searching among
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
| ||
| Method | getOntologySearch | ||
| Description |
Gets an ontology search. | ||
| Return | osid.ontology.OntologySearch | an ontology search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOntologySearchOrder | ||
| Description |
Gets an ontology search order. The
| ||
| Return | osid.ontology.OntologySearchOrder | the ontology search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOntologiesBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.ontology.OntologyQuery | ontologyQuery | the ontology query |
osid.ontology.OntologySearch | ontologySearch | the ontology search | |
| Return | osid.ontology.OntologySearchResults | the ontology search results | |
| Errors | NULL_ARGUMENT | ontologyQuery or ontologySearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | ontologyQuery or ontologySearch is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOntologyQueryFromInspector | ||
| Description |
Gets an ontology query from an inspector. The inspector
is available from an | ||
| Parameters | osid.ontology.OntologyQueryInspector | ontologyQueryInspector | an ontology query inspector |
| Return | osid.ontology.OntologyQuery | the ontology query | |
| Errors | NULL_ARGUMENT | ontologyQueryInspector is null | |
| UNSUPPORTED | ontologyQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |