public interface ResourceRouteSession extends OsidSession
This session defines methods to track resources on routes.
Modifier and Type | Method and Description |
---|---|
boolean |
canAccessResourceRoutes()
Tests if this user can access the locations of resources.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
ResourceList |
getResourcesOnRoute(Id routeId)
Gets the resources along the given route.
|
ResourceList |
getResourcesOnRouteSegment(Id routeSegmentId)
Gets the resources on the given route segment.
|
RouteProgress |
getRouteProgressForResource(Id resourceId)
Gets the route progress for the given resource.
|
RouteProgressList |
getRouteProgressForResources(IdList resourceIds)
Gets the route progress for the given resources.
|
RouteSegment |
getRouteSegmentForResource(Id resourceId)
Gets the current route of the given resource.
|
RouteSegmentList |
getRouteSegmentsForResources(IdList resourceIds)
Gets the current locations of the given resources.
|
boolean |
isResourceOnARoute(Id resourceId)
Tests if the resource is traveling along a route.
|
void |
useComparativeResourceRouteView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
void |
usePlenaryResourceRouteView()
A complete view of the
Resource returns is desired. |
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 canAccessResourceRoutes()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer location operations to unauthorized
users. false
if location methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeResourceRouteView()
mandatory
- This method is must be implemented. void usePlenaryResourceRouteView()
Resource
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. boolean isResourceOnARoute(Id resourceId)
resourceId
- a resource Id
true
if the resource is on a route,
false
otherrwiseNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. RouteSegment getRouteSegmentForResource(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
IllegalStateException
- isResourceOnARoute()
is false
NotFoundException
- resourceId
is not on
mapNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RouteSegmentList getRouteSegmentsForResources(IdList resourceIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceIds
- a resource listNotFoundException
- a resourceId
is not
on mapNullArgumentException
- resourceIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceList getResourcesOnRoute(Id routeId) throws OperationFailedException, PermissionDeniedException
routeId
- a route Id
NullArgumentException
- routeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceList getResourcesOnRouteSegment(Id routeSegmentId) throws OperationFailedException, PermissionDeniedException
routeSegmentId
- a route segment Id
NullArgumentException
- routeSegmentId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RouteProgress getRouteProgressForResource(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
IllegalStateException
- isResourceOnARoute()
is false
NotFoundException
- resourceId
is not on
mapNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RouteProgressList getRouteProgressForResources(IdList resourceIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceIds
- a resource listNotFoundException
- a resourceId
is not
foundNullArgumentException
- resourceIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.