OSID Specifications
topology path package
Version 3.0.0
Release Candidate Preview
topology path package
Version 3.0.0
Release Candidate Preview
| Interface | osid.topology.path.PathQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
osid.OsidAggregateableQueryInspector | |||
| Description |
This is the query inspector for examining path queries. | ||
| Method | getCompleteTerms | ||
| Description |
Gets the complete query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getClosedTerms | ||
| Description |
Gets the closed query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStartingNodeIdTerms | ||
| Description |
Gets the starting node | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStartingNodeTerms | ||
| Description |
Gets the starting node query terms. | ||
| Return | osid.topology.NodeQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndingNodeIdTerms | ||
| Description |
Gets the ending node | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndingNodeTerms | ||
| Description |
Gets the ending node query terms. | ||
| Return | osid.topology.NodeQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAlongNodeIdsTerms | ||
| Description |
Gets the along node | ||
| Return | osid.search.terms.IdSetTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIntersectingPathIdTerms | ||
| Description |
Gets the intersecting path | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIntersectingPathTerms | ||
| Description |
Gets the intersecting path query terms. | ||
| Return | osid.topology.path.PathQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getHopsTerms | ||
| Description |
Gets the hops query terms. | ||
| Return | osid.search.terms.CardinalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDistanceTerms | ||
| Description |
Gets the distance query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCostTerms | ||
| Description |
Gets the cost query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNodeIdTerms | ||
| Description |
Gets the node | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNodeTerms | ||
| Description |
Gets the node query terms. | ||
| Return | osid.topology.NodeQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEdgeIdTerms | ||
| Description |
Gets the edge | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEdgeTerms | ||
| Description |
Gets the edge query terms. | ||
| Return | osid.topology.EdgeQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGraphIdTerms | ||
| Description |
Gets the graph | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGraphTerms | ||
| Description |
Gets the graph query terms. | ||
| Return | osid.topology.GraphQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathQueryInspectorRecord | ||
| Description |
Gets the path query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | pathRecordType | a path record type |
| Return | osid.topology.path.records.PathQueryInspectorRecord | the path query inspector record | |
| Errors | NULL_ARGUMENT | pathRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(pathRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |