org.osid.ontology

Interface RelevancyQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface RelevancyQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining relevancy queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getMappedIdTerms() Gets the mapped Id terms.
IdTerm[]	getOntologyIdTerms() Gets the ontology Id terms.
OntologyQueryInspector[]	getOntologyTerms() Gets the ontology terms.
RelevancyQueryInspectorRecord	getRelevancyQueryInspectorRecord(Type relevancyRecordType) Gets the relevancy query inspector record corresponding to the given Relevancy record Type.
IdTerm[]	getSubjectIdTerms() Gets the subject Id terms.
SubjectQueryInspector[]	getSubjectTerms() Gets the subject terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

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.

getMappedIdTerms

IdTerm[] getMappedIdTerms()

Gets the mapped Id terms.

Returns:

the mapped Id terms

Compliance:

mandatory - This method must be implemented.

getOntologyIdTerms

IdTerm[] getOntologyIdTerms()

Gets the ontology Id terms.

Returns:

the ontology Id terms

Compliance:

mandatory - This method must be implemented.

getOntologyTerms

OntologyQueryInspector[] getOntologyTerms()

Gets the ontology terms.

Returns:

the ontology terms

Compliance:

mandatory - This method must be implemented.

getRelevancyQueryInspectorRecord

RelevancyQueryInspectorRecord getRelevancyQueryInspectorRecord(Type relevancyRecordType)
                                                               throws OperationFailedException

Gets the relevancy query inspector record corresponding to the given Relevancy record Type.

Parameters:

relevancyRecordType - a relevancy record type

Returns:

the relevancy query inspector record

Throws:

NullArgumentException - relevancyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyRecordType) is false

Compliance:

mandatory - This method must be implemented.