AdvancePaymentType (ph-cii-d16b 2.5.0 API)

java.lang.Object
- un.unece.uncefact.data.standard.reusableaggregatebusinessinformationentity._100.AdvancePaymentType

All Implemented Interfaces:: com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

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

Java class for AdvancePaymentType complex type.

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

 <complexType name="AdvancePaymentType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="PaidAmount" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}AmountType"/>
         <element name="FormattedReceivedDateTime" type="{urn:un:unece:uncefact:data:standard:QualifiedDataType:100}FormattedDateTimeType" minOccurs="0"/>
         <element name="IncludedTradeTax" type="{urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100}TradeTaxType" maxOccurs="unbounded" 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

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

Constructors
Constructor and Description
`AdvancePaymentType()` Default constructor 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`	`addIncludedTradeTax(TradeTaxType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`AdvancePaymentType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(AdvancePaymentType ret)` This method clones all values from `this` to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`FormattedDateTimeType`	`getFormattedReceivedDateTime()` Gets the value of the formattedReceivedDateTime property.
`List<TradeTaxType>`	`getIncludedTradeTax()` Gets the value of the includedTradeTax property.
`TradeTaxType`	`getIncludedTradeTaxAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getIncludedTradeTaxCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`AmountType`	`getPaidAmount()` Gets the value of the paidAmount property.
`BigDecimal`	`getPaidAmountValue()` Get the value of the contained AmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasIncludedTradeTaxEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoIncludedTradeTaxEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setFormattedReceivedDateTime(FormattedDateTimeType value)` Sets the value of the formattedReceivedDateTime property.
`void`	`setIncludedTradeTax(List<TradeTaxType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setPaidAmount(AmountType value)` Sets the value of the paidAmount property.
`AmountType`	`setPaidAmount(BigDecimal valueParam)` Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`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
  - AdvancePaymentType
```
public AdvancePaymentType()
```
    Default constructor
    Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
  - getPaidAmount
```
@Nullable
public AmountType getPaidAmount()
```
    Gets the value of the paidAmount property.
    
    Returns:
    
    possible object is AmountType
  - setPaidAmount
```
public void setPaidAmount(@Nullable
                          AmountType value)
```
    Sets the value of the paidAmount property.
    
    Parameters:
    
    value - allowed object is AmountType
  - getFormattedReceivedDateTime
```
@Nullable
public FormattedDateTimeType getFormattedReceivedDateTime()
```
    Gets the value of the formattedReceivedDateTime property.
    
    Returns:
    
    possible object is FormattedDateTimeType
  - setFormattedReceivedDateTime
```
public void setFormattedReceivedDateTime(@Nullable
                                         FormattedDateTimeType value)
```
    Sets the value of the formattedReceivedDateTime property.
    
    Parameters:
    
    value - allowed object is FormattedDateTimeType
  - getIncludedTradeTax
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<TradeTaxType> getIncludedTradeTax()
```
    Gets the value of the includedTradeTax 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 includedTradeTax property.
    For example, to add a new item, do as follows:
```
    getIncludedTradeTax().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list TradeTaxType
  - 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
  - setIncludedTradeTax
```
public void setIncludedTradeTax(@Nullable
                                List<TradeTaxType> aList)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    aList - The new list member to set. May be null.
  - hasIncludedTradeTaxEntries
```
public boolean hasIncludedTradeTaxEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if at least one item is contained, false otherwise.
  - hasNoIncludedTradeTaxEntries
```
public boolean hasNoIncludedTradeTaxEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if no item is contained, false otherwise.
  - getIncludedTradeTaxCount
```
@Nonnegative
public int getIncludedTradeTaxCount()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    The number of contained elements. Always ≥ 0.
  - getIncludedTradeTaxAtIndex
```
@Nullable
public TradeTaxType getIncludedTradeTaxAtIndex(@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!
  - addIncludedTradeTax
```
public void addIncludedTradeTax(@Nonnull
                                TradeTaxType 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
                    AdvancePaymentType 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 AdvancePaymentType 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.
  - setPaidAmount
```
@Nonnull
public AmountType setPaidAmount(@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
  - getPaidAmountValue
```
@Nullable
public BigDecimal getPaidAmountValue()
```
    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

Class AdvancePaymentType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdvancePaymentType

Method Detail

getPaidAmount

setPaidAmount

getFormattedReceivedDateTime

setFormattedReceivedDateTime

getIncludedTradeTax

equals

hashCode

toString

setIncludedTradeTax

hasIncludedTradeTaxEntries

hasNoIncludedTradeTaxEntries

getIncludedTradeTaxCount

getIncludedTradeTaxAtIndex

addIncludedTradeTax

cloneTo

clone

setPaidAmount

getPaidAmountValue