public interface MapHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Map
objects. Each node in the hierarchy is a unique Map.
Modifier and Type | Method and Description |
---|---|
void |
addChildMap(Id mapId,
Id childId)
Adds a child to a map.
|
void |
addRootMap(Id mapId)
Adds a root map.
|
boolean |
canModifyMapHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getMapHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getMapHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildMap(Id mapId,
Id childId)
Removes a child from a map.
|
void |
removeChildMaps(Id mapId)
Removes all children from a map.
|
void |
removeRootMap(Id mapId)
Removes a root map.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getMapHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyMapHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootMap(Id mapId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
mapId
- the Id
of a mapAlreadyExistsException
- mapId
is
already in hierarchyNotFoundException
- mapId
not foundNullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
mapId
- the Id
of a mapNotFoundException
- mapId
is not a rootNullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildMap(Id mapId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
mapId
- the Id
of a mapchildId
- the Id
of the new childAlreadyExistsException
- mapId
is
already a parent of childId
NotFoundException
- mapId
or
childId
not foundNullArgumentException
- mapId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildMap(Id mapId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
mapId
- the Id
of a mapchildId
- the Id
of the new childNotFoundException
- mapId
is not parent
of childId
NullArgumentException
- mapId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildMaps(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
mapId
- the Id
of a mapNotFoundException
- mapId
is not foundNullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.