OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.RouteProgress
Implementsosid.OsidCompendium
Description

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

MethodgetResourceId
Description

Gets the Id of the resource on the route.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource on the route.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRouteId
Description

Gets the route Id.

Returnosid.id.Idthe route Id
CompliancemandatoryThis method must be implemented.
MethodgetRoute
Description

Gets the route.

Returnosid.mapping.route.Routethe route
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTimeStarted
Description

Gets the starting time on this route.

Returnosid.calendaring.DateTimethe starting time
CompliancemandatoryThis method must be implemented.
MethodgetTotalDistanceTraveled
Description

Gets the total distance traveled.

Returnosid.mapping.Distancethe distance
CompliancemandatoryThis method must be implemented.
MethodgetTotalTravelTime
Description

Gets the total travel time.

Returnosid.calendaring.Durationtotal travel time
CompliancemandatoryThis method must be implemented.
MethodisInMotion
Description

Tests if the object is in motion.

Returnboolean true if the object is in motion, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTotalIdleTime
Description

Gets the total idle time before completion of the route.

Returnosid.calendaring.Durationtotal idle time
CompliancemandatoryThis method must be implemented.
MethodgetTimeLastMoved
Description

Get sthe time the object last moved.

Returnosid.calendaring.DateTimelast moved time
CompliancemandatoryThis method must be implemented.
MethodisComplete
Description

Tests if the route has been completed.

Returnboolean true if the route has been completed, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRouteSegmentId
Description

Gets the current route segment Id.

Returnosid.id.Idthe route segment Id
ErrorsILLEGAL_STATE isComplete() is true
CompliancemandatoryThis method must be implemented.
MethodgetRouteSegment
Description

Gets the current route segment.

Returnosid.mapping.route.RouteSegmentthe route segment
ErrorsILLEGAL_STATE isComplete() is true
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetETAToNextSegment
Description

Gets the estimated travel time to the next route segment.

Returnosid.calendaring.Durationthe estimated travel time
ErrorsILLEGAL_STATE isComplete() is true
CompliancemandatoryThis method must be implemented.
MethodgetRouteSegmentTraveled
Description

Gets the distance along the current route segment traveled.

Returnosid.mapping.Distancedistance along the current segment traveled
ErrorsILLEGAL_STATE isComplete() is true
CompliancemandatoryThis method must be implemented.
MethodgetTimeCompleted
Description

Gets the ending time for this route.

Returnosid.calendaring.DateTimethe ending time
ErrorsILLEGAL_STATE isComplete() is false
CompliancemandatoryThis method must be implemented.
MethodgetRouteProgressRecord
Description

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

Parametersosid.type.TyperouteProgressRecordTypea route progress record type
Returnosid.mapping.route.records.RouteProgressRecordthe route progress record
ErrorsNULL_ARGUMENT progressRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasDomainType(progressSegmentRecordType) is false
CompliancemandatoryThis method must be implemented.