public interface ResourceRouteAssignmentSession extends OsidSession
This session defines methods to manage resources on routes.
Modifier and Type | Method and Description |
---|---|
void |
assignResourceToRoute(Id resourceId,
Id routeId)
Assigns a resource to a route.
|
boolean |
canAssignResourceRoutes()
Tests if this user can set the routes for resources.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
removeResourceFromRoute(Id resourceId,
Id routeId)
Unassigns a resource from a route.
|
void |
updateRouteSegmentForResource(Id resourceId,
Id routeSegmentId)
Updates the route segment for a resource.
|
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 canAssignResourceRoutes()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer assignment operations to unauthorized
users. false
if routing methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void assignResourceToRoute(Id resourceId, Id routeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
routeId
- a route Id
AlreadyExistsException
- resourceId
already on routeId
NotFoundException
- resourceId
or
routeId
is not foundNullArgumentException
- resourceId
or
routeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateRouteSegmentForResource(Id resourceId, Id routeSegmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
routeSegmentId
- a route segment Id
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
or
routeSegmentId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- coordinate not supportedmandatory
- This method must be implemented. void removeResourceFromRoute(Id resourceId, Id routeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
routeId
- a route Id
NotFoundException
- resourceId
or
routeId
is not foundNullArgumentException
- resourceId
or
routeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.