Interface ResourcePositionReceiver

All Superinterfaces:
OsidReceiver
public interface ResourcePositionReceiver extends OsidReceiver

The resource location receiver is the consumer supplied interface for receiving notifications pertaining to position changes of resources.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    enteredSpatialUnit(Id notificationId, Id resourceId, SpatialUnit spatialUnit)
    The callback for notifications of resources entering spatial units.
    void
    exitedSpatialUnit(Id notificationId, Id resourceId, SpatialUnit spatialUnit)
    The callback for notifications of resources exiting spatial units.
    void
    movedResource(Id notificationId, Id resourceId, Coordinate coordinate)
    The callback for notifications of resources entering 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

    • movedResource

      void movedResource(Id notificationId, Id resourceId, Coordinate coordinate)
      The callback for notifications of resources entering locations.
      Parameters:
      notificationId - the notification Id
      resourceId - the Id of the Resource
      coordinate - the Id of the Coordinate
      Compliance:
      mandatory - This method must be implemented.

    • enteredSpatialUnit

      void enteredSpatialUnit(Id notificationId, Id resourceId, SpatialUnit spatialUnit)
      The callback for notifications of resources entering spatial units.
      Parameters:
      notificationId - the notification Id
      resourceId - the Id of the Resource
      spatialUnit - the Id of the SpatialUnit
      Compliance:
      mandatory - This method must be implemented.

    • exitedSpatialUnit

      void exitedSpatialUnit(Id notificationId, Id resourceId, SpatialUnit spatialUnit)
      The callback for notifications of resources exiting spatial units.
      Parameters:
      notificationId - the notification Id
      resourceId - the Id of the Resource
      spatialUnit - the Id of the SpatialUnit
      Compliance:
      mandatory - This method must be implemented.