Interface JournalReceiver

All Superinterfaces:
OsidReceiver

public interface JournalReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfJournals(Id notificationId, IdList journalIds)
    The callback for notifications of changes to children of journal hierarchy nodes.
    void
    changedJournals(Id notificationId, IdList journalIds)
    The callback for notification of updated journals.
    void
    deletedJournals(Id notificationId, IdList journalIds)
    the callback for notification of deleted journals.
    void
    newJournals(Id notificationId, IdList journalIds)
    The callback for notifications of new journals.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    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

    • newJournals

      void newJournals(Id notificationId, IdList journalIds)
      The callback for notifications of new journals.
      Parameters:
      notificationId - the notification Id
      journalIds - the Ids of the new Journals
      Compliance:
      mandatory - This method must be implemented.
    • changedJournals

      void changedJournals(Id notificationId, IdList journalIds)
      The callback for notification of updated journals.
      Parameters:
      notificationId - the notification Id
      journalIds - the Ids of the updated Journals
      Compliance:
      mandatory - This method must be implemented.
    • deletedJournals

      void deletedJournals(Id notificationId, IdList journalIds)
      the callback for notification of deleted journals.
      Parameters:
      notificationId - the notification Id
      journalIds - the Ids of the registered Journals
      Compliance:
      mandatory - This method must be implemented.
    • changedChildOfJournals

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