Interface ResourcePathReceiver

All Superinterfaces:
OsidReceiver
public interface ResourcePathReceiver extends OsidReceiver

The resource route receiver is the consumer supplied interface for receiving notifications pertaining to changes of resources along paths.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    enteredPath(Id pathId, Id resourceId)
    The callback for notifications of resources starting on paths.
    void
    exitedPath(Id pathId, Id resourceId)
    The callback for notifications of resources leaving 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

    • enteredPath

      void enteredPath(Id pathId, Id resourceId)
      The callback for notifications of resources starting on paths.
      Parameters:
      pathId - the Id of the Path
      resourceId - the Id of the Resource
      Compliance:
      mandatory - This method must be implemented.

    • exitedPath

      void exitedPath(Id pathId, Id resourceId)
      The callback for notifications of resources leaving paths.
      Parameters:
      pathId - the Id of the Path
      resourceId - the Id of the Resource
      Compliance:
      mandatory - This method must be implemented.