CustomsDeclarationType (ph-ubl23 6.7.0 API)

java.lang.Object
- oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_23.CustomsDeclarationType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class CustomsDeclarationType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
```
Java class for CustomsDeclarationType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="CustomsDeclarationType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2}UBLExtensions" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ValidityPeriod" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ApplicableTerritoryAddress" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Shipment" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}CustomsExitOfficeLocation" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}IssuerParty" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ConsignorParty" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ConsigneeParty" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}FreightForwarderParty" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}CustomsParty" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}PreviousCustomsDeclaration" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}AdditionalDocumentReference" 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

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

Constructors
Constructor and Description
`CustomsDeclarationType()` 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`	`addAdditionalDocumentReference(DocumentReferenceType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`CustomsDeclarationType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(CustomsDeclarationType 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
`List<DocumentReferenceType>`	`getAdditionalDocumentReference()` Gets the value of the additionalDocumentReference property.
`DocumentReferenceType`	`getAdditionalDocumentReferenceAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getAdditionalDocumentReferenceCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`AddressType`	`getApplicableTerritoryAddress()` Gets the value of the applicableTerritoryAddress property.
`PartyType`	`getConsigneeParty()` Gets the value of the consigneeParty property.
`PartyType`	`getConsignorParty()` Gets the value of the consignorParty property.
`LocationType`	`getCustomsExitOfficeLocation()` Gets the value of the customsExitOfficeLocation property.
`PartyType`	`getCustomsParty()` Gets the value of the customsParty property.
`PartyType`	`getFreightForwarderParty()` Gets the value of the freightForwarderParty property.
`IDType`	`getID()` Gets the value of the id property.
`String`	`getIDValue()` Get the value of the contained IDType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`PartyType`	`getIssuerParty()` Gets the value of the issuerParty property.
`CustomsDeclarationType`	`getPreviousCustomsDeclaration()` Gets the value of the previousCustomsDeclaration property.
`ShipmentType`	`getShipment()` Gets the value of the shipment property.
`UBLExtensionsType`	`getUBLExtensions()` Gets the value of the ublExtensions property.
`PeriodType`	`getValidityPeriod()` Gets the value of the validityPeriod property.
`boolean`	`hasAdditionalDocumentReferenceEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasNoAdditionalDocumentReferenceEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setAdditionalDocumentReference(List<DocumentReferenceType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setApplicableTerritoryAddress(AddressType value)` Sets the value of the applicableTerritoryAddress property.
`void`	`setConsigneeParty(PartyType value)` Sets the value of the consigneeParty property.
`void`	`setConsignorParty(PartyType value)` Sets the value of the consignorParty property.
`void`	`setCustomsExitOfficeLocation(LocationType value)` Sets the value of the customsExitOfficeLocation property.
`void`	`setCustomsParty(PartyType value)` Sets the value of the customsParty property.
`void`	`setFreightForwarderParty(PartyType value)` Sets the value of the freightForwarderParty property.
`void`	`setID(IDType value)` Sets the value of the id property.
`IDType`	`setID(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setIssuerParty(PartyType value)` Sets the value of the issuerParty property.
`void`	`setPreviousCustomsDeclaration(CustomsDeclarationType value)` Sets the value of the previousCustomsDeclaration property.
`void`	`setShipment(ShipmentType value)` Sets the value of the shipment property.
`void`	`setUBLExtensions(UBLExtensionsType value)` Sets the value of the ublExtensions property.
`void`	`setValidityPeriod(PeriodType value)` Sets the value of the validityPeriod 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
 - CustomsDeclarationType
```
public CustomsDeclarationType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getUBLExtensions
```
@Nullable
public UBLExtensionsType getUBLExtensions()
```
 Gets the value of the ublExtensions property.
 
 Returns:
 
 possible object is UBLExtensionsType
 - setUBLExtensions
```
public void setUBLExtensions(@Nullable
 UBLExtensionsType value)
```
 Sets the value of the ublExtensions property.
 
 Parameters:
 
 value - allowed object is UBLExtensionsType
 - getID
```
@Nullable
public IDType getID()
```
 Gets the value of the id property.
 
 Returns:
 
 possible object is IDType
 - setID
```
public void setID(@Nullable
 IDType value)
```
 Sets the value of the id property.
 
 Parameters:
 
 value - allowed object is IDType
 - getValidityPeriod
```
@Nullable
public PeriodType getValidityPeriod()
```
 Gets the value of the validityPeriod property.
 
 Returns:
 
 possible object is PeriodType
 - setValidityPeriod
```
public void setValidityPeriod(@Nullable
 PeriodType value)
```
 Sets the value of the validityPeriod property.
 
 Parameters:
 
 value - allowed object is PeriodType
 - getApplicableTerritoryAddress
```
@Nullable
public AddressType getApplicableTerritoryAddress()
```
 Gets the value of the applicableTerritoryAddress property.
 
 Returns:
 
 possible object is AddressType
 - setApplicableTerritoryAddress
```
public void setApplicableTerritoryAddress(@Nullable
 AddressType value)
```
 Sets the value of the applicableTerritoryAddress property.
 
 Parameters:
 
 value - allowed object is AddressType
 - getShipment
```
@Nullable
public ShipmentType getShipment()
```
 Gets the value of the shipment property.
 
 Returns:
 
 possible object is ShipmentType
 - setShipment
```
public void setShipment(@Nullable
 ShipmentType value)
```
 Sets the value of the shipment property.
 
 Parameters:
 
 value - allowed object is ShipmentType
 - getCustomsExitOfficeLocation
```
@Nullable
public LocationType getCustomsExitOfficeLocation()
```
 Gets the value of the customsExitOfficeLocation property.
 
 Returns:
 
 possible object is LocationType
 - setCustomsExitOfficeLocation
```
public void setCustomsExitOfficeLocation(@Nullable
 LocationType value)
```
 Sets the value of the customsExitOfficeLocation property.
 
 Parameters:
 
 value - allowed object is LocationType
 - getIssuerParty
```
@Nullable
public PartyType getIssuerParty()
```
 Gets the value of the issuerParty property.
 
 Returns:
 
 possible object is PartyType
 - setIssuerParty
```
public void setIssuerParty(@Nullable
 PartyType value)
```
 Sets the value of the issuerParty property.
 
 Parameters:
 
 value - allowed object is PartyType
 - getConsignorParty
```
@Nullable
public PartyType getConsignorParty()
```
 Gets the value of the consignorParty property.
 
 Returns:
 
 possible object is PartyType
 - setConsignorParty
```
public void setConsignorParty(@Nullable
 PartyType value)
```
 Sets the value of the consignorParty property.
 
 Parameters:
 
 value - allowed object is PartyType
 - getConsigneeParty
```
@Nullable
public PartyType getConsigneeParty()
```
 Gets the value of the consigneeParty property.
 
 Returns:
 
 possible object is PartyType
 - setConsigneeParty
```
public void setConsigneeParty(@Nullable
 PartyType value)
```
 Sets the value of the consigneeParty property.
 
 Parameters:
 
 value - allowed object is PartyType
 - getFreightForwarderParty
```
@Nullable
public PartyType getFreightForwarderParty()
```
 Gets the value of the freightForwarderParty property.
 
 Returns:
 
 possible object is PartyType
 - setFreightForwarderParty
```
public void setFreightForwarderParty(@Nullable
 PartyType value)
```
 Sets the value of the freightForwarderParty property.
 
 Parameters:
 
 value - allowed object is PartyType
 - getCustomsParty
```
@Nullable
public PartyType getCustomsParty()
```
 Gets the value of the customsParty property.
 
 Returns:
 
 possible object is PartyType
 - setCustomsParty
```
public void setCustomsParty(@Nullable
 PartyType value)
```
 Sets the value of the customsParty property.
 
 Parameters:
 
 value - allowed object is PartyType
 - getPreviousCustomsDeclaration
```
@Nullable
public CustomsDeclarationType getPreviousCustomsDeclaration()
```
 Gets the value of the previousCustomsDeclaration property.
 
 Returns:
 
 possible object is CustomsDeclarationType
 - setPreviousCustomsDeclaration
```
public void setPreviousCustomsDeclaration(@Nullable
 CustomsDeclarationType value)
```
 Sets the value of the previousCustomsDeclaration property.
 
 Parameters:
 
 value - allowed object is CustomsDeclarationType
 - getAdditionalDocumentReference
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DocumentReferenceType> getAdditionalDocumentReference()
```
 Gets the value of the additionalDocumentReference 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 additionalDocumentReference property. For example, to add a new item, do as follows: <pre> getAdditionalDocumentReference().add(newItem); </pre> Objects of the following type(s) are allowed in the list DocumentReferenceType
 - 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
 - setAdditionalDocumentReference
```
public void setAdditionalDocumentReference(@Nullable
 List<DocumentReferenceType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - hasAdditionalDocumentReferenceEntries
```
public boolean hasAdditionalDocumentReferenceEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoAdditionalDocumentReferenceEntries
```
public boolean hasNoAdditionalDocumentReferenceEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getAdditionalDocumentReferenceCount
```
@Nonnegative
public int getAdditionalDocumentReferenceCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getAdditionalDocumentReferenceAtIndex
```
@Nullable
public DocumentReferenceType getAdditionalDocumentReferenceAtIndex(@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!
 - addAdditionalDocumentReference
```
public void addAdditionalDocumentReference(@Nonnull
 DocumentReferenceType 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
 CustomsDeclarationType 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 CustomsDeclarationType 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>.
 - setID
```
@Nonnull
public IDType setID(@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 IDType and never <code>null</code>
 - getIDValue
```
@Nullable
public String getIDValue()
```
 Get the value of the contained IDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained IDType object or <code>null</code>

Class CustomsDeclarationType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomsDeclarationType

Method Detail

getUBLExtensions

setUBLExtensions

getID

setID

getValidityPeriod

setValidityPeriod

getApplicableTerritoryAddress

setApplicableTerritoryAddress

getShipment

setShipment

getCustomsExitOfficeLocation

setCustomsExitOfficeLocation

getIssuerParty

setIssuerParty

getConsignorParty

setConsignorParty

getConsigneeParty

setConsigneeParty

getFreightForwarderParty

setFreightForwarderParty

getCustomsParty

setCustomsParty

getPreviousCustomsDeclaration

setPreviousCustomsDeclaration

getAdditionalDocumentReference

equals

hashCode

toString

setAdditionalDocumentReference

hasAdditionalDocumentReferenceEntries

hasNoAdditionalDocumentReferenceEntries

getAdditionalDocumentReferenceCount

getAdditionalDocumentReferenceAtIndex

addAdditionalDocumentReference

cloneTo

clone

setID

getIDValue