org.osid.topology

Interface NodeQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface NodeQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining node queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getEdgeIdTerms() Gets the edge Id terms.
EdgeQueryInspector[]	getEdgeTerms() Gets the edge terms.
IdTerm[]	getGraphIdTerms() Gets the graph Id terms.
GraphQueryInspector[]	getGraphTerms() Gets the graph terms.
NodeQueryInspectorRecord	getNodeQueryInspectorRecord(Type nodeRecordType) Gets the node query inspector record corresponding to the given Node record Type.

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

Method Detail

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.

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.

getNodeQueryInspectorRecord

NodeQueryInspectorRecord getNodeQueryInspectorRecord(Type nodeRecordType)
                                                     throws OperationFailedException

Gets the node query inspector record corresponding to the given Node record Type.

Parameters:

nodeRecordType - a node record type

Returns:

the node query inspector record

Throws:

NullArgumentException - nodeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(nodeRecordType) is false

Compliance:

mandatory - This method must be implemented.