org.osid.ontology.rules

Interface RelevancyEnablerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface RelevancyEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining relevancy enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getOntologyIdTerms() Gets the ontology Id query terms.
OntologyQueryInspector[]	getOntologyTerms() Gets the ontology query terms.
RelevancyEnablerQueryInspectorRecord	getRelevancyEnablerQueryInspectorRecord(Type relevancyEnablerRecordType) Gets the relevancy enabler query inspector record corresponding to the given RelevancyEnabler record Type.
IdTerm[]	getRuledRelevancyIdTerms() Gets the relevancy Id query terms.
RelevancyQueryInspector[]	getRuledRelevancyTerms() Gets the relevancy query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

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

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

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledRelevancyIdTerms

IdTerm[] getRuledRelevancyIdTerms()

Gets the relevancy Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledRelevancyTerms

RelevancyQueryInspector[] getRuledRelevancyTerms()

Gets the relevancy query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOntologyIdTerms

IdTerm[] getOntologyIdTerms()

Gets the ontology Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOntologyTerms

OntologyQueryInspector[] getOntologyTerms()

Gets the ontology query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRelevancyEnablerQueryInspectorRecord

RelevancyEnablerQueryInspectorRecord getRelevancyEnablerQueryInspectorRecord(Type relevancyEnablerRecordType)
                                                                             throws OperationFailedException

Gets the relevancy enabler query inspector record corresponding to the given RelevancyEnabler record Type.

Parameters:

relevancyEnablerRecordType - a relevancy enabler record type

Returns:

the relevancy enabler query inspector record

Throws:

NullArgumentException - relevancyEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.