Interface AgencyReceiver

All Superinterfaces:
OsidReceiver
public interface AgencyReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedAgencies(Id notificationId, IdList agencyIds)
    The callback for notification of updated agencies.
    void
    changedChildOfAgencies(Id notificationId, IdList agencyIds)
    The callback for notifications of changes to children of agency hierarchy nodes.
    void
    deletedAgencies(Id notificationId, IdList agencyIds)
    The callback for notification of deleted agencies.
    void
    newAgencies(Id notificationId, IdList agencyIds)
    The callback for notifications of new agencies.

    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

    • newAgencies

      void newAgencies(Id notificationId, IdList agencyIds)
      The callback for notifications of new agencies.
      Parameters:
      notificationId - the notification Id
      agencyIds - the Ids of the new Agencies
      Compliance:
      mandatory - This method must be implemented.

    • changedAgencies

      void changedAgencies(Id notificationId, IdList agencyIds)
      The callback for notification of updated agencies.
      Parameters:
      notificationId - the notification Id
      agencyIds - the Ids of the updated Agencies
      Compliance:
      mandatory - This method must be implemented.

    • deletedAgencies

      void deletedAgencies(Id notificationId, IdList agencyIds)
      The callback for notification of deleted agencies.
      Parameters:
      notificationId - the notification Id
      agencyIds - the Ids of the deleted Agencies
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfAgencies

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