OSID Specifications
mapping route package
Version 3.1.0
mapping route package
Version 3.1.0
| Interface | osid.mapping.route.RouteSegment | ||
|---|---|---|---|
| Implements | osid.OsidObject | ||
| Used By | osid.mapping.route.MyRouteSession | ||
osid.mapping.route.ResourceRouteSession | |||
osid.mapping.route.RouteAdminSession | |||
osid.mapping.route.RouteProgress | |||
osid.mapping.route.RouteSegmentList | |||
| Description |
A route segment represents a portion of a route. | ||
| Method | getStartingInstructions | ||
| Description |
Gets the starting instructions for this segment. | ||
| Return | osid.locale.DisplayText | the starting instructions | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndingInstructions | ||
| Description |
Gets the ending instructions for this segment. | ||
| Return | osid.locale.DisplayText | the ending instructions | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDistance | ||
| Description |
Gets the length of the entire segment. | ||
| Return | osid.mapping.Distance | the distance | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getETA | ||
| Description |
Gets the estimated travel time across the entire segment. | ||
| Return | osid.calendaring.Duration | the estimated travel time | |
| Compliance | mandatory | This method must be implemented. | |
| Method | hasPath | ||
| Description |
Tests if this segment has a corresponding path. | ||
| Return | boolean | true if there is a path, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathId | ||
| Description |
Gets the corresponding path | ||
| Return | osid.id.Id | the path | |
| Errors | ILLEGAL_STATE | hasPath() is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPath | ||
| Description |
Gets the corresponding path on which this segment travels. | ||
| Return | osid.mapping.path.Path | the path | |
| Errors | ILLEGAL_STATE | hasPath() is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteSegmentRecord | ||
| Description |
Gets the route segment record corresponding to the
given | ||
| Parameters | osid.type.Type | routeSegmentRecordType | a route segment record type |
| Return | osid.mapping.route.records.RouteSegmentRecord | the route segment record | |
| Errors | NULL_ARGUMENT | routeRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasDomainType(routeSegmentRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |