OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.Route
Implementsosid.OsidRelationship
osid.Aggregateable
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.

MethodgetStartingLocationId
Description

Gets the Id of the starting location of this route.

Returnosid.id.Idthe starting location Id
CompliancemandatoryThis method must be implemented.
MethodgetStartingLocation
Description

Gets the starting location of this route.

Returnosid.mapping.Locationthe starting location
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetEndingLocationId
Description

Gets the Id of the ending location of this route.

Returnosid.id.Idthe ending location Id
CompliancemandatoryThis method must be implemented.
MethodgetEndingLocation
Description

Gets the ending location of this route.

Returnosid.mapping.Locationthe ending location
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDistance
Description

Gets the total distance of this route.

Returnosid.mapping.Distancethe total route distance
CompliancemandatoryThis method must be implemented.
MethodgetETA
Description

Gets the estimated travel time across the entire route.

Returnosid.calendaring.Durationthe estimated travel time
CompliancemandatoryThis method must be implemented.
MethodgetSegmentIds
Description

Gets the route segment Ids of this route.

Returnosid.id.IdListthe segment Ids of this route
CompliancemandatoryThis method must be implemented.
MethodgetSegments
Description

Gets the segments of this route.

Returnosid.mapping.route.RouteSegmentListthe segments of this route
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRouteRecord
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 .

Parametersosid.type.TyperouteRecordTypethe type of route record to retrieve
Returnosid.mapping.route.records.RouteRecordthe route record
ErrorsNULL_ARGUMENT routeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(routeRecordType) is false
CompliancemandatoryThis method must be implemented.