Interface LocationReceiver

All Superinterfaces:
OsidReceiver
public interface LocationReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfLocations(Id notificationId, IdList locationIds)
    The callback for notifications of changes to children of location hierarchy nodes.
    void
    changedLocations(Id notificationId, IdList locationIds)
    The callback for notification of updated locations.
    void
    deletedLocations(Id notificationId, IdList locationIds)
    The callback for notification of deleted locations.
    void
    newLocations(Id notificationId, IdList locationIds)
    The callback for notifications of new locations.

    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

    • newLocations

      void newLocations(Id notificationId, IdList locationIds)
      The callback for notifications of new locations.
      Parameters:
      notificationId - the notification Id
      locationIds - the Ids of the new Locations
      Compliance:
      mandatory - This method must be implemented.

    • changedLocations

      void changedLocations(Id notificationId, IdList locationIds)
      The callback for notification of updated locations.
      Parameters:
      notificationId - the notification Id
      locationIds - the Ids of the updated Locations
      Compliance:
      mandatory - This method must be implemented.

    • deletedLocations

      void deletedLocations(Id notificationId, IdList locationIds)
      The callback for notification of deleted locations.
      Parameters:
      notificationId - the notification Id
      locationIds - the Ids of the deleted Locations
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfLocations

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