Interface CatalogueReceiver

All Superinterfaces:
OsidReceiver

public interface CatalogueReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedCatalogues(Id notificationId, IdList catalogueIds)
    The callback for notification of updated catalogues.
    void
    changedChildOfCatalogues(Id notificationId, IdList catalogueIds)
    The callback for notifications of changes to children of catalogue hierarchy nodes.
    void
    deletedCatalogues(Id notificationId, IdList catalogueIds)
    the callback for notification of deleted catalogues.
    void
    newCatalogues(Id notificationId, IdList catalogueIds)
    The callback for notifications of new catalogues.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    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

    • newCatalogues

      void newCatalogues(Id notificationId, IdList catalogueIds)
      The callback for notifications of new catalogues.
      Parameters:
      notificationId - the notification Id
      catalogueIds - the Ids of the new Catalogues
      Compliance:
      mandatory - This method must be implemented.
    • changedCatalogues

      void changedCatalogues(Id notificationId, IdList catalogueIds)
      The callback for notification of updated catalogues.
      Parameters:
      notificationId - the notification Id
      catalogueIds - the Ids of the updated Catalogues
      Compliance:
      mandatory - This method must be implemented.
    • deletedCatalogues

      void deletedCatalogues(Id notificationId, IdList catalogueIds)
      the callback for notification of deleted catalogues.
      Parameters:
      notificationId - the notification Id
      catalogueIds - the Ids of the registered Catalogues
      Compliance:
      mandatory - This method must be implemented.
    • changedChildOfCatalogues

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