Interface ResourceRouteReceiver

All Superinterfaces:
OsidReceiver
public interface ResourceRouteReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancelledRoute(Id notificationId, Id routeId, Id resourceId)
    The callback for notifications of resources cancelling routes.
    void
    completedRoute(Id notificationId, Id routeId, Id resourceId)
    The callback for notifications of resources completing routes.
    void
    newRouteSegment(Id notificationId, Id routeSegmentId, Id resourceId)
    The callback for notifications of resources beginning new route segments.
    void
    startedRoute(Id notificationId, Id routeId, Id resourceId)
    The callback for notifications of resources starting on routes.

    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

    • startedRoute

      void startedRoute(Id notificationId, Id routeId, Id resourceId)
      The callback for notifications of resources starting on routes.
      Parameters:
      notificationId - the notification Id
      routeId - the Id of the Route
      resourceId - the Id of the Resource
      Compliance:
      mandatory - This method must be implemented.

    • completedRoute

      void completedRoute(Id notificationId, Id routeId, Id resourceId)
      The callback for notifications of resources completing routes.
      Parameters:
      notificationId - the notification Id
      routeId - the Id of the Route
      resourceId - the Id of the Resource
      Compliance:
      mandatory - This method must be implemented.

    • cancelledRoute

      void cancelledRoute(Id notificationId, Id routeId, Id resourceId)
      The callback for notifications of resources cancelling routes.
      Parameters:
      notificationId - the notification Id
      routeId - the Id of the Route
      resourceId - the Id of the Resource
      Compliance:
      mandatory - This method must be implemented.

    • newRouteSegment

      void newRouteSegment(Id notificationId, Id routeSegmentId, Id resourceId)
      The callback for notifications of resources beginning new route segments.
      Parameters:
      notificationId - the notification Id
      routeSegmentId - the Id of the RouteSegment
      resourceId - the Id of the Resource
      Compliance:
      mandatory - This method must be implemented.