org.osid.mapping.route

Interface RouteProgress

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidCompendium, OsidObject, Subjugateable

public interface RouteProgress
extends OsidCompendium

Route progress defines methods to get information about progress along a route.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidCompendium

getEndDate, getStartDate, isExtrapolated, isInterpolated

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getResourceId

Id getResourceId()

Gets the Id of the resource on the route.

Returns:

the resource Id

Compliance:

mandatory - This method must be implemented.

getResource

Resource getResource()
                     throws OperationFailedException

Gets the resource on the route.

Returns:

the resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getRouteId

Id getRouteId()

Gets the route Id.

Returns:

the route Id

Compliance:

mandatory - This method must be implemented.

getRoute

Route getRoute()
               throws OperationFailedException

Gets the route.

Returns:

the route

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTimeStarted

DateTime getTimeStarted()

Gets the starting time on this route.

Returns:

the starting time

Compliance:

mandatory - This method must be implemented.

getTotalDistanceTraveled

Distance getTotalDistanceTraveled()

Gets the total distance traveled.

Returns:

the distance

Compliance:

mandatory - This method must be implemented.

getTotalTravelTime

Duration getTotalTravelTime()

Gets the total travel time.

Returns:

total travel time

Compliance:

mandatory - This method must be implemented.

isInMotion

boolean isInMotion()

Tests if the object is in motion.

Returns:

true if the object is in motion, false otherwise

Compliance:

mandatory - This method must be implemented.

getTotalIdleTime

Duration getTotalIdleTime()

Gets the total idle time before completion of the route.

Returns:

total idle time

Compliance:

mandatory - This method must be implemented.

getTimeLastMoved

DateTime getTimeLastMoved()

Get sthe time the object last moved.

Returns:

last moved time

Compliance:

mandatory - This method must be implemented.

isComplete

boolean isComplete()

Tests if the route has been completed.

Returns:

true if the route has been completed, false otherwise

Compliance:

mandatory - This method must be implemented.

getRouteSegmentId

Id getRouteSegmentId()

Gets the current route segment Id.

Returns:

the route segment Id

Throws:

IllegalStateException - isComplete() is true

Compliance:

mandatory - This method must be implemented.

getRouteSegment

RouteSegment getRouteSegment()
                             throws OperationFailedException

Gets the current route segment.

Returns:

the route segment

Throws:

IllegalStateException - isComplete() is true

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getETAToNextSegment

Duration getETAToNextSegment()

Gets the estimated travel time to the next route segment.

Returns:

the estimated travel time

Throws:

IllegalStateException - isComplete() is true

Compliance:

mandatory - This method must be implemented.

getRouteSegmentTraveled

Distance getRouteSegmentTraveled()

Gets the distance along the current route segment traveled.

Returns:

distance along the current segment traveled

Throws:

IllegalStateException - isComplete() is true

Compliance:

mandatory - This method must be implemented.

getTimeCompleted

DateTime getTimeCompleted()

Gets the ending time for this route.

Returns:

the ending time

Throws:

IllegalStateException - isComplete() is false

Compliance:

mandatory - This method must be implemented.

getRouteProgressRecord

RouteProgressRecord getRouteProgressRecord(Type routeProgressRecordType)
                                           throws OperationFailedException

Gets the route progress record corresponding to the given RouteProgresst record Type.

Parameters:

routeProgressRecordType - a route progress record type

Returns:

the route progress record

Throws:

NullArgumentException - progressRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasDomainType(progressSegmentRecordType) is false

Compliance:

mandatory - This method must be implemented.