Interface CatalogReceiver

All Superinterfaces:
OsidReceiver
public interface CatalogReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedCatalogs(Id notificationId, IdList catalogIds)
    The callback for notification of updated catalogs.
    void
    changedChildOfCatalogs(Id notificationId, IdList catalogIds)
    The callback for notifications of changes to children of catalog hierarchy nodes.
    void
    deletedCatalogs(Id notificationId, IdList catalogIds)
    the callback for notification of deleted catalogs.
    void
    newCatalogs(Id notificationId, IdList catalogIds)
    The callback for notifications of new catalogs.

    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

    • newCatalogs

      void newCatalogs(Id notificationId, IdList catalogIds)
      The callback for notifications of new catalogs.
      Parameters:
      notificationId - the notification Id
      catalogIds - the Ids of the new Catalogs
      Compliance:
      mandatory - This method must be implemented.

    • changedCatalogs

      void changedCatalogs(Id notificationId, IdList catalogIds)
      The callback for notification of updated catalogs.
      Parameters:
      notificationId - the notification Id
      catalogIds - the Ids of the updated Catalogs
      Compliance:
      mandatory - This method must be implemented.

    • deletedCatalogs

      void deletedCatalogs(Id notificationId, IdList catalogIds)
      the callback for notification of deleted catalogs.
      Parameters:
      notificationId - the notification Id
      catalogIds - the Ids of the deleted Catalogs
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfCatalogs

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