| Interface | osid.inventory.batch.InventoryBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.inventory.InventoryAdminSession | ||
| Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
| Method | getInventoryFormsForCreate | ||
| Description |
Gets the inventory forms for creating a bunch of new inventories. | ||
| Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | inventoryRecordTypes | array of inventory record types to be included in each create operation or an empty list if none | |
| Return | osid.inventory.batch.InventoryBatchFormList | the inventory forms | |
| Errors | NULL_ARGUMENT | inventoryRecordTypes is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | unable to request forms with given record types | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | createInventories | ||
| Description |
Creates a new set of | ||
| Parameters | osid.inventory.batch.InventoryBatchFormList | inventoryForms | the inventory forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | inventoryForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getInventoryFormsForUpdate | ||
| Description |
Gets the inventory forms for updating an existing set of inventories. A new inventory form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | inventoryIds | the Ids of the Inventory |
| Return | osid.inventory.batch.InventoryBatchFormList | the inventory form | |
| Errors | NOT_FOUND | an inventoryId is not found | |
| NULL_ARGUMENT | inventoryIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateInventories | ||
| Description |
Updates existing inventories. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
| Parameters | osid.inventory.batch.InventoryBatchFormList | inventoryForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | inventoryForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllInventories | ||
| Description |
Deletes all | ||
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteInventories | ||
| Description |
Deletes inventories for the given | ||
| Parameters | osid.id.IdList | inventoryIds | the Ids of the inventories to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | inventoryIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasInventories | ||
| Description |
Adds an | ||
| Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
| Return | osid.transaction.batch.AliasResponseList | the alias responses | |
| Errors | NULL_ARGUMENT | aliasRequests is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |