public interface StockWarehouseSession extends OsidSession
This session provides methods to retrieve Stock
to
Warehouse
mappings. A Stock
may appear in
multiple Warehouse
objects. Each catalog may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupStockWarehouseMappings()
Tests if this user can perform lookups of stock/warehouse mappings.
|
IdList |
getStockIdsByWarehouse(Id warehouseId)
Gets the list of
Stock Ids associated with a
Warehouse. |
IdList |
getStockIdsByWarehouses(IdList warehouseIds)
Gets the list of
Stock Ids corresponding to a list of
Warehouse objects. |
StockList |
getStocksByWarehouse(Id warehouseId)
Gets the list of
Stocks associated with a
Warehouse. |
StockList |
getStocksByWarehouses(IdList warehouseIds)
Gets the list of
Stocks corresponding to a list of
Warehouse objects. |
IdList |
getWarehouseIdsByStock(Id stockId)
Gets the
Warehouse Ids mapped to a
Stock. |
WarehouseList |
getWarehousesByStock(Id stockId)
Gets the
Warehouse objects mapped to a Stock. |
void |
useComparativeStockWarehouseView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryStockWarehouseView()
A complete view of the
Stock and Warehouse
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupStockWarehouseMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeStockWarehouseView()
mandatory
- This method is must be implemented. void usePlenaryStockWarehouseView()
Stock
and Warehouse
returns is desired. Methods will return what is requested or
result in an error. This view is used when greater precision is
desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getStockIdsByWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Stock Ids
associated with a
Warehouse.
warehouseId
- Id
of the Warehouse
Ids
NotFoundException
- warehouseId
is not
foundNullArgumentException
- warehouseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StockList getStocksByWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Stocks
associated with a
Warehouse.
warehouseId
- Id
of the Warehouse
NotFoundException
- warehouseId
is not
foundNullArgumentException
- warehouseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getStockIdsByWarehouses(IdList warehouseIds) throws OperationFailedException, PermissionDeniedException
Stock Ids
corresponding to a list of
Warehouse
objects.warehouseIds
- list of warehouse Ids
Ids
NullArgumentException
- warehouseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StockList getStocksByWarehouses(IdList warehouseIds) throws OperationFailedException, PermissionDeniedException
Stocks
corresponding to a list of
Warehouse
objects.warehouseIds
- list of warehouse Ids
NullArgumentException
- warehouseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getWarehouseIdsByStock(Id stockId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Warehouse
Ids
mapped to a
Stock.
stockId
- Id
of a Stock
NotFoundException
- stockId
is not foundNullArgumentException
- stockId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WarehouseList getWarehousesByStock(Id stockId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Warehouse
objects mapped to a Stock.
stockId
- Id
of a Stock
NotFoundException
- stockId
is not foundNullArgumentException
- stockId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.