Interface FamilyReceiver

All Superinterfaces:
OsidReceiver
public interface FamilyReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfFamilies(Id notificationId, IdList familyIds)
    The callback for notifications of changes to children of family hierarchy nodes.
    void
    changedFamilies(Id notificationId, IdList familyIds)
    The callback for notification of updated families.
    void
    deletedFamilies(Id notificationId, IdList familyIds)
    the callback for notification of deleted familys.
    void
    newFamilies(Id notificationId, IdList familyIds)
    The callback for notifications of new families.

    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

    • newFamilies

      void newFamilies(Id notificationId, IdList familyIds)
      The callback for notifications of new families.
      Parameters:
      notificationId - the notification Id
      familyIds - the Ids of the new Families
      Compliance:
      mandatory - This method must be implemented.

    • changedFamilies

      void changedFamilies(Id notificationId, IdList familyIds)
      The callback for notification of updated families.
      Parameters:
      notificationId - the notification Id
      familyIds - the Ids of the updated Families
      Compliance:
      mandatory - This method must be implemented.

    • deletedFamilies

      void deletedFamilies(Id notificationId, IdList familyIds)
      the callback for notification of deleted familys.
      Parameters:
      notificationId - the notification Id
      familyIds - the Ids of the registered Families
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfFamilies

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