Add support for multiple order types in order sequences

* A new `orderTypes` set has been added that replaces the single `type`
  field. This set defines the allowed order types for the order
  sequence, meaning that each order in the sequence must match one of
  these types.
* The request body of the `POST /orderSequences/{NAME}` endpoint has
  been extended so that it can accept either a list of order types or a
  single type, but not both simultaneously.
  Additionally, the responses of the order sequence endpoints
  (e.g., GET /orderSequences/) now also return the order types.

Merged-by: Martin Grzenia <martin.grzenia@iml.fraunhofer.de>

Author: Finja Averhaus

opentcs-api-base/src/main/java/org/opentcs/access/to/order/OrderConstantsTO.java

@@ -2,12 +2,26 @@
 // SPDX-License-Identifier: MIT
 package org.opentcs.access.to.order;
 
+import org.opentcs.data.order.OrderSequence;
+import org.opentcs.util.annotations.ScheduledApiChange;
+
 /**
  * Defines some constants for {@link TransportOrderCreationTO}s and
  * {@link OrderSequenceCreationTO}s.
  */
 public interface OrderConstantsTO {
 
+  /**
+   * A special type used to indicate that an order sequence's type is not set.
+   * An order sequence's type should not be set to this value by a user.
+   *
+   * @deprecated This sole purpose of this type is to serve as the default value for
+   * {@link OrderSequence#getType() an order sequence's type}, which is scheduled for removal with
+   * openTCS 8.0.
+   */
+  @Deprecated
+  @ScheduledApiChange(when = "8.0", details = "Will be removed.")
+  String TYPE_UNSET = "";
   /**
    * The string representing the <em>any</em> type.
    * Primarily intended to be used for a vehicle to indicate there are no restrictions to its

opentcs-api-base/src/main/java/org/opentcs/access/to/order/OrderSequenceCreationTO.java

@@ -8,7 +8,9 @@
 import jakarta.annotation.Nullable;
 import java.io.Serializable;
 import java.util.Map;
+import java.util.Set;
 import org.opentcs.access.to.CreationTO;
+import org.opentcs.util.annotations.ScheduledApiChange;
 
 /**
  * A transfer object describing a transport order.
@@ -28,7 +30,13 @@ public class OrderSequenceCreationTO
   /**
    * The type of the order sequence.
    */
+  @Deprecated
   private final String type;
+  /**
+   * The set of order types allowed in this order sequence.
+   * Each order in the sequence must match one of these types.
+   */
+  private final Set<String> orderTypes;
   /**
    * The (optional) name of the vehicle that is supposed to execute the transport order.
    */
@@ -44,13 +52,15 @@ public class OrderSequenceCreationTO
    *
    * @param name The name of this transport order.
    */
+  @SuppressWarnings("deprecation")
   public OrderSequenceCreationTO(
       @Nonnull
       String name
   ) {
     super(name);
     this.incompleteName = false;
-    this.type = OrderConstantsTO.TYPE_NONE;
+    this.type = OrderConstantsTO.TYPE_UNSET;
+    this.orderTypes = Set.of(OrderConstantsTO.TYPE_ANY);
     this.intendedVehicleName = null;
     this.failureFatal = false;
   }
@@ -63,13 +73,16 @@ private OrderSequenceCreationTO(
       boolean incompleteName,
       @Nonnull
       String type,
+      @Nonnull
+      Set<String> orderTypes,
       @Nullable
       String intendedVehicleName,
       boolean failureFatal
   ) {
     super(name, properties);
     this.incompleteName = incompleteName;
-    this.type = requireNonNull(type, "type");
+    this.type = requireNonNull(type);
+    this.orderTypes = requireNonNull(orderTypes);
     this.intendedVehicleName = intendedVehicleName;
     this.failureFatal = failureFatal;
   }
@@ -90,6 +103,7 @@ public OrderSequenceCreationTO withName(
         getModifiableProperties(),
         incompleteName,
         type,
+        orderTypes,
         intendedVehicleName,
         failureFatal
     );
@@ -111,6 +125,7 @@ public OrderSequenceCreationTO withProperties(
         properties,
         incompleteName,
         type,
+        orderTypes,
         intendedVehicleName,
         failureFatal
     );
@@ -138,6 +153,7 @@ public OrderSequenceCreationTO withProperty(
         propertiesWith(key, value),
         incompleteName,
         type,
+        orderTypes,
         intendedVehicleName,
         failureFatal
     );
@@ -169,6 +185,7 @@ public OrderSequenceCreationTO withIncompleteName(boolean incompleteName) {
         getModifiableProperties(),
         incompleteName,
         type,
+        orderTypes,
         intendedVehicleName,
         failureFatal
     );
@@ -178,7 +195,10 @@ public OrderSequenceCreationTO withIncompleteName(boolean incompleteName) {
    * Returns the (optional) type of the order sequence.
    *
    * @return The (optional) type of the order sequence.
+   * @deprecated Use {@link OrderSequenceCreationTO#getOrderTypes()} instead.
    */
+  @Deprecated
+  @ScheduledApiChange(when = "8.0", details = "Will be removed.")
   @Nonnull
   public String getType() {
     return type;
@@ -189,7 +209,10 @@ public String getType() {
    *
    * @param type The type.
    * @return A copy of this object, differing in the given type.
+   * @deprecated Use {@link OrderSequenceCreationTO#withOrderTypes(Set)} instead.
    */
+  @Deprecated
+  @ScheduledApiChange(when = "8.0", details = "Will be removed.")
   public OrderSequenceCreationTO withType(
       @Nonnull
       String type
@@ -199,6 +222,38 @@ public OrderSequenceCreationTO withType(
         getModifiableProperties(),
         incompleteName,
         type,
+        orderTypes,
+        intendedVehicleName,
+        failureFatal
+    );
+  }
+
+  /**
+   * Returns the order types of the order sequence.
+   *
+   * @return The order types of the order sequence.
+   */
+  @Nonnull
+  public Set<String> getOrderTypes() {
+    return orderTypes;
+  }
+
+  /**
+   * Creates a copy of this object with the given order types.
+   *
+   * @param orderTypes The order types.
+   * @return A copy of this object, differing in the given type.
+   */
+  public OrderSequenceCreationTO withOrderTypes(
+      @Nonnull
+      Set<String> orderTypes
+  ) {
+    return new OrderSequenceCreationTO(
+        getName(),
+        getModifiableProperties(),
+        incompleteName,
+        type,
+        orderTypes,
         intendedVehicleName,
         failureFatal
     );
@@ -230,6 +285,7 @@ public OrderSequenceCreationTO withIntendedVehicleName(
         getModifiableProperties(),
         incompleteName,
         type,
+        orderTypes,
         intendedVehicleName,
         failureFatal
     );
@@ -258,6 +314,7 @@ public OrderSequenceCreationTO withFailureFatal(boolean failureFatal) {
         getModifiableProperties(),
         incompleteName,
         type,
+        orderTypes,
         intendedVehicleName,
         failureFatal
     );