public interface RouteProgress extends OsidCompendium
Route progress defines methods to get information about progress along a route.
Modifier and Type | Method and Description |
---|---|
Duration |
getETAToNextSegment()
Gets the estimated travel time to the next route segment.
|
Resource |
getResource()
Gets the resource on the route.
|
Id |
getResourceId()
Gets the
Id of the resource on the route. |
Route |
getRoute()
Gets the route.
|
Id |
getRouteId()
Gets the route
Id. |
RouteProgressRecord |
getRouteProgressRecord(Type routeProgressRecordType)
Gets the route progress record corresponding to the given
RouteProgresst record Type. |
RouteSegment |
getRouteSegment()
Gets the current route segment.
|
Id |
getRouteSegmentId()
Gets the current route segment
Id. |
Distance |
getRouteSegmentTraveled()
Gets the distance along the current route segment traveled.
|
DateTime |
getTimeCompleted()
Gets the ending time for this route.
|
DateTime |
getTimeLastMoved()
Get sthe time the object last moved.
|
DateTime |
getTimeStarted()
Gets the starting time on this route.
|
Distance |
getTotalDistanceTraveled()
Gets the total distance traveled.
|
Duration |
getTotalIdleTime()
Gets the total idle time before completion of the route.
|
Duration |
getTotalTravelTime()
Gets the total travel time.
|
boolean |
isComplete()
Tests if the route has been completed.
|
boolean |
isInMotion()
Tests if the object is in motion.
|
getEndDate, getStartDate, isExtrapolated, isInterpolated
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getResourceId()
Id
of the resource on the route. Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getRouteId()
Id.
Id
mandatory
- This method must be implemented. Route getRoute() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getTimeStarted()
mandatory
- This method must be implemented. Distance getTotalDistanceTraveled()
mandatory
- This method must be implemented. Duration getTotalTravelTime()
mandatory
- This method must be implemented. boolean isInMotion()
true
if the object is in motion, false
otherwisemandatory
- This method must be implemented. Duration getTotalIdleTime()
mandatory
- This method must be implemented. DateTime getTimeLastMoved()
mandatory
- This method must be implemented. boolean isComplete()
true
if the route has been completed,
false
otherwisemandatory
- This method must be implemented. Id getRouteSegmentId()
Id.
Id
IllegalStateException
- isComplete()
is
true
mandatory
- This method must be implemented. RouteSegment getRouteSegment() throws OperationFailedException
IllegalStateException
- isComplete()
is
true
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Duration getETAToNextSegment()
IllegalStateException
- isComplete()
is
true
mandatory
- This method must be implemented. Distance getRouteSegmentTraveled()
IllegalStateException
- isComplete()
is
true
mandatory
- This method must be implemented. DateTime getTimeCompleted()
IllegalStateException
- isComplete()
is
false
mandatory
- This method must be implemented. RouteProgressRecord getRouteProgressRecord(Type routeProgressRecordType) throws OperationFailedException
RouteProgresst
record Type.
routeProgressRecordType
- a route progress record typeNullArgumentException
- progressRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasDomainType(progressSegmentRecordType)
is
false
mandatory
- This method must be implemented.