OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
inventory package
Version 3.0.0
Release Candidate Preview
| Interface | osid.inventory.StockReceiver | ||
|---|---|---|---|
| Implements | osid.OsidReceiver | ||
| Description |
The stock receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted stock objects. | ||
| Method | newStocks | ||
| Description |
The callback for notifications of new stocks. | ||
| Parameters | osid.id.IdList | stockIds | the Ids of the new Stocks |
| Compliance | mandatory | This method must be implemented. | |
| Method | newAncestorStock | ||
| Description |
The callback for notifications of new stock ancestors. | ||
| Parameters | osid.id.Id | stockId | the Id of the Stock |
osid.id.Id | ancestorId | the Id of the new Stock ancestor | |
| Compliance | mandatory | This method must be implemented. | |
| Method | newDescendantStock | ||
| Description |
The callback for notifications of new stock descendants. | ||
| Parameters | osid.id.Id | stockId | the Id of the Stock |
osid.id.Id | descendantId | the Id of the new Stock descendant | |
| Compliance | mandatory | This method must be implemented. | |
| Method | changedStocks | ||
| Description |
The callback for notification of updated stocks. | ||
| Parameters | osid.id.IdList | stockIds | the Ids of the updated Stocks |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedStocks | ||
| Description |
The callback for notification of deleted stocks. | ||
| Parameters | osid.id.IdList | stockIds | the Ids of the deleted Stocks |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedAncestorStock | ||
| Description |
The callback for notifications of deleted stock ancestors. | ||
| Parameters | osid.id.Id | stockId | the Id of the Stock |
osid.id.Id | ancestorId | the Id of the removed Stock ancestor | |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDescendantStock | ||
| Description |
The callback for notifications of deleted stock descendants. | ||
| Parameters | osid.id.Id | stockId | the Id of the Stock |
osid.id.Id | descendantId | the Id of the removed Stock descendant | |
| Compliance | mandatory | This method must be implemented. | |
| Method | restructuredStockHierarchy | ||
| Description |
The callback for notifications of changes to a stock hierarchy where the hierarchy needs to refreshed. | ||
| Compliance | mandatory | This method must be implemented. | |