org.osid.topology

Interface GraphQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface GraphQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining graph queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorGraphIdTerms() Gets the ancestor graph Id terms.
GraphQueryInspector[]	getAncestorGraphTerms() Gets the ancestor graph terms.
IdTerm[]	getDescendantGraphIdTerms() Gets the descendant graph Id terms.
GraphQueryInspector[]	getDescendantGraphTerms() Gets the descendant graph terms.
IdTerm[]	getEdgeIdTerms() Gets the edge Id terms.
EdgeQueryInspector[]	getEdgeTerms() Gets the edge terms.
GraphQueryInspectorRecord	getGraphQueryInspectorRecord(Type graphRecordType) Gets thegraph query inspector record corresponding to the given Graph record Type.
IdTerm[]	getNodeIdTerms() Gets the node Id terms.
NodeQueryInspector[]	getNodeTerms() Gets the node terms.

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

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getNodeIdTerms

IdTerm[] getNodeIdTerms()

Gets the node Id terms.

Returns:

the node Id terms

Compliance:

mandatory - This method must be implemented.

getNodeTerms

NodeQueryInspector[] getNodeTerms()

Gets the node terms.

Returns:

the node terms

Compliance:

mandatory - This method must be implemented.

getEdgeIdTerms

IdTerm[] getEdgeIdTerms()

Gets the edge Id terms.

Returns:

the edge Id terms

Compliance:

mandatory - This method must be implemented.

getEdgeTerms

EdgeQueryInspector[] getEdgeTerms()

Gets the edge terms.

Returns:

the edge terms

Compliance:

mandatory - This method must be implemented.

getAncestorGraphIdTerms

IdTerm[] getAncestorGraphIdTerms()

Gets the ancestor graph Id terms.

Returns:

the ancestor graph Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorGraphTerms

GraphQueryInspector[] getAncestorGraphTerms()

Gets the ancestor graph terms.

Returns:

the ancestor graph terms

Compliance:

mandatory - This method must be implemented.

getDescendantGraphIdTerms

IdTerm[] getDescendantGraphIdTerms()

Gets the descendant graph Id terms.

Returns:

the descendant graph Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantGraphTerms

GraphQueryInspector[] getDescendantGraphTerms()

Gets the descendant graph terms.

Returns:

the descendant graph terms

Compliance:

mandatory - This method must be implemented.

getGraphQueryInspectorRecord

GraphQueryInspectorRecord getGraphQueryInspectorRecord(Type graphRecordType)
                                                       throws OperationFailedException

Gets thegraph query inspector record corresponding to the given Graph record Type.

Parameters:

graphRecordType - a graph record type

Returns:

the graph query inspector record

Throws:

NullArgumentException - graphRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(graphRecordType) is false

Compliance:

mandatory - This method must be implemented.