public interface InventoryWarehouseSession extends OsidSession
This session provides methods to retrieve Inventory
to
Warehouse
mappings. An Inventory
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 |
canLookupInventoryWarehouseMappings()
Tests if this user can perform lookups of inventory/warehouse
mappings.
|
InventoryList |
getActivitieByWarehouse(Id warehouseId)
Gets the list of
Inventory associated with a
Warehouse. |
InventoryList |
getActivitieByWarehouses(IdList warehouseIds)
Gets the list of
Inventories corresponding to a list of
Warehouse objects. |
IdList |
getInventoryIdsByWarehouse(Id warehouseId)
Gets the list of
Inventory Ids associated with a
Warehouse. |
IdList |
getInventoryIdsByWarehouses(IdList warehouseIds)
Gets the list of
Inventory Ids corresponding to a list
of Warehouse objects. |
IdList |
getWarehouseIdsByInventory(Id inventoryId)
Gets the
Warehouse Ids mapped to an
Inventory. |
WarehouseList |
getWarehousesByInventory(Id inventoryId)
Gets the
Warehouse objects mapped to an
Inventory. |
void |
useComparativeInventoryWarehouseView()
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 |
usePlenaryInventoryWarehouseView()
A complete view of the
Inventory and Warehouse
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupInventoryWarehouseMappings()
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 useComparativeInventoryWarehouseView()
mandatory
- This method is must be implemented. void usePlenaryInventoryWarehouseView()
Inventory
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 getInventoryIdsByWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inventory 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. InventoryList getActivitieByWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inventory
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 getInventoryIdsByWarehouses(IdList warehouseIds) throws OperationFailedException, PermissionDeniedException
Inventory Ids
corresponding to a list
of Warehouse
objects.warehouseIds
- list of catalog Ids
Ids
NullArgumentException
- warehouseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InventoryList getActivitieByWarehouses(IdList warehouseIds) throws OperationFailedException, PermissionDeniedException
Inventories
corresponding to a list of
Warehouse
objects.warehouseIds
- list of catalog Ids
NullArgumentException
- warehouseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getWarehouseIdsByInventory(Id inventoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Warehouse
Ids
mapped to an
Inventory.
inventoryId
- Id
of an Inventory
NotFoundException
- inventoryId
is not
foundNullArgumentException
- inventoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WarehouseList getWarehousesByInventory(Id inventoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Warehouse
objects mapped to an
Inventory.
inventoryId
- Id
of an Inventory
NotFoundException
- inventoryId
is not
foundNullArgumentException
- inventoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.