un.unece.uncefact.data.standard.reusableaggregatebusinessinformationentity._100

Class TradeAllowanceChargeType

java.lang.Object

un.unece.uncefact.data.standard.reusableaggregatebusinessinformationentity._100.TradeAllowanceChargeType

All Implemented Interfaces:

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

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

Java class for TradeAllowanceChargeType complex type.

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

 <complexType name="TradeAllowanceChargeType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="ChargeIndicator" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}IndicatorType" minOccurs="0"/>
         <element name="ID" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}IDType" minOccurs="0"/>
         <element name="SequenceNumeric" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}NumericType" minOccurs="0"/>
         <element name="CalculationPercent" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}PercentType" minOccurs="0"/>
         <element name="BasisAmount" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}AmountType" minOccurs="0"/>
         <element name="BasisQuantity" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}QuantityType" minOccurs="0"/>
         <element name="PrepaidIndicator" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}IndicatorType" minOccurs="0"/>
         <element name="ActualAmount" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}AmountType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="UnitBasisAmount" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}AmountType" minOccurs="0"/>
         <element name="ReasonCode" type="{urn:un:unece:uncefact:data:standard:QualifiedDataType:100}AllowanceChargeReasonCodeType" minOccurs="0"/>
         <element name="Reason" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}TextType" minOccurs="0"/>
         <element name="TypeCode" type="{urn:un:unece:uncefact:data:standard:QualifiedDataType:100}AllowanceChargeIdentificationCodeType" minOccurs="0"/>
         <element name="CategoryTradeTax" type="{urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100}TradeTaxType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ActualTradeCurrencyExchange" type="{urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100}TradeCurrencyExchangeType" 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
TradeAllowanceChargeType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addActualAmount(AmountType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addCategoryTradeTax(TradeTaxType elem) Created by ph-jaxb22-plugin -Xph-list-extension
TradeAllowanceChargeType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(TradeAllowanceChargeType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<AmountType>	getActualAmount() Gets the value of the actualAmount property.
AmountType	getActualAmountAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getActualAmountCount() Created by ph-jaxb22-plugin -Xph-list-extension
TradeCurrencyExchangeType	getActualTradeCurrencyExchange() Gets the value of the actualTradeCurrencyExchange property.
AmountType	getBasisAmount() Gets the value of the basisAmount property.
BigDecimal	getBasisAmountValue() Get the value of the contained AmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
QuantityType	getBasisQuantity() Gets the value of the basisQuantity property.
BigDecimal	getBasisQuantityValue() Get the value of the contained QuantityType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
PercentType	getCalculationPercent() Gets the value of the calculationPercent property.
BigDecimal	getCalculationPercentValue() Get the value of the contained PercentType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<TradeTaxType>	getCategoryTradeTax() Gets the value of the categoryTradeTax property.
TradeTaxType	getCategoryTradeTaxAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getCategoryTradeTaxCount() Created by ph-jaxb22-plugin -Xph-list-extension
IndicatorType	getChargeIndicator() Gets the value of the chargeIndicator property.
IDType	getID() Gets the value of the id property.
String	getIDValue() Get the value of the contained IDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
IndicatorType	getPrepaidIndicator() Gets the value of the prepaidIndicator property.
TextType	getReason() Gets the value of the reason property.
AllowanceChargeReasonCodeType	getReasonCode() Gets the value of the reasonCode property.
String	getReasonCodeValue() Get the value of the contained AllowanceChargeReasonCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
String	getReasonValue() Get the value of the contained TextType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
NumericType	getSequenceNumeric() Gets the value of the sequenceNumeric property.
BigDecimal	getSequenceNumericValue() Get the value of the contained NumericType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
AllowanceChargeIdentificationCodeType	getTypeCode() Gets the value of the typeCode property.
String	getTypeCodeValue() Get the value of the contained AllowanceChargeIdentificationCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
AmountType	getUnitBasisAmount() Gets the value of the unitBasisAmount property.
BigDecimal	getUnitBasisAmountValue() Get the value of the contained AmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
boolean	hasActualAmountEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasCategoryTradeTaxEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoActualAmountEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoCategoryTradeTaxEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setActualAmount(List<AmountType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setActualTradeCurrencyExchange(TradeCurrencyExchangeType value) Sets the value of the actualTradeCurrencyExchange property.
void	setBasisAmount(AmountType value) Sets the value of the basisAmount property.
AmountType	setBasisAmount(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
QuantityType	setBasisQuantity(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setBasisQuantity(QuantityType value) Sets the value of the basisQuantity property.
PercentType	setCalculationPercent(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setCalculationPercent(PercentType value) Sets the value of the calculationPercent property.
void	setCategoryTradeTax(List<TradeTaxType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setChargeIndicator(IndicatorType value) Sets the value of the chargeIndicator 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	setPrepaidIndicator(IndicatorType value) Sets the value of the prepaidIndicator property.
TextType	setReason(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setReason(TextType value) Sets the value of the reason property.
void	setReasonCode(AllowanceChargeReasonCodeType value) Sets the value of the reasonCode property.
AllowanceChargeReasonCodeType	setReasonCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
NumericType	setSequenceNumeric(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setSequenceNumeric(NumericType value) Sets the value of the sequenceNumeric property.
void	setTypeCode(AllowanceChargeIdentificationCodeType value) Sets the value of the typeCode property.
AllowanceChargeIdentificationCodeType	setTypeCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setUnitBasisAmount(AmountType value) Sets the value of the unitBasisAmount property.
AmountType	setUnitBasisAmount(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

TradeAllowanceChargeType

public TradeAllowanceChargeType()

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

Method Detail

getChargeIndicator

@Nullable
public IndicatorType getChargeIndicator()

Gets the value of the chargeIndicator property.

Returns:

possible object is IndicatorType

setChargeIndicator

public void setChargeIndicator(@Nullable
                               IndicatorType value)

Sets the value of the chargeIndicator property.

Parameters:

value - allowed object is IndicatorType

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

getSequenceNumeric

@Nullable
public NumericType getSequenceNumeric()

Gets the value of the sequenceNumeric property.

Returns:

possible object is NumericType

setSequenceNumeric

public void setSequenceNumeric(@Nullable
                               NumericType value)

Sets the value of the sequenceNumeric property.

Parameters:

value - allowed object is NumericType

getCalculationPercent

@Nullable
public PercentType getCalculationPercent()

Gets the value of the calculationPercent property.

Returns:

possible object is PercentType

setCalculationPercent

public void setCalculationPercent(@Nullable
                                  PercentType value)

Sets the value of the calculationPercent property.

Parameters:

value - allowed object is PercentType

getBasisAmount

@Nullable
public AmountType getBasisAmount()

Gets the value of the basisAmount property.

Returns:

possible object is AmountType

setBasisAmount

public void setBasisAmount(@Nullable
                           AmountType value)

Sets the value of the basisAmount property.

Parameters:

value - allowed object is AmountType

getBasisQuantity

@Nullable
public QuantityType getBasisQuantity()

Gets the value of the basisQuantity property.

Returns:

possible object is QuantityType

setBasisQuantity

public void setBasisQuantity(@Nullable
                             QuantityType value)

Sets the value of the basisQuantity property.

Parameters:

value - allowed object is QuantityType

getPrepaidIndicator

@Nullable
public IndicatorType getPrepaidIndicator()

Gets the value of the prepaidIndicator property.

Returns:

possible object is IndicatorType

setPrepaidIndicator

public void setPrepaidIndicator(@Nullable
                                IndicatorType value)

Sets the value of the prepaidIndicator property.

Parameters:

value - allowed object is IndicatorType

getActualAmount

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<AmountType> getActualAmount()

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

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

    getActualAmount().add(newItem);
 

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

getUnitBasisAmount

@Nullable
public AmountType getUnitBasisAmount()

Gets the value of the unitBasisAmount property.

Returns:

possible object is AmountType

setUnitBasisAmount

public void setUnitBasisAmount(@Nullable
                               AmountType value)

Sets the value of the unitBasisAmount property.

Parameters:

value - allowed object is AmountType

getReasonCode

@Nullable
public AllowanceChargeReasonCodeType getReasonCode()

Gets the value of the reasonCode property.

Returns:

possible object is AllowanceChargeReasonCodeType

setReasonCode

public void setReasonCode(@Nullable
                          AllowanceChargeReasonCodeType value)

Sets the value of the reasonCode property.

Parameters:

value - allowed object is AllowanceChargeReasonCodeType

getReason

@Nullable
public TextType getReason()

Gets the value of the reason property.

Returns:

possible object is TextType

setReason

public void setReason(@Nullable
                      TextType value)

Sets the value of the reason property.

Parameters:

value - allowed object is TextType

getTypeCode

@Nullable
public AllowanceChargeIdentificationCodeType getTypeCode()

Gets the value of the typeCode property.

Returns:

possible object is AllowanceChargeIdentificationCodeType

setTypeCode

public void setTypeCode(@Nullable
                        AllowanceChargeIdentificationCodeType value)

Sets the value of the typeCode property.

Parameters:

value - allowed object is AllowanceChargeIdentificationCodeType

getCategoryTradeTax

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<TradeTaxType> getCategoryTradeTax()

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

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

    getCategoryTradeTax().add(newItem);
 

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

getActualTradeCurrencyExchange

@Nullable
public TradeCurrencyExchangeType getActualTradeCurrencyExchange()

Gets the value of the actualTradeCurrencyExchange property.

Returns:

possible object is TradeCurrencyExchangeType

setActualTradeCurrencyExchange

public void setActualTradeCurrencyExchange(@Nullable
                                           TradeCurrencyExchangeType value)

Sets the value of the actualTradeCurrencyExchange property.

Parameters:

value - allowed object is TradeCurrencyExchangeType

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

setActualAmount

public void setActualAmount(@Nullable
                            List<AmountType> aList)

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

Parameters:

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

setCategoryTradeTax

public void setCategoryTradeTax(@Nullable
                                List<TradeTaxType> aList)

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

Parameters:

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

hasActualAmountEntries

public boolean hasActualAmountEntries()

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

Returns:

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

hasNoActualAmountEntries

public boolean hasNoActualAmountEntries()

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

Returns:

true if no item is contained, false otherwise.

getActualAmountCount

@Nonnegative
public int getActualAmountCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getActualAmountAtIndex

@Nullable
public AmountType getActualAmountAtIndex(@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!

addActualAmount

public void addActualAmount(@Nonnull
                            AmountType elem)

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

Parameters:

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

hasCategoryTradeTaxEntries

public boolean hasCategoryTradeTaxEntries()

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

Returns:

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

hasNoCategoryTradeTaxEntries

public boolean hasNoCategoryTradeTaxEntries()

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

Returns:

true if no item is contained, false otherwise.

getCategoryTradeTaxCount

@Nonnegative
public int getCategoryTradeTaxCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getCategoryTradeTaxAtIndex

@Nullable
public TradeTaxType getCategoryTradeTaxAtIndex(@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!

addCategoryTradeTax

public void addCategoryTradeTax(@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
                    TradeAllowanceChargeType 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 TradeAllowanceChargeType 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.

setTypeCode

@Nonnull
public AllowanceChargeIdentificationCodeType setTypeCode(@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 AllowanceChargeIdentificationCodeType and never null

setReasonCode

@Nonnull
public AllowanceChargeReasonCodeType setReasonCode(@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 AllowanceChargeReasonCodeType and never null

setBasisAmount

@Nonnull
public AmountType setBasisAmount(@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

setUnitBasisAmount

@Nonnull
public AmountType setUnitBasisAmount(@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

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

setSequenceNumeric

@Nonnull
public NumericType setSequenceNumeric(@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 NumericType and never null

setCalculationPercent

@Nonnull
public PercentType setCalculationPercent(@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 PercentType and never null

setBasisQuantity

@Nonnull
public QuantityType setBasisQuantity(@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 QuantityType and never null

setReason

@Nonnull
public TextType setReason(@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 TextType 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

getSequenceNumericValue

@Nullable
public BigDecimal getSequenceNumericValue()

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

Returns:

Either the value of the contained NumericType object or null

getCalculationPercentValue

@Nullable
public BigDecimal getCalculationPercentValue()

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

Returns:

Either the value of the contained PercentType object or null

getBasisAmountValue

@Nullable
public BigDecimal getBasisAmountValue()

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

getBasisQuantityValue

@Nullable
public BigDecimal getBasisQuantityValue()

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

Returns:

Either the value of the contained QuantityType object or null

getUnitBasisAmountValue

@Nullable
public BigDecimal getUnitBasisAmountValue()

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

getReasonCodeValue

@Nullable
public String getReasonCodeValue()

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

Returns:

Either the value of the contained AllowanceChargeReasonCodeType object or null

getReasonValue

@Nullable
public String getReasonValue()

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

Returns:

Either the value of the contained TextType object or null

getTypeCodeValue

@Nullable
public String getTypeCodeValue()

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

Returns:

Either the value of the contained AllowanceChargeIdentificationCodeType object or null