public interface DepotHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Depot
objects. Each node in the hierarchy is a unique Depot.
Modifier and Type | Method and Description |
---|---|
void |
addChildDepot(Id depotId,
Id childId)
Adds a child to a depot.
|
void |
addRootDepot(Id depotId)
Adds a root depot.
|
boolean |
canModifyDepotHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getDepotHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getDepotHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildDepot(Id depotId,
Id childId)
Removes a child from a depot.
|
void |
removeChildDepots(Id depotId)
Removes all children from a depot.
|
void |
removeRootDepot(Id depotId)
Removes a root depot.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDepotHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getDepotHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyDepotHierarchy()
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 addRootDepot(Id depotId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
depotId
- the Id
of a depotAlreadyExistsException
- depotId
is
already in hierarchyNotFoundException
- depotId
not foundNullArgumentException
- depotId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootDepot(Id depotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
depotId
- the Id
of a depotNotFoundException
- depotId
is not a
rootNullArgumentException
- depotId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildDepot(Id depotId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
depotId
- the Id
of a depotchildId
- the Id
of the new childAlreadyExistsException
- depotId
is
already a parent of childId
NotFoundException
- depotId
or
childId
not foundNullArgumentException
- depotId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildDepot(Id depotId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
depotId
- the Id
of a depotchildId
- the Id
of the new childNotFoundException
- depotId
not a parent
of childId
NullArgumentException
- depotId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildDepots(Id depotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
depotId
- the Id
of a depotNotFoundException
- depotId
not foundNullArgumentException
- depotId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.