Interface CookbookReceiver

All Superinterfaces:
OsidReceiver
public interface CookbookReceiver extends OsidReceiver

The cookbook receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Cookbook objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfCookbooks(Id notificationId, IdList cookbookIds)
    The callback for notifications of changes to children of cookbook hierarchy nodes.
    void
    changedCookbooks(Id notificationId, IdList cookbookIds)
    The callback for notification of updated cookbooks.
    void
    deletedCookbooks(Id notificationId, IdList cookbookIds)
    the callback for notification of deleted cookbooks.
    void
    newCookbooks(Id notificationId, IdList cookbookIds)
    The callback for notifications of new cookbooks.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    down()
    The callback for notifications that the notification bus is not operating.
    void
    up()
    The callback for notifications that the notification bus is operational.

  • Method Details

    • newCookbooks

      void newCookbooks(Id notificationId, IdList cookbookIds)
      The callback for notifications of new cookbooks.
      Parameters:
      notificationId - the notification Id
      cookbookIds - the Ids of the new Cookbooks
      Compliance:
      mandatory - This method must be implemented.

    • changedCookbooks

      void changedCookbooks(Id notificationId, IdList cookbookIds)
      The callback for notification of updated cookbooks.
      Parameters:
      notificationId - the notification Id
      cookbookIds - the Ids of the updated Cookbooks
      Compliance:
      mandatory - This method must be implemented.

    • deletedCookbooks

      void deletedCookbooks(Id notificationId, IdList cookbookIds)
      the callback for notification of deleted cookbooks.
      Parameters:
      notificationId - the notification Id
      cookbookIds - the Ids of the registered Cookbooks
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfCookbooks

      void changedChildOfCookbooks(Id notificationId, IdList cookbookIds)
      The callback for notifications of changes to children of cookbook hierarchy nodes.
      Parameters:
      notificationId - the notification Id
      cookbookIds - the Ids of the Cookbooks whose children have changed
      Compliance:
      mandatory - This method must be implemented.