OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
resource package
Version 3.0.0
Release Candidate Preview
| Interface | osid.resource.BinReceiver | ||
|---|---|---|---|
| Implements | osid.OsidReceiver | ||
| Description |
The bin receiver is the consumer supplied interface for
receiving notifications pertaining to new, updated or deleted
| ||
| Method | newBins | ||
| Description |
The callback for notifications of new bins. | ||
| Parameters | osid.id.IdList | binIds | the Ids of the new Bins |
| Compliance | mandatory | This method must be implemented. | |
| Method | newAncestorBin | ||
| Description |
The callback for notifications of new bin ancestors. | ||
| Parameters | osid.id.Id | binId | the Id of the Bin |
osid.id.Id | ancestorId | the Id of the new Bin ancestor | |
| Compliance | mandatory | This method must be implemented. | |
| Method | newDescendantBin | ||
| Description |
The callback for notifications of new bin descendants. | ||
| Parameters | osid.id.Id | binId | the Id of the Bin |
osid.id.Id | descendantId | the Id of the new Bin descendant | |
| Compliance | mandatory | This method must be implemented. | |
| Method | changedBins | ||
| Description |
The callback for notification of updated bins. | ||
| Parameters | osid.id.IdList | binIds | the Ids of the updated Bins |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedBins | ||
| Description |
The callback for notification of deleted bins. | ||
| Parameters | osid.id.IdList | binIds | the Ids of the deleted Bins |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedAncestorBin | ||
| Description |
The callback for notifications of deleted bin ancestors. | ||
| Parameters | osid.id.Id | binId | the Id of the Bin |
osid.id.Id | ancestorId | the Id of the removed Bin ancestor | |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDescendantBin | ||
| Description |
The callback for notifications of deleted bin descendants. | ||
| Parameters | osid.id.Id | binId | the Id of the Bin |
osid.id.Id | descendantId | the Id of the removed Bin descendant | |
| Compliance | mandatory | This method must be implemented. | |
| Method | restructuredBinHierarchy | ||
| Description |
The callback for notifications of changes to a bin hierarchy where the hierarchy needs to refreshed. | ||
| Compliance | mandatory | This method must be implemented. | |