OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
mapping route package
Version 3.0.0
Release Candidate Preview
| Interface | osid.mapping.route.RouteSegmentQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Description |
This is the query inspector for examining route segment queries. | ||
| Method | getStartingInstructionsTerms | ||
| Description |
Gets the starting instruction query terms. | ||
| Return | osid.search.terms.StringTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndingInstructionsTerms | ||
| Description |
Gets the ending instruction query terms. | ||
| Return | osid.search.terms.StringTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDistanceTerms | ||
| Description |
Gets the distance query terms. | ||
| Return | osid.search.terms.DistanceRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getETATerms | ||
| Description |
Gets the ETA query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathIdTerms | ||
| Description |
Gets the path | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathTerms | ||
| Description |
Gets the path query terms. | ||
| Return | osid.mapping.path.PathQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteIdTerms | ||
| Description |
Gets the route | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteTerms | ||
| Description |
Gets the route query terms. | ||
| Return | osid.mapping.route.RouteQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteSegmentQueryInspectorRecord | ||
| Description |
Gets the route segment query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | routeSegmentRecordType | a route segment record type |
| Return | osid.mapping.route.records.RouteSegmentQueryInspectorRecord | the route segment query inspector record | |
| Errors | NULL_ARGUMENT | routeSegmentRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(routeSegmentRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |