OSID - osid.mapping.route.RouteProgress Service Interface Definition

Interface	osid.mapping.route.RouteProgress
Implements	`osid.OsidCompendium`
Used By	`osid.mapping.route.MyRouteSession`
	`osid.mapping.route.ResourceRouteSession`
	`osid.mapping.route.RouteProgressList`
Description	Route progress defines methods to get information about progress along a route.
Method	getResourceId
Description	Gets the `Id` of the resource on the route.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getResource
Description	Gets the resource on the route.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRouteId
Description	Gets the route `Id`.
Return	`osid.id.Id`		the route `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getRoute
Description	Gets the route.
Return	`osid.mapping.route.Route`		the route
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTimeStarted
Description	Gets the starting time on this route.
Return	`osid.calendaring.DateTime`		the starting time
Compliance	`mandatory`		This method must be implemented.
Method	getTotalDistanceTraveled
Description	Gets the total distance traveled.
Return	`osid.mapping.Distance`		the distance
Compliance	`mandatory`		This method must be implemented.
Method	getTotalTravelTime
Description	Gets the total travel time.
Return	`osid.calendaring.Duration`		total travel time
Compliance	`mandatory`		This method must be implemented.
Method	isInMotion
Description	Tests if the object is in motion.
Return	`boolean`		`true` if the object is in motion, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTotalIdleTime
Description	Gets the total idle time before completion of the route.
Return	`osid.calendaring.Duration`		total idle time
Compliance	`mandatory`		This method must be implemented.
Method	getTimeLastMoved
Description	Get sthe time the object last moved.
Return	`osid.calendaring.DateTime`		last moved time
Compliance	`mandatory`		This method must be implemented.
Method	isComplete
Description	Tests if the route has been completed.
Return	`boolean`		`true` if the route has been completed, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSegmentId
Description	Gets the current route segment `Id`.
Return	`osid.id.Id`		the route segment `Id`
Errors	ILLEGAL_STATE		`isComplete()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSegment
Description	Gets the current route segment.
Return	`osid.mapping.route.RouteSegment`		the route segment
Errors	ILLEGAL_STATE		`isComplete()` is `true`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getETAToNextSegment
Description	Gets the estimated travel time to the next route segment.
Return	`osid.calendaring.Duration`		the estimated travel time
Errors	ILLEGAL_STATE		`isComplete()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSegmentTraveled
Description	Gets the distance along the current route segment traveled.
Return	`osid.mapping.Distance`		distance along the current segment traveled
Errors	ILLEGAL_STATE		`isComplete()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCompleted
Description	Gets the ending time for this route.
Return	`osid.calendaring.DateTime`		the ending time
Errors	ILLEGAL_STATE		`isComplete()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRouteProgressRecord
Description	Gets the route progress record corresponding to the given `RouteProgresst` record `Type` .
Parameters	`osid.type.Type`	`routeProgressRecordType`	a route progress record type
Return	`osid.mapping.route.records.RouteProgressRecord`		the route progress record
Errors	NULL_ARGUMENT		`progressRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasDomainType(progressSegmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.