public interface BusinessHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Business
objects. Each node in the hierarchy is a unique
Business.
Modifier and Type | Method and Description |
---|---|
void |
addChildBusiness(Id businessId,
Id childId)
Adds a child to a business.
|
void |
addRootBusiness(Id businessId)
Adds a root business ecatalog.
|
boolean |
canModifyBusinessHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getBusinessHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getBusinessHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildBusiness(Id businessId,
Id childId)
Removes a child from a business.
|
void |
removeChildBusinesses(Id businessId)
Removes all children from a business.
|
void |
removeRootBusiness(Id businessId)
Removes a root business ecatalog.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getBusinessHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyBusinessHierarchy()
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 addRootBusiness(Id businessId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
businessId
- the Id
of a businessAlreadyExistsException
- businessId
is
already in hierarchyNotFoundException
- businessId
not foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
businessId
- the Id
of a businessNotFoundException
- businessId
not a
rootNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildBusiness(Id businessId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
businessId
- the Id
of a businesschildId
- the Id
of the new childAlreadyExistsException
- businessId
is
already a parent of childId
NotFoundException
- businessId
or
childId
not foundNullArgumentException
- businessId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildBusiness(Id businessId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
businessId
- the Id
of a businesschildId
- the Id
of the new childNotFoundException
- businessId
is not a
parent of childId
NullArgumentException
- businessId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildBusinesses(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
businessId
- the Id
of a businessNotFoundException
- businessId
is in
hierarchyNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.