OSID - osid.mapping.route.Route Service Interface Definition

Interface	osid.mapping.route.Route
Implements	`osid.OsidRelationship`
Implements	`osid.Aggregateable`
Used By	`osid.mapping.route.MyRouteSession`
	`osid.mapping.route.RouteAdminSession`
	`osid.mapping.route.RouteList`
	`osid.mapping.route.RouteLookupSession`
	`osid.mapping.route.RouteProgress`
	`osid.mapping.route.RoutingSession`
Description	A `Route` represents one or more paths between two locations. A `Route` is created from a series of `RouteSegments` which, in turn, may relate to a `Path`. A `Path` is an object representation of a fixed means of travel between two locations, such as a road.
Method	getStartingLocationId
Description	Gets the `Id` of the starting location of this route.
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 `Id` of the ending location of this route.
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 `Ids` of this route.
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 `Route` record `Type`.This method is used to retrieve an object implementing the requested record. The `pathRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(routeRecordType)` is `true`.
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.