Interface AcademyReceiver

All Superinterfaces:
OsidReceiver
public interface AcademyReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedAcademies(Id notificationId, IdList academyIds)
    The callback for notification of updated academies.
    void
    changedChildOfAcademies(Id notificationId, IdList academyIds)
    The callback for notifications of changes to children of academy hierarchy nodes.
    void
    deletedAcademies(Id notificationId, IdList academyIds)
    the callback for notification of deleted academies.
    void
    newAcademies(Id notificationId, IdList academyIds)
    The callback for notifications of new academies.

    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

    • newAcademies

      void newAcademies(Id notificationId, IdList academyIds)
      The callback for notifications of new academies.
      Parameters:
      notificationId - the notification Id
      academyIds - the Ids of the new Academies
      Compliance:
      mandatory - This method must be implemented.

    • changedAcademies

      void changedAcademies(Id notificationId, IdList academyIds)
      The callback for notification of updated academies.
      Parameters:
      notificationId - the notification Id
      academyIds - the Ids of the updated Academies
      Compliance:
      mandatory - This method must be implemented.

    • deletedAcademies

      void deletedAcademies(Id notificationId, IdList academyIds)
      the callback for notification of deleted academies.
      Parameters:
      notificationId - the notification Id
      academyIds - the Ids of the registered Academies
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfAcademies

      void changedChildOfAcademies(Id notificationId, IdList academyIds)
      The callback for notifications of changes to children of academy hierarchy nodes.
      Parameters:
      notificationId - the notification Id
      academyIds - the Ids of the Academies whose children have changed
      Compliance:
      mandatory - This method must be implemented.