Class PeripheralJobCreationTO
java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.peripherals.PeripheralJobCreationTO
- All Implemented Interfaces:
java.io.Serializable
public class PeripheralJobCreationTO extends CreationTO implements java.io.Serializable
A transfer object describing a peripheral job.
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description PeripheralJobCreationTO(java.lang.String name, java.lang.String reservationToken, PeripheralOperationCreationTO peripheralOperation)Creates a new instance. -
Method Summary
Modifier and Type Method Description PeripheralOperationCreationTOgetPeripheralOperation()Returns the operation that is to be performed by the pripheral device.java.lang.StringgetRelatedTransportOrderName()Returns the name of the transport order for which this peripheral job is to be created.java.lang.StringgetRelatedVehicleName()Returns the name of the vehicle for which this peripheral job is to be created.java.lang.StringgetReservationToken()Returns the token that may be used to reserve a peripheral device.booleanhasIncompleteName()Indicates whether the name is incomplete and requires to be completed when creating the actual transport order.PeripheralJobCreationTOwithIncompleteName(boolean incompleteName)Creates a copy of this object, with the given incomplete name flag.PeripheralJobCreationTOwithName(java.lang.String name)Creates a copy of this object with the given name.PeripheralJobCreationTOwithPeripheralOperation(PeripheralOperationCreationTO peripheralOperation)Creates a copy of this object, with the given peripheral operation.PeripheralJobCreationTOwithProperties(java.util.Map<java.lang.String,java.lang.String> properties)PeripheralJobCreationTOwithProperty(java.lang.String key, java.lang.String value)Creates a copy of this object with the given property.PeripheralJobCreationTOwithRelatedTransportOrderName(java.lang.String relatedTransportOrderName)Creates a copy of this object, with the given related transport order name.PeripheralJobCreationTOwithRelatedVehicleName(java.lang.String relatedVehicleName)Creates a copy of this object, with the given related vehicle name.PeripheralJobCreationTOwithReservationToken(java.lang.String reservationToken)Creates a copy of this object, with the given reservation token.Methods inherited from class org.opentcs.access.to.CreationTO
getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith
-
Constructor Details
-
PeripheralJobCreationTO
public PeripheralJobCreationTO(@Nonnull java.lang.String name, @Nonnull java.lang.String reservationToken, @Nonnull PeripheralOperationCreationTO peripheralOperation)Creates a new instance.- Parameters:
name- The name of this peripheral job.reservationToken- The reservation token to be used.peripheralOperation- The peripheral operation to be performed.
-
-
Method Details
-
withName
Description copied from class:CreationTOCreates a copy of this object with the given name.- Overrides:
withNamein classCreationTO- Parameters:
name- the new name- Returns:
- A copy of this object, differing in the given value.
-
withProperties
public PeripheralJobCreationTO withProperties(@Nonnull java.util.Map<java.lang.String,java.lang.String> properties)- Overrides:
withPropertiesin classCreationTO
-
withProperty
public PeripheralJobCreationTO withProperty(@Nonnull java.lang.String key, @Nonnull java.lang.String value)Description copied from class:CreationTOCreates a copy of this object with the given property. If value == null is true then the key-value pair is removed from the properties.- Overrides:
withPropertyin classCreationTO- Parameters:
key- the key.value- the value- Returns:
- 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.)- Returns:
trueif, and only if, the name is incomplete and requires to be completed by the kernel.
-
withIncompleteName
Creates a copy of this object, with the given incomplete name flag.- Parameters:
incompleteName- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getReservationToken
public java.lang.String getReservationToken()Returns the token that may be used to reserve a peripheral device.- Returns:
- The token that may be used to reserve a peripheral device.
-
withReservationToken
Creates a copy of this object, with the given reservation token.- Parameters:
reservationToken- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getRelatedVehicleName
@Nullable public java.lang.String getRelatedVehicleName()Returns the name of the vehicle for which this peripheral job is to be created.- Returns:
- The name of the vehicle for which this peripheral job is to be created.
-
withRelatedVehicleName
public PeripheralJobCreationTO withRelatedVehicleName(@Nullable java.lang.String relatedVehicleName)Creates a copy of this object, with the given related vehicle name.- Parameters:
relatedVehicleName- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getRelatedTransportOrderName
@Nullable public java.lang.String getRelatedTransportOrderName()Returns the name of the transport order for which this peripheral job is to be created.- Returns:
- The name of the transport order for which this peripheral job is to be created.
-
withRelatedTransportOrderName
public PeripheralJobCreationTO withRelatedTransportOrderName(@Nullable java.lang.String relatedTransportOrderName)Creates a copy of this object, with the given related transport order name.- Parameters:
relatedTransportOrderName- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getPeripheralOperation
Returns the operation that is to be performed by the pripheral device.- Returns:
- 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.- Parameters:
peripheralOperation- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-