OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
topology package
Version 3.0.0
Release Candidate Preview
| Interface | osid.topology.EdgeQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Description |
This is the query inspector for examining edge queries. | ||
| Method | getSourceNodeIdTerms | ||
| Description |
Gets the node | ||
| Return | osid.search.terms.IdTerm[] | the node Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSourceNodeTerms | ||
| Description |
Gets the node terms. | ||
| Return | osid.topology.NodeQueryInspector[] | the node terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDestinationNodeIdTerms | ||
| Description |
Gets the related node | ||
| Return | osid.search.terms.IdTerm[] | the node Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDestinationNodeTerms | ||
| Description |
Gets the related node terms. | ||
| Return | osid.topology.NodeQueryInspector[] | the node terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSameNodeTerms | ||
| Description |
Gets the same node terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDirectionalTerms | ||
| Description |
Gets the directional terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the directional terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBiDirectionalTerms | ||
| Description |
Gets the bi-directional terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the directional terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCostTerms | ||
| Description |
Gets the cost terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the cost terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDistanceTerms | ||
| Description |
Gets the distance terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the distance terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGraphIdTerms | ||
| Description |
Gets the graph | ||
| Return | osid.search.terms.IdTerm[] | the graph Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGraphTerms | ||
| Description |
Gets the graph terms. | ||
| Return | osid.topology.GraphQueryInspector[] | the graph terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEdgeQueryInspectorRecord | ||
| Description |
Gets the edge query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | edgeRecordType | an edge record type |
| Return | osid.topology.records.EdgeQueryInspectorRecord | the edge query inspector record | |
| Errors | NULL_ARGUMENT | edgeRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(edgeRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |