Package org.opentcs.access.to.peripherals

Klasse PeripheralJobCreationTO

java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Alle implementierten Schnittstellen:
Serializable
public class PeripheralJobCreationTO extends CreationTO implements Serializable
A transfer object describing a peripheral job.
Siehe auch:

  • Konstruktordetails

    • PeripheralJobCreationTO

      public PeripheralJobCreationTO(@Nonnull String name, @Nonnull String reservationToken, @Nonnull PeripheralOperationCreationTO peripheralOperation)
      Creates a new instance.
      Parameter:
      name - The name of this peripheral job.
      reservationToken - The reservation token to be used.
      peripheralOperation - The peripheral operation to be performed.

  • Methodendetails

    • withName

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

    • withProperties

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

    • withProperty

      public PeripheralJobCreationTO withProperty(@Nonnull String key, @Nonnull String value)
      Beschreibung aus Klasse kopiert: CreationTO
      Creates a copy of this object with the given property. If value == null is true 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 includes the given property or removes the entry, if value == null.

    • hasIncompleteName

      public boolean hasIncompleteName()
      Indicates whether the name is incomplete and requires to be completed when creating the actual transport order. (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 PeripheralJobCreationTO withIncompleteName(boolean incompleteName)
      Creates a copy of this object, with the given incomplete name flag.
      Parameter:
      incompleteName - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getReservationToken

      public String getReservationToken()
      Returns the token that may be used to reserve a peripheral device.
      Gibt zurück:
      The token that may be used to reserve a peripheral device.

    • withReservationToken

      public PeripheralJobCreationTO withReservationToken(String reservationToken)
      Creates a copy of this object, with the given reservation token.
      Parameter:
      reservationToken - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getRelatedVehicleName

      @Nullable public String getRelatedVehicleName()
      Returns the name of the vehicle for which this peripheral job is to be created.
      Gibt zurück:
      The name of the vehicle for which this peripheral job is to be created.

    • withRelatedVehicleName

      public PeripheralJobCreationTO withRelatedVehicleName(@Nullable String relatedVehicleName)
      Creates a copy of this object, with the given related vehicle name.
      Parameter:
      relatedVehicleName - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getRelatedTransportOrderName

      @Nullable public String getRelatedTransportOrderName()
      Returns the name of the transport order for which this peripheral job is to be created.
      Gibt zurück:
      The name of the transport order for which this peripheral job is to be created.

    • withRelatedTransportOrderName

      public PeripheralJobCreationTO withRelatedTransportOrderName(@Nullable String relatedTransportOrderName)
      Creates a copy of this object, with the given related transport order name.
      Parameter:
      relatedTransportOrderName - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getPeripheralOperation

      public PeripheralOperationCreationTO getPeripheralOperation()
      Returns the operation that is to be performed by the pripheral device.
      Gibt zurück:
      The operation that is to be performed by the pripheral device.

    • withPeripheralOperation

      public PeripheralJobCreationTO withPeripheralOperation(PeripheralOperationCreationTO peripheralOperation)
      Creates a copy of this object, with the given peripheral operation.
      Parameter:
      peripheralOperation - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.