OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
ordering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.ordering.StoreReceiver | ||
|---|---|---|---|
| Implements | osid.OsidReceiver | ||
| Description |
The store receiver is the consumer supplied interface for
receiving notifications pertaining to new, updated or deleted
| ||
| Method | newStores | ||
| Description |
The callback for notifications of new stores. | ||
| Parameters | osid.id.IdList | storeIds | the Ids of the new Stores |
| Compliance | mandatory | This method must be implemented. | |
| Method | newAncestorStore | ||
| Description |
The callback for notifications of new ancestors of a store. | ||
| Parameters | osid.id.Id | storeId | the Id of the registered Store |
osid.id.Id | ancestorId | the Id of the new ancestor store | |
| Compliance | mandatory | This method must be implemented. | |
| Method | newDescendantStore | ||
| Description |
The callback for notifications of new descendant of a store. | ||
| Parameters | osid.id.Id | storeId | the Id of the registered Store |
osid.id.Id | descendantId | the Id of the new descendant store | |
| Compliance | mandatory | This method must be implemented. | |
| Method | changedStores | ||
| Description |
The callback for notification of updated stores. | ||
| Parameters | osid.id.IdList | storeIds | the Ids of the updated Stores |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedStores | ||
| Description |
the callback for notification of deleted stores. | ||
| Parameters | osid.id.IdList | storeIds | the Ids of the registered Stores |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedAncestorStore | ||
| Description |
The callback for notifications of deleted ancestors of a store. | ||
| Parameters | osid.id.Id | storeId | the Id of the registered Store |
osid.id.Id | ancestorId | the Id of the removed ancestor store | |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDescendantStore | ||
| Description |
The callback for notifications of deleted descendants of a store. | ||
| Parameters | osid.id.Id | storeId | the Id of the registered Store |
osid.id.Id | descendantId | the Id of the deleted descendant store | |
| Compliance | mandatory | This method must be implemented. | |
| Method | restructuredStoreHierarchy | ||
| Description |
The callback for notifications of changes to a store hierarchy where the hierarchy needs to refreshed. | ||
| Compliance | mandatory | This method must be implemented. | |