Interface AwardReceiver

All Superinterfaces:
OsidReceiver
public interface AwardReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedAwards(Id notificationId, IdList awardIds)
    The callback for notification of updated awards.
    void
    deletedAwards(Id notificationId, IdList awardIds)
    the callback for notification of deleted awards.
    void
    newAwards(Id notificationId, IdList awardIds)
    The callback for notifications of new awards.

    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

    • newAwards

      void newAwards(Id notificationId, IdList awardIds)
      The callback for notifications of new awards.
      Parameters:
      notificationId - the notification Id
      awardIds - the Ids of the new Awards
      Compliance:
      mandatory - This method must be implemented.

    • changedAwards

      void changedAwards(Id notificationId, IdList awardIds)
      The callback for notification of updated awards.
      Parameters:
      notificationId - the notification Id
      awardIds - the Ids of the updated Awards
      Compliance:
      mandatory - This method must be implemented.

    • deletedAwards

      void deletedAwards(Id notificationId, IdList awardIds)
      the callback for notification of deleted awards.
      Parameters:
      notificationId - the notification Id
      awardIds - the Ids of the registered Awards
      Compliance:
      mandatory - This method must be implemented.