Interface BinReceiver

All Superinterfaces:
OsidReceiver
public interface BinReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedBins(Id notificationId, IdList binIds)
    The callback for notification of updated bins.
    void
    changedChildOfBins(Id notificationId, IdList binIds)
    The callback for notifications of changes to children of bin hierarchy nodes.
    void
    deletedBins(Id notificationId, IdList binIds)
    The callback for notification of deleted bins.
    void
    newBins(Id notificationId, IdList binIds)
    The callback for notifications of new bins.

    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

    • newBins

      void newBins(Id notificationId, IdList binIds)
      The callback for notifications of new bins.
      Parameters:
      notificationId - the notification Id
      binIds - the Ids of the new Bins
      Compliance:
      mandatory - This method must be implemented.

    • changedBins

      void changedBins(Id notificationId, IdList binIds)
      The callback for notification of updated bins.
      Parameters:
      notificationId - the notification Id
      binIds - the Ids of the updated Bins
      Compliance:
      mandatory - This method must be implemented.

    • deletedBins

      void deletedBins(Id notificationId, IdList binIds)
      The callback for notification of deleted bins.
      Parameters:
      notificationId - the notification Id
      binIds - the Ids of the deleted Bins
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfBins

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