OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
installation package
Version 3.0.0
Release Candidate Preview
| Interface | osid.installation.DepotReceiver | ||
|---|---|---|---|
| Implements | osid.OsidReceiver | ||
| Description |
The vault receiver is the consumer supplied interface for
receiving notifications pertaining to new, updated or deleted
| ||
| Method | newDepots | ||
| Description |
The callback for notifications of new depots. | ||
| Parameters | osid.id.IdList | depotIds | the Ids of the new Depots |
| Compliance | mandatory | This method must be implemented. | |
| Method | newAncestorDepot | ||
| Description |
The callback for notifications of new depot ancestors. | ||
| Parameters | osid.id.Id | depotId | the Id of the Depot |
osid.id.Id | ancestorId | hasRecordType(depotRecordType) is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | newDescendantDepot | ||
| Description |
The callback for notifications of new depot descendants. | ||
| Parameters | osid.id.Id | depotId | the Id of the Depot |
osid.id.Id | descendantId | the Id of the new Depot descendant | |
| Compliance | mandatory | This method must be implemented. | |
| Method | changedDepots | ||
| Description |
The callback for notification of updated depots. | ||
| Parameters | osid.id.IdList | depotIds | the Ids of the updated Depots |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDepots | ||
| Description |
The callback for notification of deleted depots. | ||
| Parameters | osid.id.IdList | depotIds | the Ids of the deleted Depots |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedAncestorDepot | ||
| Description |
The callback for notifications of deleted depot ancestors. | ||
| Parameters | osid.id.Id | depotId | the Id of the Depot |
osid.id.Id | ancestorId | the Id of the removed Depot ancestor | |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDescendantDepot | ||
| Description |
The callback for notifications of deleted depot descendants. | ||
| Parameters | osid.id.Id | depotId | the Id of the Depot |
osid.id.Id | descendantId | the Id of the removed Depot descendant | |
| Compliance | mandatory | This method must be implemented. | |
| Method | restructuredDepotHierarchy | ||
| Description |
The callback for notifications of changes to a depot hierarchy where the hierarchy needs to refreshed. | ||
| Compliance | mandatory | This method must be implemented. | |