Interface | osid.mapping.route.RoutingSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to traverse through a map. | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupRoutes | ||
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 | ||
Return | boolean | false if routing methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedMapView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedMapView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this map only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRoutingTypes | ||
Description |
Gets the supported routing types. | ||
Return | osid.type.TypeList | a list of routing types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRoutingType | ||
Description |
Tests if the given routing type is supported. | ||
Parameters | osid.type.Type | routingType | a routing type |
Return | boolean | true of the routing type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | routingType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getShortestRoute | ||
Description |
Gets the shortest route between the two given locations. | ||
Parameters | osid.id.Id | locationId | the given location Id |
osid.id.Id | anotherLocationId | the given location Id | |
osid.type.Type | routingType | a routing type | |
Return | osid.mapping.route.Route | a list of inbound paths | |
Errors | NOT_FOUND | locationId or anotherLocationId is not found | |
NULL_ARGUMENT | locationId or anotherLocationId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | supportsRoutingType(routingType) is false | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFastestRoute | ||
Description |
Gets the fastest route between the two given locations. | ||
Parameters | osid.id.Id | locationId | the given location Id |
osid.id.Id | anotherLocationId | the given location Id | |
osid.type.Type | routingType | a routing type | |
Return | osid.mapping.route.Route | a list of inbound paths | |
Errors | NOT_FOUND | locationId or anotherLocationId is not found | |
NULL_ARGUMENT | locationId or anotherLocationId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | supportsRoutingType(routingType) is false | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutes | ||
Description |
Gets all routes between the two given locations. | ||
Parameters | osid.id.Id | locationId | the given location Id |
osid.id.Id | anotherLocationId | the given location Id | |
Return | osid.mapping.route.Route | a list of inbound paths | |
Errors | NOT_FOUND | locationId or anotherLocationId is not found | |
NULL_ARGUMENT | locationId or anotherLocationId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |