public interface Route extends OsidRelationship, Aggregateable
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.
Modifier and Type | Method and Description |
---|---|
Distance |
getDistance()
Gets the total distance of this route.
|
Location |
getEndingLocation()
Gets the ending location of this route.
|
Id |
getEndingLocationId()
Gets the
Id of the ending location of this route. |
Duration |
getETA()
Gets the estimated travel time across the entire route.
|
RouteRecord |
getRouteRecord(Type routeRecordType)
Gets the route record corresponding to the given
Route
record Type. |
IdList |
getSegmentIds()
Gets the route segment
Ids of this route. |
RouteSegmentList |
getSegments()
Gets the segments of this route.
|
Location |
getStartingLocation()
Gets the starting location of this route.
|
Id |
getStartingLocationId()
Gets the
Id of the starting location of this route. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getStartingLocationId()
Id
of the starting location of this route. Id
mandatory
- This method must be implemented. Location getStartingLocation() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getEndingLocationId()
Id
of the ending location of this route. Id
mandatory
- This method must be implemented. Location getEndingLocation() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Distance getDistance()
mandatory
- This method must be implemented. Duration getETA()
mandatory
- This method must be implemented. IdList getSegmentIds()
Ids
of this route. Ids
of this routemandatory
- This method must be implemented. RouteSegmentList getSegments() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. RouteRecord getRouteRecord(Type routeRecordType) throws OperationFailedException
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
.routeRecordType
- the type of route record to retrieveNullArgumentException
- routeRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(routeRecordType)
is false
mandatory
- This method must be implemented.