Interface DispatchReceiver

All Superinterfaces:
OsidReceiver
public interface DispatchReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedDispatches(Id notificationId, IdList dispatchIds)
    The callback for notification of updated dispatches.
    void
    deletedDispatches(Id notificationId, IdList dispatchIds)
    the callback for notification of deleted dispatches.
    void
    newDispatches(Id notificationId, IdList dispatchIds)
    The callback for notifications of new dispatches.

    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

    • newDispatches

      void newDispatches(Id notificationId, IdList dispatchIds)
      The callback for notifications of new dispatches.
      Parameters:
      notificationId - the notification Id
      dispatchIds - the Ids of the new Dispatches
      Compliance:
      mandatory - This method must be implemented.

    • changedDispatches

      void changedDispatches(Id notificationId, IdList dispatchIds)
      The callback for notification of updated dispatches.
      Parameters:
      notificationId - the notification Id
      dispatchIds - the Ids of the new Dispatches
      Compliance:
      mandatory - This method must be implemented.

    • deletedDispatches

      void deletedDispatches(Id notificationId, IdList dispatchIds)
      the callback for notification of deleted dispatches.
      Parameters:
      notificationId - the notification Id
      dispatchIds - the Ids of the new Dispatches
      Compliance:
      mandatory - This method must be implemented.