public interface WarehouseHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Warehouse
objects. Each node in the hierarchy is a unique
Warehouse.
Modifier and Type | Method and Description |
---|---|
void |
addChildWarehouse(Id warehouseId,
Id childId)
Adds a child to a warehouse.
|
void |
addRootWarehouse(Id warehouseId)
Adds a root warehouse.
|
boolean |
canModifyWarehouseHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getWarehouseHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getWarehouseHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildWarehouse(Id warehouseId,
Id childId)
Removes a child from a warehouse.
|
void |
removeChildWarehouses(Id warehouseId)
Removes all children from a warehouse.
|
void |
removeRootWarehouse(Id warehouseId)
Removes a warehouse.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getWarehouseHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getWarehouseHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyWarehouseHierarchy()
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 addRootWarehouse(Id warehouseId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
warehouseId
- the Id
of a warehouseAlreadyExistsException
- warehouseId
is
already in hierarchyNotFoundException
- warehouseId
not
foundNullArgumentException
- warehouseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
warehouseId
- the Id
of a warehouseNotFoundException
- warehouseId
not a
rootNullArgumentException
- warehouseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildWarehouse(Id warehouseId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
warehouseId
- the Id
of a warehousechildId
- the Id
of the new childAlreadyExistsException
- warehouseId
is
already a parent of childId
NotFoundException
- warehouseId
or
childId
not foundNullArgumentException
- warehouseId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildWarehouse(Id warehouseId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
warehouseId
- the Id
of a warehousechildId
- the Id
of the new childNotFoundException
- warehouseId
is not a
parent of childId
NullArgumentException
- warehouseId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildWarehouses(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
warehouseId
- the Id
of a warehouseNotFoundException
- warehouseId
is in
hierarchyNullArgumentException
- warehouseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.