Interface CyclicEventReceiver

All Superinterfaces:
OsidReceiver
public interface CyclicEventReceiver extends OsidReceiver

The cyclic event receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted CyclicEvents .

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedCyclicEvents(Id notificationId, IdList cyclicEventIds)
    The callback for notification of updated cyclic events.
    void
    deletedCyclicEvents(Id notificationId, IdList cyclicEventIds)
    The callback for notification of deleted cyclic events.
    void
    newCyclicEvents(Id notificationId, IdList cyclicEventIds)
    The callback for notifications of new cyclic events.

    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

    • newCyclicEvents

      void newCyclicEvents(Id notificationId, IdList cyclicEventIds)
      The callback for notifications of new cyclic events.
      Parameters:
      notificationId - the notification Id
      cyclicEventIds - the Id of the new CyclicEvents
      Compliance:
      mandatory - This method must be implemented.

    • changedCyclicEvents

      void changedCyclicEvents(Id notificationId, IdList cyclicEventIds)
      The callback for notification of updated cyclic events.
      Parameters:
      notificationId - the notification Id
      cyclicEventIds - the Id of the updated CyclicEvents
      Compliance:
      mandatory - This method must be implemented.

    • deletedCyclicEvents

      void deletedCyclicEvents(Id notificationId, IdList cyclicEventIds)
      The callback for notification of deleted cyclic events.
      Parameters:
      notificationId - the notification Id
      cyclicEventIds - the Id of the deleted CyclicEvents
      Compliance:
      mandatory - This method must be implemented.