oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21

Class DeliveryTermsType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.DeliveryTermsType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

@CodingStyleguideUnaware
public class DeliveryTermsType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

 <?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>Delivery Terms. Details</ccts:DictionaryEntryName><ccts:Definition>A class for describing the terms and conditions applying to the delivery of goods.</ccts:Definition><ccts:ObjectClass>Delivery Terms</ccts:ObjectClass></ccts:Component>
 

Java class for DeliveryTermsType complex type.

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

 <complexType name="DeliveryTermsType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SpecialTerms" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LossRiskResponsibilityCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LossRisk" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Amount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}DeliveryLocation" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}AllowanceCharge" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

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
DeliveryTermsType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addLossRisk(LossRiskType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addSpecialTerms(SpecialTermsType elem) Created by ph-jaxb22-plugin -Xph-list-extension
DeliveryTermsType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(DeliveryTermsType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
AllowanceChargeType	getAllowanceCharge() <?
AmountType	getAmount() <?
BigDecimal	getAmountValue() Get the value of the contained AmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
LocationType	getDeliveryLocation() <?
IDType	getID() <?
String	getIDValue() Get the value of the contained IDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<LossRiskType>	getLossRisk() <?
LossRiskType	getLossRiskAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getLossRiskCount() Created by ph-jaxb22-plugin -Xph-list-extension
LossRiskResponsibilityCodeType	getLossRiskResponsibilityCode() <?
String	getLossRiskResponsibilityCodeValue() Get the value of the contained LossRiskResponsibilityCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<SpecialTermsType>	getSpecialTerms() <?
SpecialTermsType	getSpecialTermsAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getSpecialTermsCount() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasLossRiskEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoLossRiskEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoSpecialTermsEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasSpecialTermsEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setAllowanceCharge(AllowanceChargeType value) Sets the value of the allowanceCharge property.
void	setAmount(AmountType value) Sets the value of the amount property.
AmountType	setAmount(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setDeliveryLocation(LocationType value) Sets the value of the deliveryLocation property.
void	setID(IDType value) Sets the value of the id property.
IDType	setID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setLossRisk(List<LossRiskType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setLossRiskResponsibilityCode(LossRiskResponsibilityCodeType value) Sets the value of the lossRiskResponsibilityCode property.
LossRiskResponsibilityCodeType	setLossRiskResponsibilityCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setSpecialTerms(List<SpecialTermsType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
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

DeliveryTermsType

public DeliveryTermsType()

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

Method Detail

getID

@Nullable
public IDType getID()

 <?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>Delivery Terms. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for this description of delivery terms.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Delivery Terms</ccts:ObjectClass><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>CIF, FOB, or EXW from the INCOTERMS Terms of Delivery. (2000 version preferred.)</ccts:Examples></ccts:Component>
 

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

getSpecialTerms

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<SpecialTermsType> getSpecialTerms()

 <?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>Delivery Terms. Special_ Terms. Text</ccts:DictionaryEntryName><ccts:Definition>A description of any terms or conditions relating to the delivery items.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Delivery Terms</ccts:ObjectClass><ccts:PropertyTermQualifier>Special</ccts:PropertyTermQualifier><ccts:PropertyTerm>Terms</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

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

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

    getSpecialTerms().add(newItem);
 

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

getLossRiskResponsibilityCode

@Nullable
public LossRiskResponsibilityCodeType getLossRiskResponsibilityCode()

 <?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>Delivery Terms. Loss Risk Responsibility Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code that identifies one of various responsibilities for loss risk in the execution of the delivery.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Delivery Terms</ccts:ObjectClass><ccts:PropertyTerm>Loss Risk Responsibility Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is LossRiskResponsibilityCodeType

setLossRiskResponsibilityCode

public void setLossRiskResponsibilityCode(@Nullable
                                          LossRiskResponsibilityCodeType value)

Sets the value of the lossRiskResponsibilityCode property.

Parameters:

value - allowed object is LossRiskResponsibilityCodeType

getLossRisk

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<LossRiskType> getLossRisk()

 <?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>Delivery Terms. Loss Risk. Text</ccts:DictionaryEntryName><ccts:Definition>A description of responsibility for risk of loss in execution of the delivery, expressed as text.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Delivery Terms</ccts:ObjectClass><ccts:PropertyTerm>Loss Risk</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

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

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

    getLossRisk().add(newItem);
 

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

getAmount

@Nullable
public AmountType getAmount()

 <?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>Delivery Terms. Amount</ccts:DictionaryEntryName><ccts:Definition>The monetary amount covered by these delivery terms.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Delivery Terms</ccts:ObjectClass><ccts:PropertyTerm>Amount</ccts:PropertyTerm><ccts:RepresentationTerm>Amount</ccts:RepresentationTerm><ccts:DataType>Amount. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is AmountType

setAmount

public void setAmount(@Nullable
                      AmountType value)

Sets the value of the amount property.

Parameters:

value - allowed object is AmountType

getDeliveryLocation

@Nullable
public LocationType getDeliveryLocation()

 <?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>Delivery Terms. Delivery_ Location. Location</ccts:DictionaryEntryName><ccts:Definition>The location for the contracted delivery.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Delivery Terms</ccts:ObjectClass><ccts:PropertyTermQualifier>Delivery</ccts:PropertyTermQualifier><ccts:PropertyTerm>Location</ccts:PropertyTerm><ccts:AssociatedObjectClass>Location</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Location</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is LocationType

setDeliveryLocation

public void setDeliveryLocation(@Nullable
                                LocationType value)

Sets the value of the deliveryLocation property.

Parameters:

value - allowed object is LocationType

getAllowanceCharge

@Nullable
public AllowanceChargeType getAllowanceCharge()

 <?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>Delivery Terms. Allowance Charge</ccts:DictionaryEntryName><ccts:Definition>An allowance or charge covered by these delivery terms.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Delivery Terms</ccts:ObjectClass><ccts:PropertyTerm>Allowance Charge</ccts:PropertyTerm><ccts:AssociatedObjectClass>Allowance Charge</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Allowance Charge</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is AllowanceChargeType

setAllowanceCharge

public void setAllowanceCharge(@Nullable
                               AllowanceChargeType value)

Sets the value of the allowanceCharge property.

Parameters:

value - allowed object is AllowanceChargeType

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

setSpecialTerms

public void setSpecialTerms(@Nullable
                            List<SpecialTermsType> aList)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

aList - The new list member to set. May be null.

setLossRisk

public void setLossRisk(@Nullable
                        List<LossRiskType> aList)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

aList - The new list member to set. May be null.

hasSpecialTermsEntries

public boolean hasSpecialTermsEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoSpecialTermsEntries

public boolean hasNoSpecialTermsEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if no item is contained, false otherwise.

getSpecialTermsCount

@Nonnegative
public int getSpecialTermsCount()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

The number of contained elements. Always ≥ 0.

getSpecialTermsAtIndex

@Nullable
public SpecialTermsType getSpecialTermsAtIndex(@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 null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addSpecialTerms

public void addSpecialTerms(@Nonnull
                            SpecialTermsType elem)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

elem - The element to be added. May not be null.

hasLossRiskEntries

public boolean hasLossRiskEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoLossRiskEntries

public boolean hasNoLossRiskEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if no item is contained, false otherwise.

getLossRiskCount

@Nonnegative
public int getLossRiskCount()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

The number of contained elements. Always ≥ 0.

getLossRiskAtIndex

@Nullable
public LossRiskType getLossRiskAtIndex(@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 null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addLossRisk

public void addLossRisk(@Nonnull
                        LossRiskType elem)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

elem - The element to be added. May not be null.

cloneTo

public void cloneTo(@Nonnull
                    DeliveryTermsType ret)

This method clones all values from this 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 null.

clone

@Nonnull
 @ReturnsMutableCopy
public DeliveryTermsType 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 null.

setAmount

@Nonnull
public AmountType setAmount(@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 null.

Returns:

The created intermediary object of type AmountType and never null

setLossRiskResponsibilityCode

@Nonnull
public LossRiskResponsibilityCodeType setLossRiskResponsibilityCode(@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 null.

Returns:

The created intermediary object of type LossRiskResponsibilityCodeType and never null

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

Returns:

The created intermediary object of type IDType and never null

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 null

getLossRiskResponsibilityCodeValue

@Nullable
public String getLossRiskResponsibilityCodeValue()

Get the value of the contained LossRiskResponsibilityCodeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained LossRiskResponsibilityCodeType object or null

getAmountValue

@Nullable
public BigDecimal getAmountValue()

Get the value of the contained AmountType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained AmountType object or null