OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
recipe package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recipe.CookbookReceiver | ||
|---|---|---|---|
| Implements | osid.OsidReceiver | ||
| Description |
The cook book receiver is the consumer supplied interface
for receiving notifications pertaining to new, updated or
deleted | ||
| Method | newCookbooks | ||
| Description |
The callback for notifications of new cook books. | ||
| Parameters | osid.id.IdList | cookbookIds | the Ids of the new Cookbooks |
| Compliance | mandatory | This method must be implemented. | |
| Method | newAncestorCookbook | ||
| Description |
The callback for notifications of new ancestors of a cookbook. | ||
| Parameters | osid.id.Id | cookbookId | the Id of the registered Cookbook |
osid.id.Id | ancestorId | the Id of the new ancestor cookbook | |
| Compliance | mandatory | This method must be implemented. | |
| Method | newDescendantCookbook | ||
| Description |
The callback for notifications of new descendant of a cookbook. | ||
| Parameters | osid.id.Id | cookbookId | the Id of the registered Cookbook |
osid.id.Id | descendantId | the Id of the new descendant cookbook | |
| Compliance | mandatory | This method must be implemented. | |
| Method | changedCookbooks | ||
| Description |
The callback for notification of updated cook books. | ||
| Parameters | osid.id.IdList | cookbookIds | the Ids of the updated Cookbooks |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedCookbooks | ||
| Description |
the callback for notification of deleted cook books. | ||
| Parameters | osid.id.IdList | cookbookIds | the Ids of the registered Cookbooks |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedAncestorCookbook | ||
| Description |
The callback for notifications of deleted ancestors of a cookbook. | ||
| Parameters | osid.id.Id | cookbookId | the Id of the registered Cookbook |
osid.id.Id | ancestorId | the Id of the removed ancestor cookbook | |
| Compliance | mandatory | This method must be implemented. | |
| Method | deletedDescendantCookbook | ||
| Description |
The callback for notifications of deleted descendants of a cookbook. | ||
| Parameters | osid.id.Id | cookbookId | the Id of the registered Cookbook |
osid.id.Id | descendantId | the Id of the deleted descendant cookbook | |
| Compliance | mandatory | This method must be implemented. | |
| Method | restructuredCookbookHierarchy | ||
| Description |
The callback for notifications of changes to a cookbook hierarchy where the hierarchy needs to refreshed. | ||
| Compliance | mandatory | This method must be implemented. | |