OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
topology rules package
Version 3.0.0
Release Candidate Preview
| Interface | osid.topology.rules.EdgeEnablerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQueryInspector | ||
| Description |
This is the query inspector for examining edge enabler queries. | ||
| Method | getRuledEdgeIdTerms | ||
| Description |
Gets the ruled edge | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledEdgeTerms | ||
| Description |
Gets the ruled 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 | getEdgeEnablerQueryInspectorRecord | ||
| Description |
Gets the edge enabler query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | edgeEnablerRecordType | an edge enabler record type |
| Return | osid.topology.rules.records.EdgeEnablerQueryInspectorRecord | the edge enabler query inspector record | |
| Errors | NULL_ARGUMENT | edgeEnablerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(edgeEnablerRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |