Interface RouteService

All Known Implementing Classes:
RouteServiceImpl

public interface RouteService
A RouteService operates on Routes.
Author:
Heiko Scherrer
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Changes the determined route due to error etc.
    findByRouteId(@NotBlank String routeId)
    Find and return a Route identified by its given routeId.
    boolean
    routeExistsWithLocationId(@NotBlank String locationId)
    Checks if a Route exists that uses a Location with the given locationId.
    void
    Send a RES_ telegram to the next location that is defined in the static Route Details.
  • Method Details

    • findByRouteId

      Optional<RouteImpl> findByRouteId(@NotBlank @NotBlank String routeId)
      Find and return a Route identified by its given routeId.
      Parameters:
      routeId - The route id
      Returns:
      The instance (optional)
    • routeExistsWithLocationId

      boolean routeExistsWithLocationId(@NotBlank @NotBlank String locationId)
      Checks if a Route exists that uses a Location with the given locationId.
      Parameters:
      locationId - The location ID to check for.
      Returns:
      true if a route exists with the given location ID, false otherwise.
      Throws:
      IllegalArgumentException - if the parameter 'locationId' is blank.
    • sendToNextLocation

      void sendToNextLocation()
      Send a RES_ telegram to the next location that is defined in the static Route Details.
    • changeRoute

      void changeRoute(String routeId)
      Changes the determined route due to error etc.
      Parameters:
      routeId - The route id