| Interface | osid.inventory.batch.InventoryBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.inventory.batch.InventoryBatchProfile | |||
| Description |
The inventory batch manager provides access to inventory batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getItemBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inventory.batch.ItemBatchAdminSession | an ItemBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsItemBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsItemBatchAdmin()
is true. | |
| Method | getItemBatchAdminSessionForInventory | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inventoryId | the Id of the Inventory |
| Return | osid.inventory.batch.ItemBatchAdminSession | an ItemBatchAdminSession | |
| Errors | NOT_FOUND | no Inventory found by the given Id | |
| NULL_ARGUMENT | inventoryId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsItemBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getStockBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inventory.batch.StockBatchAdminSession | a StockBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsStockBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsStockBatchAdmin()
is true. | |
| Method | getStockBatchAdminSessionForInventory | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inventoryId | the Id of the Inventory |
| Return | osid.inventory.batch.StockBatchAdminSession | a StockBatchAdminSession | |
| Errors | NOT_FOUND | no Inventory found by the given Id | |
| NULL_ARGUMENT | inventoryId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsStockBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsStockBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getModelBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inventory.batch.ModelBatchAdminSession | an ModelBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsModelBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsModelBatchAdmin()
is true. | |
| Method | getModelBatchAdminSessionForInventory | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inventoryId | the Id of the Inventory |
| Return | osid.inventory.batch.ModelBatchAdminSession | an ModelBatchAdminSession | |
| Errors | NOT_FOUND | no Inventory found by the given Id | |
| NULL_ARGUMENT | inventoryId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsModelBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsModelBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getInventoryBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inventory.batch.InventoryBatchAdminSession | an InventoryBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInventoryBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsInventoryBatchAdmin()
is true. | |