OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
ontology package
Version 3.0.0
Release Candidate Preview
| Interface | osid.ontology.SubjectQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidFederateableQueryInspector | |||
| Description |
This is the query inspector for examining subject queries. | ||
| Method | getAncestorSubjectIdTerms | ||
| Description |
Gets the ancestor subject | ||
| Return | osid.search.terms.IdTerm[] | the ancestor subject Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorSubjectTerms | ||
| Description |
Gets the ancestor subject terms. | ||
| Return | osid.ontology.SubjectQueryInspector[] | the ancestor subject terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantSubjectIdTerms | ||
| Description |
Gets the descendant subject | ||
| Return | osid.search.terms.IdTerm[] | the descendant subject Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantSubjectTerms | ||
| Description |
Gets the descendant subject terms. | ||
| Return | osid.ontology.SubjectQueryInspector[] | the descendant 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 | getOntologyIdTerms | ||
| Description |
Gets the ontology | ||
| Return | osid.search.terms.IdTerm[] | the ontology Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOntologyTerms | ||
| Description |
Gets the ontology terms. | ||
| Return | osid.ontology.OntologyQueryInspector[] | the ontology terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectQueryInspectorRecord | ||
| Description |
Gets the subject query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | subjectRecordType | a subject record type |
| Return | osid.ontology.records.SubjectQueryInspectorRecord | the subject query inspector record | |
| Errors | NULL_ARGUMENT | subjectRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(subjectRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |