Interface | osid.inventory.ItemWarehouseSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupItemWarehouseMappings | ||
Description |
Tests if this user can perform lookups of
item/warehouse mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeItemWarehouseView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryItemCatalogView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getItemIdsByWarehouse | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | warehouseId | Id of the Warehouse |
Return | osid.id.IdList | list of related item Ids | |
Errors | NOT_FOUND | warehouseId is not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByWarehouse | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | warehouseId | Id of the Warehouse |
Return | osid.inventory.ItemList | list of related items | |
Errors | NOT_FOUND | warehouseId is not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemIdsByWarehouses | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | warehouseIds | list of warehouse Ids |
Return | osid.id.IdList | list of item Ids | |
Errors | NULL_ARGUMENT | warehouseIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByWarehouses | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | warehouseIds | list of warehouse Ids |
Return | osid.inventory.ItemList | list of items | |
Errors | NULL_ARGUMENT | warehouseIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseIdsByItem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | itemId | Id of an Item |
Return | osid.id.IdList | list of warehouses | |
Errors | NOT_FOUND | itemId is not found | |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWarehousesByItem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | itemId | Id of an Item |
Return | osid.inventory.WarehouseList | list of warehouses | |
Errors | NOT_FOUND | itemId is not found | |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |