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.RouteQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
osid.OsidAggregateableQueryInspector | |||
| Description |
This is the query inspector for examining route queries. | ||
| Method | getStartingLocationIdTerms | ||
| Description |
Gets the starting location | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStartingLocationTerms | ||
| Description |
Gets the starting location query terms. | ||
| Return | osid.mapping.LocationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndingLocationIdTerms | ||
| Description |
Gets the ending location | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndingLocationTerms | ||
| Description |
Gets the ending location query terms. | ||
| Return | osid.mapping.LocationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAlongLocationIdsTerms | ||
| Description |
Gets the along location | ||
| Return | osid.search.terms.IdSetTerm[] | 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 | getLocationIdTerms | ||
| Description |
Gets the location | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationTerms | ||
| Description |
Gets the location query terms. | ||
| Return | osid.mapping.LocationQueryInspector[] | 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 | getMapIdTerms | ||
| Description |
Gets the map | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMapTerms | ||
| Description |
Gets the map query terms. | ||
| Return | osid.mapping.MapQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteQueryInspectorRecord | ||
| Description |
Gets the route query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | routeRecordType | a route record type |
| Return | osid.mapping.route.records.RouteQueryInspectorRecord | the route query inspector record | |
| Errors | NULL_ARGUMENT | routeRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(routeRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |