Interface | osid.inventory.ItemWarehouseAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignItems | ||
Description |
Tests if this user can alter item/warehouse mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignItemToWarehouse | ||
Description |
Tests if this user can alter item/warehouse mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | warehouseId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableWarehouseIds | ||
Description |
Gets a list of warehouses including and under the given warehouse node in which any item can be assigned. | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
Return | osid.id.IdList | list of assignable warehouse Ids | |
Errors | NULL_ARGUMENT | warehouseId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableWarehouseIdsForItem | ||
Description |
Gets a list of warehouses including and under the given warehouse node in which a specific item can be assigned. | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.id.Id | itemId | the Id of the Item | |
Return | osid.id.IdList | list of assignable warehouse Ids | |
Errors | NULL_ARGUMENT | warehouseId or itemId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignItemToWarehouse | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | itemId | the Id of the Item |
osid.id.Id | warehouseId | the Id of the Warehouse | |
Errors | ALREADY_EXISTS | itemId is already assigned to warehouseId | |
NOT_FOUND | itemId or warehouseId not found | ||
NULL_ARGUMENT | itemId or warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignItemFromWarehouse | ||
Description |
Removes an | ||
Parameters | osid.id.Id | itemId | the Id of the Item |
osid.id.Id | warehouseId | the Id of the Warehouse | |
Errors | NOT_FOUND | itemId or warehouseId not found or
itemId not assigned warehouseId | |
NULL_ARGUMENT | itemId or warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |