Package org.opentcs.access.to.order
Class OrderSequenceCreationTO
java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.order.OrderSequenceCreationTO
- All Implemented Interfaces:
Serializable
A transfer object describing a transport order.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the (optional) name of the vehicle that is supposed to execute the transport order.getType()
Returns the (optional) type of the order sequence.boolean
Indicates whether the name is incomplete and requires to be completed when creating the actual order sequence.boolean
Returns whether failure of one transport order in the sequence makes subsequent ones fail, too.withFailureFatal
(boolean failureFatal) Creates a copy of this object with the given failureFatal flag.withIncompleteName
(boolean incompleteName) Creates a copy of this object with the given nameIncomplete flag.withIntendedVehicleName
(String intendedVehicleName) Creates a copy of this object with the given (optional) name of the vehicle that is supposed to execute the transport order.Creates a copy of this object with the given name.withProperties
(Map<String, String> properties) Creates a copy of this object with the given properties.withProperty
(String key, String value) Creates a copy of this object and adds the given property.Creates a copy of this object with the given type.Methods inherited from class org.opentcs.access.to.CreationTO
getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith
-
Constructor Details
-
OrderSequenceCreationTO
Creates a new instance.- Parameters:
name
- The name of this transport order.
-
-
Method Details
-
withName
Creates a copy of this object with the given name.- Overrides:
withName
in classCreationTO
- Parameters:
name
- the new name of the instance.- Returns:
- A copy of this object, differing in the given name.
-
withProperties
Creates a copy of this object with the given properties.- Overrides:
withProperties
in classCreationTO
- Parameters:
properties
- The new properties.- Returns:
- A copy of this object, differing in the given value.
-
withProperty
Creates a copy of this object and adds the given property. If value == null, then the key-value pair is removed from the properties.- Overrides:
withProperty
in classCreationTO
- Parameters:
key
- the key.value
- the value- Returns:
- 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.)- Returns:
true
if, 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 nameIncomplete flag.- Parameters:
incompleteName
- Whether the name is incomplete and requires to be completed when creating the actual order sequence.- Returns:
- A copy of this object, differing in the given value.
-
getType
Returns the (optional) type of the order sequence.- Returns:
- The (optional) type of the order sequence.
-
withType
Creates a copy of this object with the given type.- Parameters:
type
- The type.- Returns:
- A copy of this object, differing in the given type.
-
getIntendedVehicleName
Returns the (optional) name of the vehicle that is supposed to execute the transport order.- Returns:
- The (optional) name of the vehicle that is supposed to execute the transport order.
-
withIntendedVehicleName
Creates a copy of this object with the given (optional) name of the vehicle that is supposed to execute the transport order.- Parameters:
intendedVehicleName
- The vehicle name.- Returns:
- 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.- Returns:
- Whether failure of one transport order in the sequence makes subsequent ones fail, too.
-
withFailureFatal
Creates a copy of this object with the given failureFatal flag.- Parameters:
failureFatal
- Whether failure of one transport order in the sequence makes subsequent ones fail, too.- Returns:
- A copy of this object, differing in the given value.
-