oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2

Class TransportationSegmentType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2.TransportationSegmentType

public class TransportationSegmentType
extends Object

 <?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: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>
 

Java class for TransportationSegmentType complex type.

The following schema fragment specifies the expected content contained within this class.

 <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>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected ConsignmentType	referencedConsignment
protected SequenceNumericType	sequenceNumeric
protected List<ShipmentStageType>	shipmentStage
protected TransportationServiceType	transportationService
protected TransportExecutionPlanReferenceIDType	transportExecutionPlanReferenceID
protected PartyType	transportServiceProviderParty

Constructor Summary

Constructors

Constructor and Description
TransportationSegmentType()

Method Summary

Modifier and Type	Method and Description
ConsignmentType	getReferencedConsignment() <?
SequenceNumericType	getSequenceNumeric() <?
List<ShipmentStageType>	getShipmentStage() <?
TransportationServiceType	getTransportationService() <?
TransportExecutionPlanReferenceIDType	getTransportExecutionPlanReferenceID() <?
PartyType	getTransportServiceProviderParty() <?
void	setReferencedConsignment(ConsignmentType value) Sets the value of the referencedConsignment property.
void	setSequenceNumeric(SequenceNumericType value) Sets the value of the sequenceNumeric property.
void	setTransportationService(TransportationServiceType value) Sets the value of the transportationService property.
void	setTransportExecutionPlanReferenceID(TransportExecutionPlanReferenceIDType value) Sets the value of the transportExecutionPlanReferenceID property.
void	setTransportServiceProviderParty(PartyType value) Sets the value of the transportServiceProviderParty property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sequenceNumeric

protected SequenceNumericType sequenceNumeric

transportExecutionPlanReferenceID

protected TransportExecutionPlanReferenceIDType transportExecutionPlanReferenceID

transportationService

protected TransportationServiceType transportationService

transportServiceProviderParty

protected PartyType transportServiceProviderParty

referencedConsignment

protected ConsignmentType referencedConsignment

shipmentStage

protected List<ShipmentStageType> shipmentStage

Constructor Detail

TransportationSegmentType

public TransportationSegmentType()

Method Detail

getSequenceNumeric

public SequenceNumericType getSequenceNumeric()

 <?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: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>
 

Returns:

possible object is SequenceNumericType

setSequenceNumeric

public void setSequenceNumeric(SequenceNumericType value)

Sets the value of the sequenceNumeric property.

Parameters:

value - allowed object is SequenceNumericType

getTransportExecutionPlanReferenceID

public TransportExecutionPlanReferenceIDType getTransportExecutionPlanReferenceID()

 <?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: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>
 

Returns:

possible object is TransportExecutionPlanReferenceIDType

setTransportExecutionPlanReferenceID

public void setTransportExecutionPlanReferenceID(TransportExecutionPlanReferenceIDType value)

Sets the value of the transportExecutionPlanReferenceID property.

Parameters:

value - allowed object is TransportExecutionPlanReferenceIDType

getTransportationService

public TransportationServiceType getTransportationService()

 <?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: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>
 

Returns:

possible object is TransportationServiceType

setTransportationService

public void setTransportationService(TransportationServiceType value)

Sets the value of the transportationService property.

Parameters:

value - allowed object is TransportationServiceType

getTransportServiceProviderParty

public PartyType getTransportServiceProviderParty()

 <?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: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>
 

Returns:

possible object is PartyType

setTransportServiceProviderParty

public void setTransportServiceProviderParty(PartyType value)

Sets the value of the transportServiceProviderParty property.

Parameters:

value - allowed object is PartyType

getReferencedConsignment

public ConsignmentType getReferencedConsignment()

 <?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: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>
 

Returns:

possible object is ConsignmentType

setReferencedConsignment

public void setReferencedConsignment(ConsignmentType value)

Sets the value of the referencedConsignment property.

Parameters:

value - allowed object is ConsignmentType

getShipmentStage

public List<ShipmentStageType> getShipmentStage()

 <?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: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>
 

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 set method for the shipmentStage property.

For example, to add a new item, do as follows:

    getShipmentStage().add(newItem);
 

Objects of the following type(s) are allowed in the list ShipmentStageType