Interface PeriodReceiver

All Superinterfaces:
OsidReceiver
public interface PeriodReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedPeriods(Id notificationId, IdList periodIds)
    The callback for notification of updated periods.
    void
    deletedPeriods(Id notificationId, IdList periodIds)
    The callback for notification of deleted periods.
    void
    newPeriods(Id notificationId, IdList periodIds)
    The callback for notifications of new periods.

    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

    • newPeriods

      void newPeriods(Id notificationId, IdList periodIds)
      The callback for notifications of new periods.
      Parameters:
      notificationId - the notification Id
      periodIds - the Id of the new Periods
      Compliance:
      mandatory - This method must be implemented.

    • changedPeriods

      void changedPeriods(Id notificationId, IdList periodIds)
      The callback for notification of updated periods.
      Parameters:
      notificationId - the notification Id
      periodIds - the Id of the updated Periods
      Compliance:
      mandatory - This method must be implemented.

    • deletedPeriods

      void deletedPeriods(Id notificationId, IdList periodIds)
      The callback for notification of deleted periods.
      Parameters:
      notificationId - the notification Id
      periodIds - the Id of the deleted Periods
      Compliance:
      mandatory - This method must be implemented.