OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.RouteSegment
Implementsosid.OsidObject
Description

A route segment represents a portion of a route.

MethodgetStartingInstructions
Description

Gets the starting instructions for this segment.

Returnosid.locale.DisplayTextthe starting instructions
CompliancemandatoryThis method must be implemented.
MethodgetEndingInstructions
Description

Gets the ending instructions for this segment.

Returnosid.locale.DisplayTextthe ending instructions
CompliancemandatoryThis method must be implemented.
MethodgetDistance
Description

Gets the length of the entire segment.

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

Gets the estimated travel time across the entire segment.

Returnosid.calendaring.Durationthe estimated travel time
CompliancemandatoryThis method must be implemented.
MethodhasPath
Description

Tests if this segment has a corresponding path.

Returnboolean true if there is a path, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPathId
Description

Gets the corresponding path Id on which this segment travels.

Returnosid.id.Idthe path
ErrorsILLEGAL_STATE hasPath() is null
CompliancemandatoryThis method must be implemented.
MethodgetPath
Description

Gets the corresponding path on which this segment travels.

Returnosid.mapping.path.Paththe path
ErrorsILLEGAL_STATE hasPath() is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRouteSegmentRecord
Description

Gets the route segment record corresponding to the given RouteSegment record Type.

Parametersosid.type.TyperouteSegmentRecordTypea route segment record type
Returnosid.mapping.route.records.RouteSegmentRecordthe route segment record
ErrorsNULL_ARGUMENT routeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasDomainType(routeSegmentRecordType) is false
CompliancemandatoryThis method must be implemented.