OnAccountPaymentType (ph-ubl22 6.7.0 API)

java.lang.Object
- oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_22.OnAccountPaymentType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class OnAccountPaymentType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
```
<pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>On Account Payment. Details</ccts:DictionaryEntryName><ccts:Definition>A scheduled prepayment (on-account payment) for a estimated utility consumption</ccts:Definition><ccts:ObjectClass>On Account Payment</ccts:ObjectClass></ccts:Component> </pre> Java class for OnAccountPaymentType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="OnAccountPaymentType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}EstimatedConsumedQuantity"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Note" maxOccurs="unbounded" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}PaymentTerms" maxOccurs="unbounded"/> </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

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

Constructors
Constructor and Description
`OnAccountPaymentType()` 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`	`addNote(NoteType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`addPaymentTerms(PaymentTermsType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`OnAccountPaymentType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(OnAccountPaymentType 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
`EstimatedConsumedQuantityType`	`getEstimatedConsumedQuantity()` <pre> <?
`BigDecimal`	`getEstimatedConsumedQuantityValue()` Get the value of the contained EstimatedConsumedQuantityType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`List<NoteType>`	`getNote()` <pre> <?
`NoteType`	`getNoteAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getNoteCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`List<PaymentTermsType>`	`getPaymentTerms()` <pre> <?
`PaymentTermsType`	`getPaymentTermsAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getPaymentTermsCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasNoNoteEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoPaymentTermsEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoteEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasPaymentTermsEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`EstimatedConsumedQuantityType`	`setEstimatedConsumedQuantity(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setEstimatedConsumedQuantity(EstimatedConsumedQuantityType value)` Sets the value of the estimatedConsumedQuantity property.
`void`	`setNote(List<NoteType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setPaymentTerms(List<PaymentTermsType> 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
 - OnAccountPaymentType
```
public OnAccountPaymentType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getEstimatedConsumedQuantity
```
@Nullable
public EstimatedConsumedQuantityType getEstimatedConsumedQuantity()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>On Account Payment. Estimated_ Consumed Quantity. Quantity</ccts:DictionaryEntryName><ccts:Definition>The estimated consumed quantity covered by the payment.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>On Account Payment</ccts:ObjectClass><ccts:PropertyTermQualifier>Estimated</ccts:PropertyTermQualifier><ccts:PropertyTerm>Consumed Quantity</ccts:PropertyTerm><ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm><ccts:DataType>Quantity. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is EstimatedConsumedQuantityType
 - setEstimatedConsumedQuantity
```
public void setEstimatedConsumedQuantity(@Nullable
 EstimatedConsumedQuantityType value)
```
 Sets the value of the estimatedConsumedQuantity property.
 
 Parameters:
 
 value - allowed object is EstimatedConsumedQuantityType
 - getNote
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<NoteType> getNote()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>On Account Payment. Note. Text</ccts:DictionaryEntryName><ccts:Definition>Free-form text conveying information that is not contained explicitly in other structures.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>On Account Payment</ccts:ObjectClass><ccts:PropertyTerm>Note</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>We make a reservation for price regulations. You will receive you next yearly statement about one year from today.</ccts:Examples></ccts:Component> </pre> Gets the value of the note 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 note property. For example, to add a new item, do as follows: <pre> getNote().add(newItem); </pre> Objects of the following type(s) are allowed in the list NoteType
 - getPaymentTerms
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<PaymentTermsType> getPaymentTerms()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>On Account Payment. Payment Terms</ccts:DictionaryEntryName><ccts:Definition>A specification of payment terms associated with this payment.</ccts:Definition><ccts:Cardinality>1..n</ccts:Cardinality><ccts:ObjectClass>On Account Payment</ccts:ObjectClass><ccts:PropertyTerm>Payment Terms</ccts:PropertyTerm><ccts:AssociatedObjectClass>Payment Terms</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Payment Terms</ccts:RepresentationTerm></ccts:Component> </pre> Gets the value of the paymentTerms 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 paymentTerms property. For example, to add a new item, do as follows: <pre> getPaymentTerms().add(newItem); </pre> Objects of the following type(s) are allowed in the list PaymentTermsType
 - 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
 - setNote
```
public void setNote(@Nullable
 List<NoteType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - setPaymentTerms
```
public void setPaymentTerms(@Nullable
 List<PaymentTermsType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - hasNoteEntries
```
public boolean hasNoteEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoNoteEntries
```
public boolean hasNoNoteEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getNoteCount
```
@Nonnegative
public int getNoteCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getNoteAtIndex
```
@Nullable
public NoteType getNoteAtIndex(@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!
 - addNote
```
public void addNote(@Nonnull
 NoteType elem)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 elem - The element to be added. May not be <code>null</code>.
 - hasPaymentTermsEntries
```
public boolean hasPaymentTermsEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoPaymentTermsEntries
```
public boolean hasNoPaymentTermsEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getPaymentTermsCount
```
@Nonnegative
public int getPaymentTermsCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getPaymentTermsAtIndex
```
@Nullable
public PaymentTermsType getPaymentTermsAtIndex(@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!
 - addPaymentTerms
```
public void addPaymentTerms(@Nonnull
 PaymentTermsType 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
 OnAccountPaymentType 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 OnAccountPaymentType 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>.
 - setEstimatedConsumedQuantity
```
@Nonnull
public EstimatedConsumedQuantityType setEstimatedConsumedQuantity(@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 <code>null</code>.
 
 Returns:
 
 The created intermediary object of type EstimatedConsumedQuantityType and never <code>null</code>
 - getEstimatedConsumedQuantityValue
```
@Nullable
public BigDecimal getEstimatedConsumedQuantityValue()
```
 Get the value of the contained EstimatedConsumedQuantityType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained EstimatedConsumedQuantityType object or <code>null</code>

Class OnAccountPaymentType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OnAccountPaymentType

Method Detail

getEstimatedConsumedQuantity

setEstimatedConsumedQuantity

getNote

getPaymentTerms

equals

hashCode

toString

setNote

setPaymentTerms

hasNoteEntries

hasNoNoteEntries

getNoteCount

getNoteAtIndex

addNote

hasPaymentTermsEntries

hasNoPaymentTermsEntries

getPaymentTermsCount

getPaymentTermsAtIndex

addPaymentTerms

cloneTo

clone

setEstimatedConsumedQuantity

getEstimatedConsumedQuantityValue