public interface ItemWarehouseSession extends OsidSession
This session provides methods to retrieve Item
to
Warehouse
mappings. An Item
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 |
canLookupItemWarehouseMappings()
Tests if this user can perform lookups of item/warehouse mappings.
|
IdList |
getItemIdsByWarehouse(Id warehouseId)
Gets the list of
Item Ids associated with a
Warehouse. |
IdList |
getItemIdsByWarehouses(IdList warehouseIds)
Gets the list of
Item Ids corresponding to a list of
Warehouse objects. |
ItemList |
getItemsByWarehouse(Id warehouseId)
Gets the list of
Items associated with a
Warehouse. |
ItemList |
getItemsByWarehouses(IdList warehouseIds)
Gets the list of
Items corresponding to a list of
Warehouse objects. |
IdList |
getWarehouseIdsByItem(Id itemId)
Gets the
Warehouse Ids mapped to an
Item. |
WarehouseList |
getWarehousesByItem(Id itemId)
Gets the
Warehouse objects mapped to an Item. |
void |
useComparativeItemWarehouseView()
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 |
usePlenaryItemCatalogView()
A complete view of the
Item and Warehouse
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupItemWarehouseMappings()
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 useComparativeItemWarehouseView()
mandatory
- This method is must be implemented. void usePlenaryItemCatalogView()
Item
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 getItemIdsByWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Item 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. ItemList getItemsByWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Items
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 getItemIdsByWarehouses(IdList warehouseIds) throws OperationFailedException, PermissionDeniedException
Item 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. ItemList getItemsByWarehouses(IdList warehouseIds) throws OperationFailedException, PermissionDeniedException
Items
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 getWarehouseIdsByItem(Id itemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Warehouse
Ids
mapped to an
Item.
itemId
- Id
of an Item
NotFoundException
- itemId
is not foundNullArgumentException
- itemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WarehouseList getWarehousesByItem(Id itemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Warehouse
objects mapped to an Item.
itemId
- Id
of an Item
NotFoundException
- itemId
is not foundNullArgumentException
- itemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.