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

Class MaritimeTransportType

java.lang.Object

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

public class MaritimeTransportType
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>Maritime Transport. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe a vessel used for transport by water (including sea, river, and canal).</ccts:Definition>
                <ccts:ObjectClass>Maritime Transport</ccts:ObjectClass>
             </ccts:Component>
 

Java class for MaritimeTransportType complex type.

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

 <complexType name="MaritimeTransportType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}VesselID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}VesselName" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}RadioCallSignID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ShipsRequirements" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}GrossTonnageMeasure" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}NetTonnageMeasure" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}RegistryCertificateDocumentReference" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}RegistryPortLocation" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected GrossTonnageMeasureType	grossTonnageMeasure
protected NetTonnageMeasureType	netTonnageMeasure
protected RadioCallSignIDType	radioCallSignID
protected DocumentReferenceType	registryCertificateDocumentReference
protected LocationType	registryPortLocation
protected List<ShipsRequirementsType>	shipsRequirements
protected VesselIDType	vesselID
protected VesselNameType	vesselName

Constructor Summary

Constructors

Constructor and Description
MaritimeTransportType()

Method Summary

Modifier and Type	Method and Description
GrossTonnageMeasureType	getGrossTonnageMeasure() <?
NetTonnageMeasureType	getNetTonnageMeasure() <?
RadioCallSignIDType	getRadioCallSignID() <?
DocumentReferenceType	getRegistryCertificateDocumentReference() <?
LocationType	getRegistryPortLocation() <?
List<ShipsRequirementsType>	getShipsRequirements() <?
VesselIDType	getVesselID() <?
VesselNameType	getVesselName() <?
void	setGrossTonnageMeasure(GrossTonnageMeasureType value) Sets the value of the grossTonnageMeasure property.
void	setNetTonnageMeasure(NetTonnageMeasureType value) Sets the value of the netTonnageMeasure property.
void	setRadioCallSignID(RadioCallSignIDType value) Sets the value of the radioCallSignID property.
void	setRegistryCertificateDocumentReference(DocumentReferenceType value) Sets the value of the registryCertificateDocumentReference property.
void	setRegistryPortLocation(LocationType value) Sets the value of the registryPortLocation property.
void	setVesselID(VesselIDType value) Sets the value of the vesselID property.
void	setVesselName(VesselNameType value) Sets the value of the vesselName property.

Methods inherited from class java.lang.Object

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

Field Detail

vesselID

protected VesselIDType vesselID

vesselName

protected VesselNameType vesselName

radioCallSignID

protected RadioCallSignIDType radioCallSignID

shipsRequirements

protected List<ShipsRequirementsType> shipsRequirements

grossTonnageMeasure

protected GrossTonnageMeasureType grossTonnageMeasure

netTonnageMeasure

protected NetTonnageMeasureType netTonnageMeasure

registryCertificateDocumentReference

protected DocumentReferenceType registryCertificateDocumentReference

registryPortLocation

protected LocationType registryPortLocation

Constructor Detail

MaritimeTransportType

public MaritimeTransportType()

Method Detail

getVesselID

public VesselIDType getVesselID()

 <?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>Maritime Transport. Vessel Identifier. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for a specific vessel.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Maritime Transport</ccts:ObjectClass>
                      <ccts:PropertyTerm>Vessel Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                      <ccts:AlternativeBusinessTerms>Lloyds Number, Registration Number (WCO ID 167)</ccts:AlternativeBusinessTerms>
                      <ccts:Examples>International Maritime Organisation number of a vessel</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is VesselIDType

setVesselID

public void setVesselID(VesselIDType value)

Sets the value of the vesselID property.

Parameters:

value - allowed object is VesselIDType

getVesselName

public VesselNameType getVesselName()

 <?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>Maritime Transport. Vessel Name. Name</ccts:DictionaryEntryName>
                      <ccts:Definition>The name of the vessel.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Maritime Transport</ccts:ObjectClass>
                      <ccts:PropertyTerm>Vessel Name</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Name</ccts:RepresentationTerm>
                      <ccts:DataType>Name. Type</ccts:DataType>
                      <ccts:AlternativeBusinessTerms>Ships Name</ccts:AlternativeBusinessTerms>
                   </ccts:Component>
 

Returns:

possible object is VesselNameType

setVesselName

public void setVesselName(VesselNameType value)

Sets the value of the vesselName property.

Parameters:

value - allowed object is VesselNameType

getRadioCallSignID

public RadioCallSignIDType getRadioCallSignID()

 <?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>Maritime Transport. Radio Call Sign Identifier. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>The radio call sign of the vessel.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Maritime Transport</ccts:ObjectClass>
                      <ccts:PropertyTerm>Radio Call Sign Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                      <ccts:Examples>NES</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is RadioCallSignIDType

setRadioCallSignID

public void setRadioCallSignID(RadioCallSignIDType value)

Sets the value of the radioCallSignID property.

Parameters:

value - allowed object is RadioCallSignIDType

getShipsRequirements

public List<ShipsRequirementsType> getShipsRequirements()

 <?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>Maritime Transport. Ships Requirements. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Information about what services a vessel will require when it arrives at a port, such as refueling, maintenance, waste disposal etc.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Maritime Transport</ccts:ObjectClass>
                      <ccts:PropertyTerm>Ships Requirements</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

Gets the value of the shipsRequirements 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 shipsRequirements property.

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

    getShipsRequirements().add(newItem);
 

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

getGrossTonnageMeasure

public GrossTonnageMeasureType getGrossTonnageMeasure()

 <?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>Maritime Transport. Gross Tonnage. Measure</ccts:DictionaryEntryName>
                      <ccts:Definition>Gross tonnage is calculated by measuring a ship's volume (from keel to funnel, to the outside of the hull framing) and applying a mathematical formula and is used to determine things such as a ship's manning regulations, safety rules, registration fees and port dues.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Maritime Transport</ccts:ObjectClass>
                      <ccts:PropertyTerm>Gross Tonnage</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Measure</ccts:RepresentationTerm>
                      <ccts:DataType>Measure. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is GrossTonnageMeasureType

setGrossTonnageMeasure

public void setGrossTonnageMeasure(GrossTonnageMeasureType value)

Sets the value of the grossTonnageMeasure property.

Parameters:

value - allowed object is GrossTonnageMeasureType

getNetTonnageMeasure

public NetTonnageMeasureType getNetTonnageMeasure()

 <?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>Maritime Transport. Net Tonnage. Measure</ccts:DictionaryEntryName>
                      <ccts:Definition>Net tonnage is calculated by measuring a ship's internal volume and applying a mathematical formula and is used to calculate the port duties.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Maritime Transport</ccts:ObjectClass>
                      <ccts:PropertyTerm>Net Tonnage</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Measure</ccts:RepresentationTerm>
                      <ccts:DataType>Measure. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is NetTonnageMeasureType

setNetTonnageMeasure

public void setNetTonnageMeasure(NetTonnageMeasureType value)

Sets the value of the netTonnageMeasure property.

Parameters:

value - allowed object is NetTonnageMeasureType

getRegistryCertificateDocumentReference

public DocumentReferenceType getRegistryCertificateDocumentReference()

 <?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>Maritime Transport. Registry Certificate_ Document Reference. Document Reference</ccts:DictionaryEntryName>
                      <ccts:Definition>The certificate issued to the ship by the ships registry in a given flag state.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Maritime Transport</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Registry Certificate</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Document Reference</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Document Reference</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Document Reference</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is DocumentReferenceType

setRegistryCertificateDocumentReference

public void setRegistryCertificateDocumentReference(DocumentReferenceType value)

Sets the value of the registryCertificateDocumentReference property.

Parameters:

value - allowed object is DocumentReferenceType

getRegistryPortLocation

public LocationType getRegistryPortLocation()

 <?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>Maritime Transport. Registry Port_ Location. Location</ccts:DictionaryEntryName>
                      <ccts:Definition>The port in which a vessel is registered or permanently based.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Maritime Transport</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Registry Port</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Location</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Location</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Location</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is LocationType

setRegistryPortLocation

public void setRegistryPortLocation(LocationType value)

Sets the value of the registryPortLocation property.

Parameters:

value - allowed object is LocationType