org.osid.ontology

Interface OntologyQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface OntologyQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining ontology queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorOntologyIdTerms() Gets the ancestor ontology Id terms.
OntologyQueryInspector[]	getAncestorOntologyTerms() Gets the ancestor ontology terms.
IdTerm[]	getDescendantOntologyIdTerms() Gets the descendant ontology Id terms.
OntologyQueryInspector[]	getDescendantOntologyTerms() Gets the descendant ontology terms.
OntologyQueryInspectorRecord	getOntologyQueryInspectorRecord(Type ontologyRecordType) Gets the ontology query inspector record corresponding to the given Ontology record Type.
IdTerm[]	getRelevancyIdTerms() Gets the relevancy Id terms.
RelevancyQueryInspector[]	getRelevancyTerms() Gets the relevancy terms.
IdTerm[]	getSubjectIdTerms() Gets the subject Id terms.
SubjectQueryInspector[]	getSubjectTerms() Gets the subject terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectRelevancyTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getSubjectIdTerms

IdTerm[] getSubjectIdTerms()

Gets the subject Id terms.

Specified by:

getSubjectIdTerms in interface OsidObjectQueryInspector

Returns:

the subject Id terms

Compliance:

mandatory - This method must be implemented.

getSubjectTerms

SubjectQueryInspector[] getSubjectTerms()

Gets the subject terms.

Specified by:

getSubjectTerms in interface OsidObjectQueryInspector

Returns:

the subject terms

Compliance:

mandatory - This method must be implemented.

getRelevancyIdTerms

IdTerm[] getRelevancyIdTerms()

Gets the relevancy Id terms.

Returns:

the relevancy Id terms

Compliance:

mandatory - This method must be implemented.

getRelevancyTerms

RelevancyQueryInspector[] getRelevancyTerms()

Gets the relevancy terms.

Returns:

the relevancy terms

Compliance:

mandatory - This method must be implemented.

getAncestorOntologyIdTerms

IdTerm[] getAncestorOntologyIdTerms()

Gets the ancestor ontology Id terms.

Returns:

the ancestor ontology Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorOntologyTerms

OntologyQueryInspector[] getAncestorOntologyTerms()

Gets the ancestor ontology terms.

Returns:

the ancestor ontology terms

Compliance:

mandatory - This method must be implemented.

getDescendantOntologyIdTerms

IdTerm[] getDescendantOntologyIdTerms()

Gets the descendant ontology Id terms.

Returns:

the descendant ontology Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantOntologyTerms

OntologyQueryInspector[] getDescendantOntologyTerms()

Gets the descendant ontology terms.

Returns:

the descendant ontology terms

Compliance:

mandatory - This method must be implemented.

getOntologyQueryInspectorRecord

OntologyQueryInspectorRecord getOntologyQueryInspectorRecord(Type ontologyRecordType)
                                                             throws OperationFailedException

Gets the ontology query inspector record corresponding to the given Ontology record Type.

Parameters:

ontologyRecordType - an ontology record type

Returns:

the ontology query inspector record

Throws:

NullArgumentException - ontologyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ontologyRecordType) is false

Compliance:

mandatory - This method must be implemented.