Interface MapReceiver

All Superinterfaces:
OsidReceiver
public interface MapReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfMaps(Id notificationId, IdList mapIds)
    The callback for notifications of changes to children of map hierarchy nodes.
    void
    changedMaps(Id notificationId, IdList mapIds)
    The callback for notification of updated map.
    void
    deletedMaps(Id notificationId, IdList mapIds)
    The callback for notification of deleted maps.
    void
    newMaps(Id notificationId, IdList mapIds)
    The callback for notifications of new maps.

    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

    • newMaps

      void newMaps(Id notificationId, IdList mapIds)
      The callback for notifications of new maps.
      Parameters:
      notificationId - the notification Id
      mapIds - the Ids of the new Maps
      Compliance:
      mandatory - This method must be implemented.

    • changedMaps

      void changedMaps(Id notificationId, IdList mapIds)
      The callback for notification of updated map.
      Parameters:
      notificationId - the notification Id
      mapIds - the Ids of the updated Maps
      Compliance:
      mandatory - This method must be implemented.

    • deletedMaps

      void deletedMaps(Id notificationId, IdList mapIds)
      The callback for notification of deleted maps.
      Parameters:
      notificationId - the notification Id
      mapIds - the Ids of the deleted Maps
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfMaps

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