OSID Logo
OSID Specifications
topology path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.path.PathQueryInspector
Implementsosid.OsidRelationshipQueryInspector
osid.OsidAggregateableQueryInspector
Description

This is the query inspector for examining path queries.

MethodgetCompleteTerms
Description

Gets the complete query terms.

Returnosid.search.terms.BooleanTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetClosedTerms
Description

Gets the closed query terms.

Returnosid.search.terms.BooleanTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetStartingNodeIdTerms
Description

Gets the starting node Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetStartingNodeTerms
Description

Gets the starting node query terms.

Returnosid.topology.NodeQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetEndingNodeIdTerms
Description

Gets the ending node Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetEndingNodeTerms
Description

Gets the ending node query terms.

Returnosid.topology.NodeQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAlongNodeIdsTerms
Description

Gets the along node Id query terms.

Returnosid.search.terms.IdSetTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetIntersectingPathIdTerms
Description

Gets the intersecting path Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetIntersectingPathTerms
Description

Gets the intersecting path query terms.

Returnosid.topology.path.PathQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetHopsTerms
Description

Gets the hops query terms.

Returnosid.search.terms.CardinalRangeTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDistanceTerms
Description

Gets the distance query terms.

Returnosid.search.terms.DecimalRangeTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetCostTerms
Description

Gets the cost query terms.

Returnosid.search.terms.DecimalRangeTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetNodeIdTerms
Description

Gets the node Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetNodeTerms
Description

Gets the node query terms.

Returnosid.topology.NodeQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetEdgeIdTerms
Description

Gets the edge Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetEdgeTerms
Description

Gets the edge query terms.

Returnosid.topology.EdgeQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetGraphIdTerms
Description

Gets the graph Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetGraphTerms
Description

Gets the graph query terms.

Returnosid.topology.GraphQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetPathQueryInspectorRecord
Description

Gets the path query inspector record corresponding to the given Path record Type.

Parametersosid.type.TypepathRecordTypea path record type
Returnosid.topology.path.records.PathQueryInspectorRecordthe path query inspector record
ErrorsNULL_ARGUMENT pathRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(pathRecordType) is false
CompliancemandatoryThis method must be implemented.