public interface PathMapAssignmentSession extends OsidSession
This session provides methods to re-assign Paths
to
Map
objects. A Path
may appear in multiple
Map
objects and removing the last reference to a
Path
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 Path
to another Map
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignPathToMap(Id pathId,
Id mapId)
Adds an existing
Path to a Map. |
boolean |
canAssignPaths()
Tests if this user can alter path/map mappings.
|
boolean |
canAssignPathsToMap(Id mapId)
Tests if this user can alter path/map mappings.
|
IdList |
getAssignableMapIds(Id mapId)
Gets a list of maps including and under the given map node in which
any path can be assigned.
|
IdList |
getAssignableMapIdsForPath(Id mapId,
Id pathId)
Gets a list of maps including and under the given map node in which a
specific path can be assigned.
|
void |
unassignPathFromMap(Id pathId,
Id mapId)
Removes a
Path from a Map. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignPaths()
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 canAssignPathsToMap(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 getAssignableMapIdsForPath(Id mapId, Id pathId) throws OperationFailedException
mapId
- the Id
of the Map
pathId
- the Id
of the Path
Ids
NullArgumentException
- mapId
or
pathId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignPathToMap(Id pathId, Id mapId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Path
to a Map.
pathId
- the Id
of the Path
mapId
- the Id
of the Map
AlreadyExistsException
- pathId
is
already assigned to mapId
NotFoundException
- pathId
or
mapId
not foundNullArgumentException
- pathId
or
mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignPathFromMap(Id pathId, Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Path
from a Map.
pathId
- the Id
of the Path
mapId
- the Id
of the Map
NotFoundException
- pathId
or
mapId
not found or pathId
not assigned
to mapId
NullArgumentException
- pathId
or
mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.