Interface HoldReceiver

All Superinterfaces:
OsidReceiver
public interface HoldReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedHolds(Id notificationId, IdList holdIds)
    The callback for notification of updated holds.
    void
    deletedHolds(Id notificationId, IdList holdIds)
    The callback for notification of deleted holds.
    void
    newHolds(Id notificationId, IdList holdIds)
    The callback for notifications of new holds.

    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

    • newHolds

      void newHolds(Id notificationId, IdList holdIds)
      The callback for notifications of new holds.
      Parameters:
      notificationId - the notification Id
      holdIds - the Ids of the new Holds
      Compliance:
      mandatory - This method must be implemented.

    • changedHolds

      void changedHolds(Id notificationId, IdList holdIds)
      The callback for notification of updated holds.
      Parameters:
      notificationId - the notification Id
      holdIds - the Ids of the updated Holds
      Compliance:
      mandatory - This method must be implemented.

    • deletedHolds

      void deletedHolds(Id notificationId, IdList holdIds)
      The callback for notification of deleted holds.
      Parameters:
      notificationId - the notification Id
      holdIds - the Ids of the deleted Holds
      Compliance:
      mandatory - This method must be implemented.