Interface | osid.inventory.InventoryAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getWarehouseId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Warehouse Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouse | ||
Description |
Gets the | ||
Return | osid.inventory.Warehouse | the warehouse | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateInventories | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Inventory creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateInventoryWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | inventoryRecordTypes | array of inventory record types |
Return | boolean | true if Inventory creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | inventoryRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getInventoryFormForCreate | ||
Description |
Gets the inventory form for creating new inventories. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | stockId | a stock Id |
osid.type.Type[] | inventoryRecordTypes | array of inventory record types | |
Return | osid.inventory.InventoryForm | the inventory form | |
Errors | NOT_FOUND | stockId is not found | |
NULL_ARGUMENT | stockId or inventoryRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createInventory | ||
Description |
Creates a new | ||
Parameters | osid.inventory.InventoryForm | inventoryForm | the form for this Inventory |
Return | osid.inventory.Inventory | the new Inventory | |
Errors | ILLEGAL_STATE | inventoryForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | inventoryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | inventoryForm did not originate from
getInventoryFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateInventories | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Inventory modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInventoryFormForUpdate | ||
Description |
Gets the inventory form for updating an existing inventory. A new inventory form should be requested for each update transaction. | ||
Parameters | osid.id.Id | inventoryId | the Id of the Inventory |
Return | osid.inventory.InventoryForm | the inventory form | |
Errors | NOT_FOUND | inventoryId is not found | |
NULL_ARGUMENT | inventoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateInventory | ||
Description |
Updates an existing inventory. | ||
Parameters | osid.inventory.InventoryForm | inventoryForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | inventoryForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | inventoryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | inventoryForm did not originate from
getInventoryFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteInventories | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Inventory deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteInventory | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | inventoryId | the Id of the Inventory |
Return | boolean | false if deletion of this Inventory is not
authorized, true otherwise | |
Errors | NULL_ARGUMENT | inventoryId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteInventory | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | inventoryId | the Id of the Inventory to remove |
Errors | NOT_FOUND | inventoryId not found | |
NULL_ARGUMENT | inventoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageInventoryAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Inventory aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasInventory | ||
Description |
Adds an | ||
Parameters | osid.id.Id | inventoryId | the Id of an Inventory |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | inventoryId not found | ||
NULL_ARGUMENT | inventoryId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |