OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
topology package
Version 3.0.0
Release Candidate Preview
| Interface | osid.topology.GraphQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining graph queries. | ||
| Method | getNodeIdTerms | ||
| Description |
Gets the node | ||
| Return | osid.search.terms.IdTerm[] | the node Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNodeTerms | ||
| Description |
Gets the node terms. | ||
| Return | osid.topology.NodeQueryInspector[] | the node terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEdgeIdTerms | ||
| Description |
Gets the edge | ||
| Return | osid.search.terms.IdTerm[] | the edge Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEdgeTerms | ||
| Description |
Gets the edge terms. | ||
| Return | osid.topology.EdgeQueryInspector[] | the edge terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorGraphIdTerms | ||
| Description |
Gets the ancestor graph | ||
| Return | osid.search.terms.IdTerm[] | the ancestor graph Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorGraphTerms | ||
| Description |
Gets the ancestor graph terms. | ||
| Return | osid.topology.GraphQueryInspector[] | the ancestor graph terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantGraphIdTerms | ||
| Description |
Gets the descendant graph | ||
| Return | osid.search.terms.IdTerm[] | the descendant graph Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantGraphTerms | ||
| Description |
Gets the descendant graph terms. | ||
| Return | osid.topology.GraphQueryInspector[] | the descendant graph terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGraphQueryInspectorRecord | ||
| Description |
Gets thegraph query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | graphRecordType | a graph record type |
| Return | osid.topology.records.GraphQueryInspectorRecord | the graph query inspector record | |
| Errors | NULL_ARGUMENT | graphRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(graphRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |