Interface ResponseReceiver

All Superinterfaces:
OsidReceiver
public interface ResponseReceiver extends OsidReceiver

The response receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted responses.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedResponses(Id notificationId, IdList responseIds)
    The callback for notification of updated responses.
    void
    deletedResponses(Id notificationId, IdList responseIds)
    The callback for notification of deleted responses.
    void
    newResponses(Id notificationId, IdList responseIds)
    The callback for notifications of new responses.

    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

    • newResponses

      void newResponses(Id notificationId, IdList responseIds)
      The callback for notifications of new responses.
      Parameters:
      notificationId - the notification Id
      responseIds - the Ids of the new Responses
      Compliance:
      mandatory - This method must be implemented.

    • changedResponses

      void changedResponses(Id notificationId, IdList responseIds)
      The callback for notification of updated responses.
      Parameters:
      notificationId - the notification Id
      responseIds - the Ids of the updated Responses
      Compliance:
      mandatory - This method must be implemented.

    • deletedResponses

      void deletedResponses(Id notificationId, IdList responseIds)
      The callback for notification of deleted responses.
      Parameters:
      notificationId - the notification Id
      responseIds - the Ids of the deleted Responses
      Compliance:
      mandatory - This method must be implemented.