Interface AccountReceiver

All Superinterfaces:
OsidReceiver
public interface AccountReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedAccounts(Id notificationId, IdList accountIds)
    The callback for notification of updated accounts.
    void
    changedChildOfAccounts(Id notificationId, IdList accountIds)
    The callback for notifications of changes to children of account hierarchy nodes.
    void
    deletedAccounts(Id notificationId, IdList accountIds)
    the callback for notification of deleted accounts.
    void
    newAccounts(Id notificationId, IdList accountIds)
    The callback for notifications of new accounts.

    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

    • newAccounts

      void newAccounts(Id notificationId, IdList accountIds)
      The callback for notifications of new accounts.
      Parameters:
      notificationId - the notification Id
      accountIds - the Ids of the new Accounts
      Compliance:
      mandatory - This method must be implemented.

    • changedAccounts

      void changedAccounts(Id notificationId, IdList accountIds)
      The callback for notification of updated accounts.
      Parameters:
      notificationId - the notification Id
      accountIds - the Ids of the updated Accounts
      Compliance:
      mandatory - This method must be implemented.

    • deletedAccounts

      void deletedAccounts(Id notificationId, IdList accountIds)
      the callback for notification of deleted accounts.
      Parameters:
      notificationId - the notification Id
      accountIds - the Ids of the deleted Accounts
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfAccounts

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