Interface StockHierarchyDesignSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session defines methods for managing a hierarchy of Stocks
. Each node in the hierarchy is a unique Stock .
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddChildStock(Id stockId, Id childId) Adds a child to a stock.voidaddRootStock(Id stockId) Adds a root stock.booleanTests if this user can change the hierarchy.Gets the hierarchy associated with this session.Gets the hierarchyIdassociated with this session.voidremoveChildStock(Id stockId, Id childId) Removes a child from a stock.voidremoveChildStocks(Id stockId) Removes all children from a stock.voidremoveRootStock(Id stockId) Removes a stock.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
-
getStockHierarchyId
Id getStockHierarchyId()Gets the hierarchyIdassociated with this session.- Returns:
- the hierarchy
Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getStockHierarchy
Gets the hierarchy associated with this session.- Returns:
- the stock hierarchy
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
canModifyStockHierarchy
boolean canModifyStockHierarchy()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.
-
addRootStock
void addRootStock(Id stockId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a root stock.- Parameters:
stockId- theIdof a stock- Throws:
AlreadyExistsException-stockIdis already in hierarchyNotFoundException-stockIdnot foundNullArgumentException-stockIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeRootStock
void removeRootStock(Id stockId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a stock.- Parameters:
stockId- theIdof a stock- Throws:
NotFoundException-stockIdnot a rootNullArgumentException-stockIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
addChildStock
void addChildStock(Id stockId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a child to a stock.- Parameters:
stockId- theIdof a stockchildId- theIdof the new child- Throws:
AlreadyExistsException-stockIdis already a parent ofchildIdNotFoundException-stockIdorchildIdnot foundNullArgumentException-stockIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildStock
void removeChildStock(Id stockId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a child from a stock.- Parameters:
stockId- theIdof a stockchildId- theIdof the new child- Throws:
NotFoundException-stockIdis not a parent ofchildIdNullArgumentException-stockIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildStocks
void removeChildStocks(Id stockId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes all children from a stock.- Parameters:
stockId- theIdof a stock- Throws:
NotFoundException-stockIdis in hierarchyNullArgumentException-stockIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-