Package org.opentcs.access.to.order

Klasse OrderSequenceCreationTO

java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.order.OrderSequenceCreationTO
Alle implementierten Schnittstellen:
Serializable
public class OrderSequenceCreationTO extends CreationTO implements Serializable
A transfer object describing a transport order.
Siehe auch:

  • Konstruktordetails

    • OrderSequenceCreationTO

      public OrderSequenceCreationTO(@Nonnull String name)
      Creates a new instance.
      Parameter:
      name - The name of this transport order.

  • Methodendetails

    • withName

      public OrderSequenceCreationTO withName(@Nonnull String name)
      Creates a copy of this object with the given name.
      Setzt außer Kraft:
      withName in Klasse CreationTO
      Parameter:
      name - the new name of the instance.
      Gibt zurück:
      A copy of this object, differing in the given name.

    • withProperties

      public OrderSequenceCreationTO withProperties(@Nonnull Map<String,String> properties)
      Creates a copy of this object with the given properties.
      Setzt außer Kraft:
      withProperties in Klasse CreationTO
      Parameter:
      properties - The new properties.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • withProperty

      public OrderSequenceCreationTO withProperty(@Nonnull String key, @Nonnull String value)
      Creates a copy of this object and adds the given property. If value == null, then the key-value pair is removed from the properties.
      Setzt außer Kraft:
      withProperty in Klasse CreationTO
      Parameter:
      key - the key.
      value - the value
      Gibt zurück:
      A copy of this object that either includes the given entry in it's current properties, if value != null or excludes the entry otherwise.

    • hasIncompleteName

      public boolean hasIncompleteName()
      Indicates whether the name is incomplete and requires to be completed when creating the actual order sequence. (How exactly this is done is decided by the kernel.)
      Gibt zurück:
      true if, and only if, the name is incomplete and requires to be completed by the kernel.

    • withIncompleteName

      public OrderSequenceCreationTO withIncompleteName(boolean incompleteName)
      Creates a copy of this object with the given nameIncomplete flag.
      Parameter:
      incompleteName - Whether the name is incomplete and requires to be completed when creating the actual order sequence.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getType

      @Nonnull public String getType()
      Returns the (optional) type of the order sequence.
      Gibt zurück:
      The (optional) type of the order sequence.

    • withType

      public OrderSequenceCreationTO withType(@Nonnull String type)
      Creates a copy of this object with the given type.
      Parameter:
      type - The type.
      Gibt zurück:
      A copy of this object, differing in the given type.

    • getIntendedVehicleName

      @Nullable public String getIntendedVehicleName()
      Returns the (optional) name of the vehicle that is supposed to execute the transport order.
      Gibt zurück:
      The (optional) name of the vehicle that is supposed to execute the transport order.

    • withIntendedVehicleName

      public OrderSequenceCreationTO withIntendedVehicleName(@Nullable String intendedVehicleName)
      Creates a copy of this object with the given (optional) name of the vehicle that is supposed to execute the transport order.
      Parameter:
      intendedVehicleName - The vehicle name.
      Gibt zurück:
      A copy of this object, differing in the given name of the intended vehicle.

    • isFailureFatal

      public boolean isFailureFatal()
      Returns whether failure of one transport order in the sequence makes subsequent ones fail, too.
      Gibt zurück:
      Whether failure of one transport order in the sequence makes subsequent ones fail, too.

    • withFailureFatal

      public OrderSequenceCreationTO withFailureFatal(boolean failureFatal)
      Creates a copy of this object with the given failureFatal flag.
      Parameter:
      failureFatal - Whether failure of one transport order in the sequence makes subsequent ones fail, too.
      Gibt zurück:
      A copy of this object, differing in the given value.