OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.RoutingSession
Implementsosid.OsidSession
Description

This session defines methods to traverse through a map.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupRoutes
Description

Tests if this user can query routes. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if routing methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedMapView
Description

Federates the view for methods in this session. A federated view will include paths in maps which are children of this map in the map hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this map only.

CompliancemandatoryThis method is must be implemented.
MethodgetRoutingTypes
Description

Gets the supported routing types.

Returnosid.type.TypeLista list of routing types
CompliancemandatoryThis method must be implemented.
MethodsupportsRoutingType
Description

Tests if the given routing type is supported.

Parametersosid.type.TyperoutingTypea routing type
Returnboolean true of the routing type is supported, false otherwise
ErrorsNULL_ARGUMENT routingType is null
CompliancemandatoryThis method must be implemented.
MethodgetShortestRoute
Description

Gets the shortest route between the two given locations.

Parametersosid.id.IdlocationIdthe given location Id
osid.id.IdanotherLocationIdthe given location Id
osid.type.TyperoutingTypea routing type
Returnosid.mapping.route.Routea list of inbound paths
ErrorsNOT_FOUND locationId or anotherLocationId is not found
NULL_ARGUMENT locationId or anotherLocationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED supportsRoutingType(routingType) is false
CompliancemandatoryThis method must be implemented.
MethodgetFastestRoute
Description

Gets the fastest route between the two given locations.

Parametersosid.id.IdlocationIdthe given location Id
osid.id.IdanotherLocationIdthe given location Id
osid.type.TyperoutingTypea routing type
Returnosid.mapping.route.Routea list of inbound paths
ErrorsNOT_FOUND locationId or anotherLocationId is not found
NULL_ARGUMENT locationId or anotherLocationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED supportsRoutingType(routingType) is false
CompliancemandatoryThis method must be implemented.
MethodgetRoutes
Description

Gets all routes between the two given locations.

Parametersosid.id.IdlocationIdthe given location Id
osid.id.IdanotherLocationIdthe given location Id
Returnosid.mapping.route.Routea list of inbound paths
ErrorsNOT_FOUND locationId or anotherLocationId is not found
NULL_ARGUMENT locationId or anotherLocationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.