OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
offering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.offering.CatalogueReceiver | ||
|---|---|---|---|
| Implements | osid.OsidReceiver | ||
| Description |
The catalogue receiver is the consumer supplied interface
for receiving notifications pertaining to new, updated or
deleted | ||
| Method | newCatalogues | ||
| Description |
The callback for notifications of new catalogues. | ||
| Parameters | osid.id.IdList | catalogueIds | the Ids of the new Catalogues |
| Compliance | mandatory | This method must be implemented. | |
| Method | newAncestorCatalogue | ||
| Description |
The callback for notifications of new ancestors of a catalogue. | ||
| Parameters | osid.id.Id | catalogueId | the Id of the registered Catalogue |
osid.id.Id | ancestorId | the Id of the new ancestor catalogue | |
| Compliance | mandatory | This method must be implemented. | |
| Method | newDescendantCatalogue | ||
| Description |
The callback for notifications of new descendant of a catalogue. | ||
| Parameters | osid.id.Id | catalogueId | the Id of the registered Catalogue |
osid.id.Id | descendantId | the Id of the new descendant catalogue | |
| Compliance | mandatory | This method must be implemented. | |
| Method | changedCatalogues | ||
| Description |
The callback for notification of updated catalogues. | ||
| Parameters | osid.id.IdList | catalogueIds | the Ids of the updated Catalogues |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedCatalogues | ||
| Description |
the callback for notification of deleted catalogues. | ||
| Parameters | osid.id.IdList | catalogueIds | the Ids of the registered Catalogues |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedAncestorCatalogue | ||
| Description |
The callback for notifications of deleted ancestors of a catalogue. | ||
| Parameters | osid.id.Id | catalogueId | the Id of the registered Catalogue |
osid.id.Id | ancestorId | the Id of the removed ancestor catalogue | |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDescendantCatalogue | ||
| Description |
The callback for notifications of deleted descendants of a catalogue. | ||
| Parameters | osid.id.Id | catalogueId | the Id of the registered Catalogue |
osid.id.Id | descendantId | the Id of the deleted descendant catalogue | |
| Compliance | mandatory | This method must be implemented. | |
| Method | restructuredCatalogueHierarchy | ||
| Description |
The callback for notifications of changes to a catalogue hierarchy where the hierarchy needs to refreshed. | ||
| Compliance | mandatory | This method must be implemented. | |