public interface RoutingSession extends OsidSession
This session defines methods to traverse through a map.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRoutes()
Tests if this user can query routes.
|
Route |
getFastestRoute(Id locationId,
Id anotherLocationId,
Type routingType)
Gets the fastest route between the two given locations.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
Route |
getRoutes(Id locationId,
Id anotherLocationId)
Gets all routes between the two given locations.
|
TypeList |
getRoutingTypes()
Gets the supported routing types.
|
Route |
getShortestRoute(Id locationId,
Id anotherLocationId,
Type routingType)
Gets the shortest route between the two given locations.
|
boolean |
supportsRoutingType(Type routingType)
Tests if the given routing type is supported.
|
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRoutes()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if routing methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. TypeList getRoutingTypes()
mandatory
- This method must be implemented. boolean supportsRoutingType(Type routingType)
routingType
- a routing type true
of the routing type is supported,
false
otherwiseNullArgumentException
- routingType
is
null
mandatory
- This method must be implemented. Route getShortestRoute(Id locationId, Id anotherLocationId, Type routingType) throws NotFoundException, OperationFailedException, PermissionDeniedException
locationId
- the given location Id
anotherLocationId
- the given location Id
routingType
- a routing typeNotFoundException
- locationId
or
anotherLocationId
is not foundNullArgumentException
- locationId
or
anotherLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
supportsRoutingType(routingType)
is false
mandatory
- This method must be implemented. Route getFastestRoute(Id locationId, Id anotherLocationId, Type routingType) throws NotFoundException, OperationFailedException, PermissionDeniedException
locationId
- the given location Id
anotherLocationId
- the given location Id
routingType
- a routing typeNotFoundException
- locationId
or
anotherLocationId
is not foundNullArgumentException
- locationId
or
anotherLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
supportsRoutingType(routingType)
is false
mandatory
- This method must be implemented. Route getRoutes(Id locationId, Id anotherLocationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
locationId
- the given location Id
anotherLocationId
- the given location Id
NotFoundException
- locationId
or
anotherLocationId
is not foundNullArgumentException
- locationId
or
anotherLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.