org.osid.topology.rules

Interface EdgeEnablerQueryInspector

All Superinterfaces:

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

public interface EdgeEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining edge enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
EdgeEnablerQueryInspectorRecord	getEdgeEnablerQueryInspectorRecord(Type edgeEnablerRecordType) Gets the edge enabler query inspector record corresponding to the given EdgeEnabler record Type.
IdTerm[]	getGraphIdTerms() Gets the graph Id query terms.
GraphQueryInspector[]	getGraphTerms() Gets the graph query terms.
IdTerm[]	getRuledEdgeIdTerms() Gets the ruled edge Id query terms.
EdgeQueryInspector[]	getRuledEdgeTerms() Gets the ruled edge 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

getRuledEdgeIdTerms

IdTerm[] getRuledEdgeIdTerms()

Gets the ruled edge Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledEdgeTerms

EdgeQueryInspector[] getRuledEdgeTerms()

Gets the ruled edge query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getGraphIdTerms

IdTerm[] getGraphIdTerms()

Gets the graph Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getGraphTerms

GraphQueryInspector[] getGraphTerms()

Gets the graph query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerQueryInspectorRecord

EdgeEnablerQueryInspectorRecord getEdgeEnablerQueryInspectorRecord(Type edgeEnablerRecordType)
                                                                   throws OperationFailedException

Gets the edge enabler query inspector record corresponding to the given EdgeEnabler record Type.

Parameters:

edgeEnablerRecordType - an edge enabler record type

Returns:

the edge enabler query inspector record

Throws:

NullArgumentException - edgeEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(edgeEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.