Interface JournalEntryReceiver

All Superinterfaces:
OsidReceiver
public interface JournalEntryReceiver extends OsidReceiver

The journal entry receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted journal entries.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedJournalEntries(Id notificationId, IdList journalEntryIds)
    The callback for notifications of updated journal entries.
    void
    deletedJournalEntries(Id notificationId, IdList journalEntryIds)
    the callback for notification of deleted journal entries.
    void
    newJournalEntries(Id notificationId, IdList journalEntryIds)
    The callback for notifications of new journal entries.

    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

    • newJournalEntries

      void newJournalEntries(Id notificationId, IdList journalEntryIds)
      The callback for notifications of new journal entries.
      Parameters:
      notificationId - the notification Id
      journalEntryIds - the Ids of the new journal entries
      Compliance:
      mandatory - This method must be implemented.

    • changedJournalEntries

      void changedJournalEntries(Id notificationId, IdList journalEntryIds)
      The callback for notifications of updated journal entries.
      Parameters:
      notificationId - the notification Id
      journalEntryIds - the Ids of the updated journal entries
      Compliance:
      mandatory - This method must be implemented.

    • deletedJournalEntries

      void deletedJournalEntries(Id notificationId, IdList journalEntryIds)
      the callback for notification of deleted journal entries.
      Parameters:
      notificationId - the notification Id
      journalEntryIds - the Ids of the deleted journal entries
      Compliance:
      mandatory - This method must be implemented.