Interface | osid.mapping.route.Route | ||
---|---|---|---|
Implements | osid.OsidRelationship | ||
osid.Aggregateable | |||
Description |
A | ||
Method | getStartingLocationId | ||
Description |
Gets the | ||
Return | osid.id.Id | the starting location Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getStartingLocation | ||
Description |
Gets the starting location of this route. | ||
Return | osid.mapping.Location | the starting location | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getEndingLocationId | ||
Description |
Gets the | ||
Return | osid.id.Id | the ending location Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getEndingLocation | ||
Description |
Gets the ending location of this route. | ||
Return | osid.mapping.Location | the ending location | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistance | ||
Description |
Gets the total distance of this route. | ||
Return | osid.mapping.Distance | the total route distance | |
Compliance | mandatory | This method must be implemented. | |
Method | getETA | ||
Description |
Gets the estimated travel time across the entire route. | ||
Return | osid.calendaring.Duration | the estimated travel time | |
Compliance | mandatory | This method must be implemented. | |
Method | getSegmentIds | ||
Description |
Gets the route segment | ||
Return | osid.id.IdList | the segment Ids of this route | |
Compliance | mandatory | This method must be implemented. | |
Method | getSegments | ||
Description |
Gets the segments of this route. | ||
Return | osid.mapping.route.RouteSegmentList | the segments of this route | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getRouteRecord | ||
Description |
Gets the route record corresponding to the given | ||
Parameters | osid.type.Type | routeRecordType | the type of route record to retrieve |
Return | osid.mapping.route.records.RouteRecord | the route 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. |