OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
ontology package
Version 3.0.0
Release Candidate Preview
| Interface | osid.ontology.OntologyQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining ontology queries. | ||
| Method | getSubjectIdTerms | ||
| Description |
Gets the subject | ||
| Return | osid.search.terms.IdTerm[] | the subject Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectTerms | ||
| Description |
Gets the subject terms. | ||
| Return | osid.ontology.SubjectQueryInspector[] | the subject terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelevancyIdTerms | ||
| Description |
Gets the relevancy | ||
| Return | osid.search.terms.IdTerm[] | the relevancy Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelevancyTerms | ||
| Description |
Gets the relevancy terms. | ||
| Return | osid.ontology.RelevancyQueryInspector[] | the relevancy terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorOntologyIdTerms | ||
| Description |
Gets the ancestor ontology | ||
| Return | osid.search.terms.IdTerm[] | the ancestor ontology Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorOntologyTerms | ||
| Description |
Gets the ancestor ontology terms. | ||
| Return | osid.ontology.OntologyQueryInspector[] | the ancestor ontology terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantOntologyIdTerms | ||
| Description |
Gets the descendant ontology | ||
| Return | osid.search.terms.IdTerm[] | the descendant ontology Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantOntologyTerms | ||
| Description |
Gets the descendant ontology terms. | ||
| Return | osid.ontology.OntologyQueryInspector[] | the descendant ontology terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOntologyQueryInspectorRecord | ||
| Description |
Gets the ontology query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | ontologyRecordType | an ontology record type |
| Return | osid.ontology.records.OntologyQueryInspectorRecord | the ontology query inspector record | |
| Errors | NULL_ARGUMENT | ontologyRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(ontologyRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |