public interface DistributorHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Distributor
objects. Each node in the hierarchy is a unique
Distributor.
Modifier and Type | Method and Description |
---|---|
void |
addChildDistributor(Id distributorId,
Id childId)
Adds a child to a distributor.
|
void |
addRootDistributor(Id distributorId)
Adds a root distributor.
|
boolean |
canModifyDistributorHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getDistributorHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getDistributorHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildDistributor(Id distributorId,
Id childId)
Removes a child from a distributor.
|
void |
removeChildDistributors(Id distributorId)
Removes all children from a distributor.
|
void |
removeRootDistributor(Id distributorId)
Removes a root distributor.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getDistributorHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyDistributorHierarchy()
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 addRootDistributor(Id distributorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
distributorId
- the Id
of a distributorAlreadyExistsException
- distributorId
is already in hierarchyNotFoundException
- distributorId
not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
distributorId
- the Id
of a distributorNotFoundException
- distributorId
is not
a rootNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildDistributor(Id distributorId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
distributorId
- the Id
of a distributorchildId
- the Id
of the new childAlreadyExistsException
- distributorId
is already a parent of childId
NotFoundException
- distributorId
or
childId
not foundNullArgumentException
- distributorId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildDistributor(Id distributorId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
distributorId
- the Id
of a distributorchildId
- the Id
of the new childNotFoundException
- distributorId
is not
parent of childId
NullArgumentException
- distributorId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildDistributors(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
distributorId
- the Id
of a distributorNotFoundException
- distributorId
is not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.