Interface EnrollmentReceiver

All Superinterfaces:
OsidReceiver
public interface EnrollmentReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedEnrollments(Id notificationId, IdList enrollmentIds)
    The callback for notification of updated enrollments.
    void
    deletedEnrollments(Id notificationId, IdList enrollmentIds)
    the callback for notification of deleted enrollments.
    void
    newEnrollments(Id notificationId, IdList enrollmentIds)
    The callback for notifications of new enrollments.

    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

    • newEnrollments

      void newEnrollments(Id notificationId, IdList enrollmentIds)
      The callback for notifications of new enrollments.
      Parameters:
      notificationId - the notification Id
      enrollmentIds - the Ids of the new Enrollments
      Compliance:
      mandatory - This method must be implemented.

    • changedEnrollments

      void changedEnrollments(Id notificationId, IdList enrollmentIds)
      The callback for notification of updated enrollments.
      Parameters:
      notificationId - the notification Id
      enrollmentIds - the Ids of the updated Enrollments
      Compliance:
      mandatory - This method must be implemented.

    • deletedEnrollments

      void deletedEnrollments(Id notificationId, IdList enrollmentIds)
      the callback for notification of deleted enrollments.
      Parameters:
      notificationId - the notification Id
      enrollmentIds - the Ids of the deleted Enrollments
      Compliance:
      mandatory - This method must be implemented.