org.osid.relationship.rules

Interface RelationshipEnablerQueryInspector

All Superinterfaces:

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

public interface RelationshipEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining relationship enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getFamilyIdTerms() Gets the family Id query terms.
FamilyQueryInspector[]	getFamilyTerms() Gets the family query terms.
RelationshipEnablerQueryInspectorRecord	getRelationshipEnablerQueryInspectorRecord(Type relationshipEnablerRecordType) Gets the relationship enabler query inspector record corresponding to the given RelationshipEnabler record Type.
IdTerm[]	getRuledRelationshipIdTerms() Gets the relationship Id query terms.
RelationshipQueryInspector[]	getRuledRelationshipTerms() Gets the relationship 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

getRuledRelationshipIdTerms

IdTerm[] getRuledRelationshipIdTerms()

Gets the relationship Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledRelationshipTerms

RelationshipQueryInspector[] getRuledRelationshipTerms()

Gets the relationship query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFamilyIdTerms

IdTerm[] getFamilyIdTerms()

Gets the family Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFamilyTerms

FamilyQueryInspector[] getFamilyTerms()

Gets the family query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablerQueryInspectorRecord

RelationshipEnablerQueryInspectorRecord getRelationshipEnablerQueryInspectorRecord(Type relationshipEnablerRecordType)
                                                                                   throws OperationFailedException

Gets the relationship enabler query inspector record corresponding to the given RelationshipEnabler record Type.

Parameters:

relationshipEnablerRecordType - a relationship enabler record type

Returns:

the relationship enabler query inspector record

Throws:

NullArgumentException - relationshipEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relationshipEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.