Interface PlanReceiver

All Superinterfaces:
OsidReceiver
public interface PlanReceiver extends OsidReceiver

The plan receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted plans.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedPlans(Id notificationId, IdList planIds)
    The callback for notifications of updated plans.
    void
    deletedPlans(Id notificationId, IdList planIds)
    The callback for notification of deleted plans.
    void
    newPlans(Id notificationId, IdList planIds)
    The callback for notifications of new plans.

    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

    • newPlans

      void newPlans(Id notificationId, IdList planIds)
      The callback for notifications of new plans.
      Parameters:
      notificationId - the notification Id
      planIds - the Ids of the new plans
      Compliance:
      mandatory - This method must be implemented.

    • changedPlans

      void changedPlans(Id notificationId, IdList planIds)
      The callback for notifications of updated plans.
      Parameters:
      notificationId - the notification Id
      planIds - the Ids of the updated plans
      Compliance:
      mandatory - This method must be implemented.

    • deletedPlans

      void deletedPlans(Id notificationId, IdList planIds)
      The callback for notification of deleted plans.
      Parameters:
      notificationId - the notification Id
      planIds - the Ids of the deleted plans
      Compliance:
      mandatory - This method must be implemented.