TransportationSegmentType (ph-ubl22 6.7.0 API)

java.lang.Object
- oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_22.TransportationSegmentType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class TransportationSegmentType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
```
<pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Transportation Segment. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe one segment or leg in a transportation service.</ccts:Definition><ccts:ObjectClass>Transportation Segment</ccts:ObjectClass></ccts:Component> </pre> Java class for TransportationSegmentType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="TransportationSegmentType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SequenceNumeric"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TransportExecutionPlanReferenceID" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TransportationService"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TransportServiceProviderParty"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ReferencedConsignment" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ShipmentStage" maxOccurs="unbounded" minOccurs="0"/> </sequence> </restriction> </complexContent> </complexType> </pre> This class was annotated by ph-jaxb22-plugin -Xph-annotate This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode This class contains methods created by ph-jaxb22-plugin -Xph-tostring This class contains methods created by ph-jaxb22-plugin -Xph-list-extension This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2 This class contains methods created by ph-jaxb22-plugin -Xph-value-extender

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TransportationSegmentType()
Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Constructors
Constructor and Description
`TransportationSegmentType()` Default constructor<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addShipmentStage(ShipmentStageType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`TransportationSegmentType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(TransportationSegmentType ret)` This method clones all values from <code>this</code> to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`ConsignmentType`	`getReferencedConsignment()` <pre> <?
`SequenceNumericType`	`getSequenceNumeric()` <pre> <?
`BigDecimal`	`getSequenceNumericValue()` Get the value of the contained SequenceNumericType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`List<ShipmentStageType>`	`getShipmentStage()` <pre> <?
`ShipmentStageType`	`getShipmentStageAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getShipmentStageCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`TransportationServiceType`	`getTransportationService()` <pre> <?
`TransportExecutionPlanReferenceIDType`	`getTransportExecutionPlanReferenceID()` <pre> <?
`String`	`getTransportExecutionPlanReferenceIDValue()` Get the value of the contained TransportExecutionPlanReferenceIDType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`PartyType`	`getTransportServiceProviderParty()` <pre> <?
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasNoShipmentStageEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasShipmentStageEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setReferencedConsignment(ConsignmentType value)` Sets the value of the referencedConsignment property.
`SequenceNumericType`	`setSequenceNumeric(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setSequenceNumeric(SequenceNumericType value)` Sets the value of the sequenceNumeric property.
`void`	`setShipmentStage(List<ShipmentStageType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setTransportationService(TransportationServiceType value)` Sets the value of the transportationService property.
`TransportExecutionPlanReferenceIDType`	`setTransportExecutionPlanReferenceID(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setTransportExecutionPlanReferenceID(TransportExecutionPlanReferenceIDType value)` Sets the value of the transportExecutionPlanReferenceID property.
`void`	`setTransportServiceProviderParty(PartyType value)` Sets the value of the transportServiceProviderParty property.
`String`	`toString()` Created by ph-jaxb22-plugin -Xph-tostring

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - TransportationSegmentType
```
public TransportationSegmentType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getSequenceNumeric
```
@Nullable
public SequenceNumericType getSequenceNumeric()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Transportation Segment. Sequence. Numeric</ccts:DictionaryEntryName><ccts:Definition>A number indicating the order of this segment in the sequence of transportation segments making up a transportation service.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Transportation Segment</ccts:ObjectClass><ccts:PropertyTerm>Sequence</ccts:PropertyTerm><ccts:RepresentationTerm>Numeric</ccts:RepresentationTerm><ccts:DataType>Numeric. Type</ccts:DataType><ccts:Examples>1, 2, 3, 4, etc.</ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is SequenceNumericType
 - setSequenceNumeric
```
public void setSequenceNumeric(@Nullable
 SequenceNumericType value)
```
 Sets the value of the sequenceNumeric property.
 
 Parameters:
 
 value - allowed object is SequenceNumericType
 - getTransportExecutionPlanReferenceID
```
@Nullable
public TransportExecutionPlanReferenceIDType getTransportExecutionPlanReferenceID()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Transportation Segment. Transport Execution Plan Reference. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the transport execution plan governing this transportation segment.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Transportation Segment</ccts:ObjectClass><ccts:PropertyTerm>Transport Execution Plan Reference</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is TransportExecutionPlanReferenceIDType
 - setTransportExecutionPlanReferenceID
```
public void setTransportExecutionPlanReferenceID(@Nullable
 TransportExecutionPlanReferenceIDType value)
```
 Sets the value of the transportExecutionPlanReferenceID property.
 
 Parameters:
 
 value - allowed object is TransportExecutionPlanReferenceIDType
 - getTransportationService
```
@Nullable
public TransportationServiceType getTransportationService()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Transportation Segment. Transportation Service</ccts:DictionaryEntryName><ccts:Definition>The transportation service used in this transportation segment.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Transportation Segment</ccts:ObjectClass><ccts:PropertyTerm>Transportation Service</ccts:PropertyTerm><ccts:AssociatedObjectClass>Transportation Service</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Transportation Service</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is TransportationServiceType
 - setTransportationService
```
public void setTransportationService(@Nullable
 TransportationServiceType value)
```
 Sets the value of the transportationService property.
 
 Parameters:
 
 value - allowed object is TransportationServiceType
 - getTransportServiceProviderParty
```
@Nullable
public PartyType getTransportServiceProviderParty()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Transportation Segment. Transport Service Provider_ Party. Party</ccts:DictionaryEntryName><ccts:Definition>The transport service provider responsible for carrying out transportation services in this transportation segment.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Transportation Segment</ccts:ObjectClass><ccts:PropertyTermQualifier>Transport Service Provider</ccts:PropertyTermQualifier><ccts:PropertyTerm>Party</ccts:PropertyTerm><ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Party</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is PartyType
 - setTransportServiceProviderParty
```
public void setTransportServiceProviderParty(@Nullable
 PartyType value)
```
 Sets the value of the transportServiceProviderParty property.
 
 Parameters:
 
 value - allowed object is PartyType
 - getReferencedConsignment
```
@Nullable
public ConsignmentType getReferencedConsignment()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Transportation Segment. Referenced_ Consignment. Consignment</ccts:DictionaryEntryName><ccts:Definition>A consignment referenced in this transportation segment. Such a consignment may have different identifiers than the consignment identifiers being used in the transportation service agreed between the transport user and the transport service provider.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Transportation Segment</ccts:ObjectClass><ccts:PropertyTermQualifier>Referenced</ccts:PropertyTermQualifier><ccts:PropertyTerm>Consignment</ccts:PropertyTerm><ccts:AssociatedObjectClass>Consignment</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Consignment</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is ConsignmentType
 - setReferencedConsignment
```
public void setReferencedConsignment(@Nullable
 ConsignmentType value)
```
 Sets the value of the referencedConsignment property.
 
 Parameters:
 
 value - allowed object is ConsignmentType
 - getShipmentStage
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<ShipmentStageType> getShipmentStage()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Transportation Segment. Shipment Stage</ccts:DictionaryEntryName><ccts:Definition>The shipment stage associated with this transportation segment.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Transportation Segment</ccts:ObjectClass><ccts:PropertyTerm>Shipment Stage</ccts:PropertyTerm><ccts:AssociatedObjectClass>Shipment Stage</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Shipment Stage</ccts:RepresentationTerm></ccts:Component> </pre> Gets the value of the shipmentStage property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the shipmentStage property. For example, to add a new item, do as follows: <pre> getShipmentStage().add(newItem); </pre> Objects of the following type(s) are allowed in the list ShipmentStageType
 - equals
```
public boolean equals(Object o)
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 equals in class Object
 - hashCode
```
public int hashCode()
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 hashCode in class Object
 - toString
```
public String toString()
```
 Created by ph-jaxb22-plugin -Xph-tostring
 
 Overrides:
 
 toString in class Object
 - setShipmentStage
```
public void setShipmentStage(@Nullable
 List<ShipmentStageType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - hasShipmentStageEntries
```
public boolean hasShipmentStageEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoShipmentStageEntries
```
public boolean hasNoShipmentStageEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getShipmentStageCount
```
@Nonnegative
public int getShipmentStageCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getShipmentStageAtIndex
```
@Nullable
public ShipmentStageType getShipmentStageAtIndex(@Nonnegative
 int index)
 throws IndexOutOfBoundsException
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 index - The index to retrieve
 
 Returns:
 
 The element at the specified index. May be <code>null</code>
 
 Throws:
 
 IndexOutOfBoundsException - if the index is invalid!
 - addShipmentStage
```
public void addShipmentStage(@Nonnull
 ShipmentStageType elem)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 elem - The element to be added. May not be <code>null</code>.
 - cloneTo
```
public void cloneTo(@Nonnull
 TransportationSegmentType ret)
```
 This method clones all values from <code>this</code> to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Parameters:
 
 ret - The target object to clone to. May not be <code>null</code>.
 - clone
```
@Nonnull
 @ReturnsMutableCopy
public TransportationSegmentType clone()
```
 Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Specified by:
 
 clone in interface com.helger.commons.lang.IExplicitlyCloneable
 
 Overrides:
 
 clone in class Object
 
 Returns:
 
 The cloned object. Never <code>null</code>.
 - setTransportExecutionPlanReferenceID
```
@Nonnull
public TransportExecutionPlanReferenceIDType setTransportExecutionPlanReferenceID(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type TransportExecutionPlanReferenceIDType and never <code>null</code>
 - setSequenceNumeric
```
@Nonnull
public SequenceNumericType setSequenceNumeric(@Nullable
 BigDecimal valueParam)
```
 Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type SequenceNumericType and never <code>null</code>
 - getSequenceNumericValue
```
@Nullable
public BigDecimal getSequenceNumericValue()
```
 Get the value of the contained SequenceNumericType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained SequenceNumericType object or <code>null</code>
 - getTransportExecutionPlanReferenceIDValue
```
@Nullable
public String getTransportExecutionPlanReferenceIDValue()
```
 Get the value of the contained TransportExecutionPlanReferenceIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained TransportExecutionPlanReferenceIDType object or <code>null</code>

Class TransportationSegmentType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransportationSegmentType

Method Detail

getSequenceNumeric

setSequenceNumeric

getTransportExecutionPlanReferenceID

setTransportExecutionPlanReferenceID

getTransportationService

setTransportationService

getTransportServiceProviderParty

setTransportServiceProviderParty

getReferencedConsignment

setReferencedConsignment

getShipmentStage

equals

hashCode

toString

setShipmentStage

hasShipmentStageEntries

hasNoShipmentStageEntries

getShipmentStageCount

getShipmentStageAtIndex

addShipmentStage

cloneTo

clone

setTransportExecutionPlanReferenceID

setSequenceNumeric

getSequenceNumericValue

getTransportExecutionPlanReferenceIDValue