public interface RouteSegment extends OsidObject
A route segment represents a portion of a route.
Modifier and Type | Method and Description |
---|---|
Distance |
getDistance()
Gets the length of the entire segment.
|
DisplayText |
getEndingInstructions()
Gets the ending instructions for this segment.
|
Duration |
getETA()
Gets the estimated travel time across the entire segment.
|
Path |
getPath()
Gets the corresponding path on which this segment travels.
|
Id |
getPathId()
Gets the corresponding path
Id on which this segment
travels. |
RouteSegmentRecord |
getRouteSegmentRecord(Type routeSegmentRecordType)
Gets the route segment record corresponding to the given
RouteSegment record Type. |
DisplayText |
getStartingInstructions()
Gets the starting instructions for this segment.
|
boolean |
hasPath()
Tests if this segment has a corresponding path.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DisplayText getStartingInstructions()
mandatory
- This method must be implemented. DisplayText getEndingInstructions()
mandatory
- This method must be implemented. Distance getDistance()
mandatory
- This method must be implemented. Duration getETA()
mandatory
- This method must be implemented. boolean hasPath()
true
if there is a path, false
otherwisemandatory
- This method must be implemented. Id getPathId()
Id
on which this segment
travels.IllegalStateException
- hasPath()
is
null
mandatory
- This method must be implemented. Path getPath() throws OperationFailedException
IllegalStateException
- hasPath()
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. RouteSegmentRecord getRouteSegmentRecord(Type routeSegmentRecordType) throws OperationFailedException
RouteSegment
record Type.
routeSegmentRecordType
- a route segment record typeNullArgumentException
- routeRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasDomainType(routeSegmentRecordType)
is false
mandatory
- This method must be implemented.