Interface DictionaryReceiver

All Superinterfaces:
OsidReceiver
public interface DictionaryReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfDictionaries(Id notificationId, IdList dictionaryIds)
    The callback for notifications of changes to children of dictionary hierarchy nodes.
    void
    changedDictionaries(Id notificationId, IdList dictionaryIds)
    The callback for notification of updated dictionaries.
    void
    deletedDictionaries(Id notificationId, IdList dictionaryIds)
    The callback for notification of deleted dictionaries.
    void
    newDictionaries(Id notificationId, IdList dictionaryIds)
    The callback for notifications of new dictionaries.

    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

    • newDictionaries

      void newDictionaries(Id notificationId, IdList dictionaryIds)
      The callback for notifications of new dictionaries.
      Parameters:
      notificationId - the notification Id
      dictionaryIds - the Ids of the new Dictionaries
      Compliance:
      mandatory - This method must be implemented.

    • changedDictionaries

      void changedDictionaries(Id notificationId, IdList dictionaryIds)
      The callback for notification of updated dictionaries.
      Parameters:
      notificationId - the notification Id
      dictionaryIds - the Ids of the updated Dictionaries
      Compliance:
      mandatory - This method must be implemented.

    • deletedDictionaries

      void deletedDictionaries(Id notificationId, IdList dictionaryIds)
      The callback for notification of deleted dictionaries.
      Parameters:
      notificationId - the notification Id
      dictionaryIds - the Ids of the deleted Dictionaries
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfDictionaries

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