Interface HierarchyStructureReceiver

All Superinterfaces:
OsidReceiver

public interface HierarchyStructureReceiver extends OsidReceiver

The hierarchy receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted hierarchy nodes.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfNodes(Id notificationId, IdList nodeIds)
    The callback for notifications of changes to children of hierarchy nodes.
    void
    deletedNodes(Id notificationId, IdList nodeIds)
    the callback for notification of deleted hierarchy nodes.
    void
    newNodes(Id notificationId, Id nodeIds)
    The callback for notifications of new hierarchy nodes.

    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

    • newNodes

      void newNodes(Id notificationId, Id nodeIds)
      The callback for notifications of new hierarchy nodes.
      Parameters:
      notificationId - the notification Id
      nodeIds - the Ids of the new nodes
      Compliance:
      mandatory - This method must be implemented.
    • deletedNodes

      void deletedNodes(Id notificationId, IdList nodeIds)
      the callback for notification of deleted hierarchy nodes.
      Parameters:
      notificationId - the notification Id
      nodeIds - the Ids of the deleted nodes
      Compliance:
      mandatory - This method must be implemented.
    • changedChildOfNodes

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