public interface RouteMapAssignmentSession extends OsidSession
This session provides methods to re-assign Routes
to
Map
objects. A Route
may appear in multiple
Map
objects and removing the last reference to a
Route
is the equivalent of deleting it. Each Map
may have its own authorizations governing who is allowed to operate on it.
Adding a reference of a Route
to another Map
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignRouteToMap(Id routeId,
Id mapId)
Adds an existing
Route to a Map. |
boolean |
canAssignRoutes()
Tests if this user can alter route/map mappings.
|
boolean |
canAssignRoutesToMap(Id mapId)
Tests if this user can alter route/map mappings.
|
IdList |
getAssignableMapIds(Id mapId)
Gets a list of maps including and under the given map node in which
any route can be assigned.
|
IdList |
getAssignableMapIdsForRoute(Id mapId,
Id routeId)
Gets a list of maps including and under the given map node in which a
specific route can be assigned.
|
void |
reassignCreditToMap(Id routeId,
Id fromMapId,
Id toMapId)
Moves a
Route from one Map to another. |
void |
unassignRouteFromMap(Id routeId,
Id mapId)
Removes a
Route from a Map. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignRoutes()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignRoutesToMap(Id mapId)
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer assignment operations to
unauthorized users.mapId
- the Id
of the Map
false
if mapping is not authorized, true
otherwiseNullArgumentException
- mapId
is
null
mandatory
- This method must be implemented. IdList getAssignableMapIds(Id mapId) throws OperationFailedException
mapId
- the Id
of the Map
Ids
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableMapIdsForRoute(Id mapId, Id routeId) throws OperationFailedException
mapId
- the Id
of the Map
routeId
- the Id
of the Route
Ids
NullArgumentException
- mapId
or
routeId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignRouteToMap(Id routeId, Id mapId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Route
to a Map.
routeId
- the Id
of the Route
mapId
- the Id
of the Map
AlreadyExistsException
- routeId
is
already assigned to mapId
NotFoundException
- routeId
or
mapId
not foundNullArgumentException
- routeId
or
mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRouteFromMap(Id routeId, Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Route
from a Map.
routeId
- the Id
of the Route
mapId
- the Id
of the Map
NotFoundException
- routeId
or
mapId
not found or routeId
not assigned
to mapId
NullArgumentException
- routeId
or
mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignCreditToMap(Id routeId, Id fromMapId, Id toMapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Route
from one Map
to another.
Mappings to other Maps
are unaffected.routeId
- the Id
of the Route
fromMapId
- the Id
of the current Map
toMapId
- the Id
of the destination Map
NotFoundException
- routeId fromMapId,
or toMapId
not found or routeId
not mapped to fromMapId
NullArgumentException
- routeId, fromMapId,
or toMapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.