Interface BusinessHierarchyDesignSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session defines methods for managing a hierarchy of
Businesses . Each node in the hierarchy is a unique Business .
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddChildBusiness(Id businessId, Id childId) Adds a child to a business.voidaddRootBusiness(Id businessId) Adds a root customer ecatalog.booleanTests if this user can change the hierarchy.Gets the hierarchy associated with this session.Gets the hierarchyIdassociated with this session.voidremoveChildBusiness(Id businessId, Id childId) Removes a child from a business.voidremoveChildBusinesses(Id businessId) Removes all children from a business.voidremoveRootBusiness(Id businessId) Removes a root customer ecatalog.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
getBusinessHierarchyId
Id getBusinessHierarchyId()Gets the hierarchyIdassociated with this session.- Returns:
- the hierarchy
Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getBusinessHierarchy
Gets the hierarchy associated with this session.- Returns:
- the hierarchy associated with this session
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
canModifyBusinessHierarchy
boolean canModifyBusinessHierarchy()Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in aPERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.- Returns:
falseif changing this hierarchy is not authorized,trueotherwise- Compliance:
mandatory- This method must be implemented.
-
addRootBusiness
void addRootBusiness(Id businessId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a root customer ecatalog.- Parameters:
businessId- theIdof a business- Throws:
AlreadyExistsException-businessIdis already in hierarchyNotFoundException-businessIdnot foundNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeRootBusiness
void removeRootBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a root customer ecatalog.- Parameters:
businessId- theIdof a business- Throws:
NotFoundException-businessIdnot a rootNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
addChildBusiness
void addChildBusiness(Id businessId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a child to a business.- Parameters:
businessId- theIdof a businesschildId- theIdof the new child- Throws:
AlreadyExistsException-businessIdis already a parent ofchildIdNotFoundException-businessIdorchildIdnot foundNullArgumentException-businessIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildBusiness
void removeChildBusiness(Id businessId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a child from a business.- Parameters:
businessId- theIdof a businesschildId- theIdof the new child- Throws:
NotFoundException-businessIdis not a parent ofchildIdNullArgumentException-businessIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildBusinesses
void removeChildBusinesses(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes all children from a business.- Parameters:
businessId- theIdof a business- Throws:
NotFoundException-businessIdis in hierarchyNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-