Interface AddressBookReceiver

All Superinterfaces:
OsidReceiver
public interface AddressBookReceiver extends OsidReceiver

The address book receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted AddressBook objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedAddressBooks(Id notificationId, IdList addressBookIds)
    The callback for notification of updated address books.
    void
    changedChildOfAddressBooks(Id notificationId, IdList addressBookIds)
    The callback for notifications of changes to children of address books hierarchy nodes.
    void
    deletedAddressBooks(Id notificationId, IdList addressBookIds)
    the callback for notification of deleted address books.
    void
    newAddressBooks(Id notificationId, IdList addressBookIds)
    The callback for notifications of new address books.

    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

    • newAddressBooks

      void newAddressBooks(Id notificationId, IdList addressBookIds)
      The callback for notifications of new address books.
      Parameters:
      notificationId - the notification Id
      addressBookIds - the Ids of the new AddressBooks
      Compliance:
      mandatory - This method must be implemented.

    • changedAddressBooks

      void changedAddressBooks(Id notificationId, IdList addressBookIds)
      The callback for notification of updated address books.
      Parameters:
      notificationId - the notification Id
      addressBookIds - the Ids of the updated AddressBooks
      Compliance:
      mandatory - This method must be implemented.

    • deletedAddressBooks

      void deletedAddressBooks(Id notificationId, IdList addressBookIds)
      the callback for notification of deleted address books.
      Parameters:
      notificationId - the notification Id
      addressBookIds - the Ids of the registered AddressBooks
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfAddressBooks

      void changedChildOfAddressBooks(Id notificationId, IdList addressBookIds)
      The callback for notifications of changes to children of address books hierarchy nodes.
      Parameters:
      notificationId - the notification Id
      addressBookIds - the Ids of the AddressBooks whose children have changed
      Compliance:
      mandatory - This method must be implemented.