Interface PathReceiver

All Superinterfaces:
OsidReceiver
public interface PathReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedPaths(IdList pathIds)
    The callback for notification of updated paths.
    void
    deletedPaths(IdList pathIds)
    The callback for notification of deleted paths.
    void
    newPaths(IdList pathIds)
    The callback for notifications of new paths.

    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

    • newPaths

      void newPaths(IdList pathIds)
      The callback for notifications of new paths.
      Parameters:
      pathIds - the Ids of the new Paths
      Compliance:
      mandatory - This method must be implemented.

    • changedPaths

      void changedPaths(IdList pathIds)
      The callback for notification of updated paths.
      Parameters:
      pathIds - the Ids of the updated Paths
      Compliance:
      mandatory - This method must be implemented.

    • deletedPaths

      void deletedPaths(IdList pathIds)
      The callback for notification of deleted paths.
      Parameters:
      pathIds - the Ids of the deleted Paths
      Compliance:
      mandatory - This method must be implemented.