public interface BankHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Bank
objects. Each node in the hierarchy is a unique Bank.
Modifier and Type | Method and Description |
---|---|
void |
addChildBank(Id bankId,
Id childId)
Adds a child to a bank.
|
void |
addRootBank(Id bankId)
Adds a root bank.
|
boolean |
canModifyBankHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getBankHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getBankHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildBank(Id bankId,
Id childId)
Removes a child from a bank.
|
void |
removeChildBanks(Id bankId)
Removes all children from a bank.
|
void |
removeRootBank(Id bankId)
Removes a root bank from this hierarchy.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBankHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getBankHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- assessment failuremandatory
- This method must be implemented. boolean canModifyBankHierarchy()
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 addRootBank(Id bankId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
bankId
- the Id
of a bankAlreadyExistsException
- bankId
is
already in hierarchyNotFoundException
- bankId
not foundNullArgumentException
- bankId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void removeRootBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
bankId
- the Id
of a bankNotFoundException
- bankId
not a parent
of childId
NullArgumentException
- bankId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildBank(Id bankId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
bankId
- the Id
of a bankchildId
- the Id
of the new childAlreadyExistsException
- bankId
is
already a parent of childId
NotFoundException
- bankId
or
childId
not foundNullArgumentException
- bankId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void removeChildBank(Id bankId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
bankId
- the Id
of a bankchildId
- the Id
of the new childNotFoundException
- bankId
not parent of
childId
NullArgumentException
- bankId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void removeChildBanks(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
bankId
- the Id
of a bankNotFoundException
- bankId
is not in
hierarchyNullArgumentException
- bankId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.