OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
inventory package
Version 3.0.0
Release Candidate Preview
| Interface | osid.inventory.WarehouseReceiver | ||
|---|---|---|---|
| Implements | osid.OsidReceiver | ||
| Description |
The warehouse receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Warehouse objects. | ||
| Method | newWarehouses | ||
| Description |
The callback for notifications of new warehouses. | ||
| Parameters | osid.id.IdList | warehouseIds | the Ids of the new Warehouses |
| Compliance | mandatory | This method must be implemented. | |
| Method | newAncestorWarehouse | ||
| Description |
The callback for notifications of new warehouse ancestors. | ||
| Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.id.Id | ancestorId | the Id of the new Warehouse ancestor | |
| Compliance | mandatory | This method must be implemented. | |
| Method | newDescendantWarehouse | ||
| Description |
The callback for notifications of new warehouse descendants. | ||
| Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.id.Id | descendantId | the Id of the new Warehouse descendant | |
| Compliance | mandatory | This method must be implemented. | |
| Method | changedWarehouses | ||
| Description |
The callback for notification of updated warehouses. | ||
| Parameters | osid.id.IdList | warehouseIds | the Ids of the updated Warehouses |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedWarehouses | ||
| Description |
The callback for notification of deleted warehouses. | ||
| Parameters | osid.id.IdList | warehouseIds | the Ids of the deleted Warehouses |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedAncestorWarehouse | ||
| Description |
The callback for notifications of deleted warehouse ancestors. | ||
| Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.id.Id | ancestorId | the Id of the removed Warehouse ancestor | |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDescendantWarehouse | ||
| Description |
The callback for notifications of deleted warehouse descendants. | ||
| Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.id.Id | descendantId | the Id of the removed Warehouse descendant | |
| Compliance | mandatory | This method must be implemented. | |
| Method | restructuredWarehouseHierarchy | ||
| Description |
The callback for notifications of changes to a warehouse hierarchy where the hierarchy needs to refreshed. | ||
| Compliance | mandatory | This method must be implemented. | |