org.osid.topology

Interface EdgeQueryInspector

All Superinterfaces:

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

public interface EdgeQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining edge queries.

Method Summary

Methods

Modifier and Type	Method and Description
BooleanTerm[]	getBiDirectionalTerms() Gets the bi-directional terms.
DecimalRangeTerm[]	getCostTerms() Gets the cost terms.
IdTerm[]	getDestinationNodeIdTerms() Gets the related node Id terms.
NodeQueryInspector[]	getDestinationNodeTerms() Gets the related node terms.
BooleanTerm[]	getDirectionalTerms() Gets the directional terms.
DecimalRangeTerm[]	getDistanceTerms() Gets the distance terms.
EdgeQueryInspectorRecord	getEdgeQueryInspectorRecord(Type edgeRecordType) Gets the edge query inspector record corresponding to the given Edge record Type.
IdTerm[]	getGraphIdTerms() Gets the graph Id terms.
GraphQueryInspector[]	getGraphTerms() Gets the graph terms.
BooleanTerm[]	getSameNodeTerms() Gets the same node terms.
IdTerm[]	getSourceNodeIdTerms() Gets the node Id terms.
NodeQueryInspector[]	getSourceNodeTerms() Gets the node 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, 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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getSourceNodeIdTerms

IdTerm[] getSourceNodeIdTerms()

Gets the node Id terms.

Returns:

the node Id terms

Compliance:

mandatory - This method must be implemented.

getSourceNodeTerms

NodeQueryInspector[] getSourceNodeTerms()

Gets the node terms.

Returns:

the node terms

Compliance:

mandatory - This method must be implemented.

getDestinationNodeIdTerms

IdTerm[] getDestinationNodeIdTerms()

Gets the related node Id terms.

Returns:

the node Id terms

Compliance:

mandatory - This method must be implemented.

getDestinationNodeTerms

NodeQueryInspector[] getDestinationNodeTerms()

Gets the related node terms.

Returns:

the node terms

Compliance:

mandatory - This method must be implemented.

getSameNodeTerms

BooleanTerm[] getSameNodeTerms()

Gets the same node terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDirectionalTerms

BooleanTerm[] getDirectionalTerms()

Gets the directional terms.

Returns:

the directional terms

Compliance:

mandatory - This method must be implemented.

getBiDirectionalTerms

BooleanTerm[] getBiDirectionalTerms()

Gets the bi-directional terms.

Returns:

the directional terms

Compliance:

mandatory - This method must be implemented.

getCostTerms

DecimalRangeTerm[] getCostTerms()

Gets the cost terms.

Returns:

the cost terms

Compliance:

mandatory - This method must be implemented.

getDistanceTerms

DecimalRangeTerm[] getDistanceTerms()

Gets the distance terms.

Returns:

the distance terms

Compliance:

mandatory - This method must be implemented.

getGraphIdTerms

IdTerm[] getGraphIdTerms()

Gets the graph Id terms.

Returns:

the graph Id terms

Compliance:

mandatory - This method must be implemented.

getGraphTerms

GraphQueryInspector[] getGraphTerms()

Gets the graph terms.

Returns:

the graph terms

Compliance:

mandatory - This method must be implemented.

getEdgeQueryInspectorRecord

EdgeQueryInspectorRecord getEdgeQueryInspectorRecord(Type edgeRecordType)
                                                     throws OperationFailedException

Gets the edge query inspector record corresponding to the given Edge record Type.

Parameters:

edgeRecordType - an edge record type

Returns:

the edge query inspector record

Throws:

NullArgumentException - edgeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(edgeRecordType) is false

Compliance:

mandatory - This method must be implemented.