FinancialGuaranteeType (ph-ubl22 6.7.0 API)

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

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class FinancialGuaranteeType
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>Financial Guarantee. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe the bond guarantee of a tenderer or bid submitter's actual entry into a contract in the event that it is the successful bidder.</ccts:Definition><ccts:ObjectClass>Financial Guarantee</ccts:ObjectClass></ccts:Component> </pre> Java class for FinancialGuaranteeType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="FinancialGuaranteeType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}GuaranteeTypeCode"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Description" maxOccurs="unbounded" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LiabilityAmount" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}AmountRate" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ConstitutionPeriod" 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

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

Constructors
Constructor and Description
`FinancialGuaranteeType()` 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`	`addDescription(DescriptionType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`FinancialGuaranteeType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(FinancialGuaranteeType 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
`AmountRateType`	`getAmountRate()` <pre> <?
`BigDecimal`	`getAmountRateValue()` Get the value of the contained AmountRateType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`PeriodType`	`getConstitutionPeriod()` <pre> <?
`List<DescriptionType>`	`getDescription()` <pre> <?
`DescriptionType`	`getDescriptionAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getDescriptionCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`GuaranteeTypeCodeType`	`getGuaranteeTypeCode()` <pre> <?
`String`	`getGuaranteeTypeCodeValue()` Get the value of the contained GuaranteeTypeCodeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`LiabilityAmountType`	`getLiabilityAmount()` <pre> <?
`BigDecimal`	`getLiabilityAmountValue()` Get the value of the contained LiabilityAmountType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`boolean`	`hasDescriptionEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasNoDescriptionEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setAmountRate(AmountRateType value)` Sets the value of the amountRate property.
`AmountRateType`	`setAmountRate(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setConstitutionPeriod(PeriodType value)` Sets the value of the constitutionPeriod property.
`void`	`setDescription(List<DescriptionType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setGuaranteeTypeCode(GuaranteeTypeCodeType value)` Sets the value of the guaranteeTypeCode property.
`GuaranteeTypeCodeType`	`setGuaranteeTypeCode(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`LiabilityAmountType`	`setLiabilityAmount(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setLiabilityAmount(LiabilityAmountType value)` Sets the value of the liabilityAmount 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
 - FinancialGuaranteeType
```
public FinancialGuaranteeType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getGuaranteeTypeCode
```
@Nullable
public GuaranteeTypeCodeType getGuaranteeTypeCode()
```
 <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>Financial Guarantee. Guarantee Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the type of financial guarantee. For instance "Provisional Guarantee" or "Final Guarantee"</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Financial Guarantee</ccts:ObjectClass><ccts:PropertyTerm>Guarantee Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is GuaranteeTypeCodeType
 - setGuaranteeTypeCode
```
public void setGuaranteeTypeCode(@Nullable
 GuaranteeTypeCodeType value)
```
 Sets the value of the guaranteeTypeCode property.
 
 Parameters:
 
 value - allowed object is GuaranteeTypeCodeType
 - getDescription
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DescriptionType> getDescription()
```
 <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>Financial Guarantee. Description. Text</ccts:DictionaryEntryName><ccts:Definition>Text describing this financial guarantee.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Financial Guarantee</ccts:ObjectClass><ccts:PropertyTerm>Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component> </pre> Gets the value of the description 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 description property. For example, to add a new item, do as follows: <pre> getDescription().add(newItem); </pre> Objects of the following type(s) are allowed in the list DescriptionType
 - getLiabilityAmount
```
@Nullable
public LiabilityAmountType getLiabilityAmount()
```
 <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>Financial Guarantee. Liability. Amount</ccts:DictionaryEntryName><ccts:Definition>The amount of liability in this financial guarantee.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Financial Guarantee</ccts:ObjectClass><ccts:PropertyTerm>Liability</ccts:PropertyTerm><ccts:RepresentationTerm>Amount</ccts:RepresentationTerm><ccts:DataType>Amount. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is LiabilityAmountType
 - setLiabilityAmount
```
public void setLiabilityAmount(@Nullable
 LiabilityAmountType value)
```
 Sets the value of the liabilityAmount property.
 
 Parameters:
 
 value - allowed object is LiabilityAmountType
 - getAmountRate
```
@Nullable
public AmountRateType getAmountRate()
```
 <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>Financial Guarantee. Amount. Rate</ccts:DictionaryEntryName><ccts:Definition>The rate used to calculate the amount of liability in this financial guarantee.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Financial Guarantee</ccts:ObjectClass><ccts:PropertyTerm>Amount</ccts:PropertyTerm><ccts:RepresentationTerm>Rate</ccts:RepresentationTerm><ccts:DataType>Rate. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is AmountRateType
 - setAmountRate
```
public void setAmountRate(@Nullable
 AmountRateType value)
```
 Sets the value of the amountRate property.
 
 Parameters:
 
 value - allowed object is AmountRateType
 - getConstitutionPeriod
```
@Nullable
public PeriodType getConstitutionPeriod()
```
 <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>Financial Guarantee. Constitution_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>The period during the tendering process to which this financial guarantee has to be settled.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Financial Guarantee</ccts:ObjectClass><ccts:PropertyTermQualifier>Constitution</ccts:PropertyTermQualifier><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is PeriodType
 - setConstitutionPeriod
```
public void setConstitutionPeriod(@Nullable
 PeriodType value)
```
 Sets the value of the constitutionPeriod property.
 
 Parameters:
 
 value - allowed object is PeriodType
 - 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
 - setDescription
```
public void setDescription(@Nullable
 List<DescriptionType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - hasDescriptionEntries
```
public boolean hasDescriptionEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoDescriptionEntries
```
public boolean hasNoDescriptionEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getDescriptionCount
```
@Nonnegative
public int getDescriptionCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getDescriptionAtIndex
```
@Nullable
public DescriptionType getDescriptionAtIndex(@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!
 - addDescription
```
public void addDescription(@Nonnull
 DescriptionType 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
 FinancialGuaranteeType 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 FinancialGuaranteeType 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>.
 - setLiabilityAmount
```
@Nonnull
public LiabilityAmountType setLiabilityAmount(@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 LiabilityAmountType and never <code>null</code>
 - setGuaranteeTypeCode
```
@Nonnull
public GuaranteeTypeCodeType setGuaranteeTypeCode(@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 GuaranteeTypeCodeType and never <code>null</code>
 - setAmountRate
```
@Nonnull
public AmountRateType setAmountRate(@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 AmountRateType and never <code>null</code>
 - getGuaranteeTypeCodeValue
```
@Nullable
public String getGuaranteeTypeCodeValue()
```
 Get the value of the contained GuaranteeTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained GuaranteeTypeCodeType object or <code>null</code>
 - getLiabilityAmountValue
```
@Nullable
public BigDecimal getLiabilityAmountValue()
```
 Get the value of the contained LiabilityAmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained LiabilityAmountType object or <code>null</code>
 - getAmountRateValue
```
@Nullable
public BigDecimal getAmountRateValue()
```
 Get the value of the contained AmountRateType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained AmountRateType object or <code>null</code>

Class FinancialGuaranteeType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FinancialGuaranteeType

Method Detail

getGuaranteeTypeCode

setGuaranteeTypeCode

getDescription

getLiabilityAmount

setLiabilityAmount

getAmountRate

setAmountRate

getConstitutionPeriod

setConstitutionPeriod

equals

hashCode

toString

setDescription

hasDescriptionEntries

hasNoDescriptionEntries

getDescriptionCount

getDescriptionAtIndex

addDescription

cloneTo

clone

setLiabilityAmount

setGuaranteeTypeCode

setAmountRate

getGuaranteeTypeCodeValue

getLiabilityAmountValue

getAmountRateValue