org.fpml.fpml_5.confirmation.DividendLeg Maven / Gradle / Ivy
//
// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.3.2
// See https://javaee.github.io/jaxb-v2/
// Any modifications to this file will be lost upon recompilation of the source schema.
// Generated on: 2024.05.10 at 03:58:40 PM UTC
//
package org.fpml.fpml_5.confirmation;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
/**
* Floating Payment Leg of a Dividend Swap.
*
* Java class for DividendLeg complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="DividendLeg">
* <complexContent>
* <extension base="{http://www.fpml.org/FpML-5/confirmation}DirectionalLegUnderlyer">
* <sequence>
* <group ref="{http://www.fpml.org/FpML-5/confirmation}DeclaredCashAndCashEquivalentDividendPercentage.model"/>
* <element name="dividendPeriod" type="{http://www.fpml.org/FpML-5/confirmation}DividendPeriodPayment" maxOccurs="unbounded"/>
* <element name="specialDividends" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
* <element name="materialDividend" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "DividendLeg", propOrder = {
"declaredCashDividendPercentage",
"declaredCashEquivalentDividendPercentage",
"dividendPeriod",
"specialDividends",
"materialDividend"
})
public class DividendLeg
extends DirectionalLegUnderlyer
{
protected BigDecimal declaredCashDividendPercentage;
protected BigDecimal declaredCashEquivalentDividendPercentage;
@XmlElement(required = true)
protected List dividendPeriod;
protected Boolean specialDividends;
protected Boolean materialDividend;
/**
* Gets the value of the declaredCashDividendPercentage property.
*
* @return
* possible object is
* {@link BigDecimal }
*
*/
public BigDecimal getDeclaredCashDividendPercentage() {
return declaredCashDividendPercentage;
}
/**
* Sets the value of the declaredCashDividendPercentage property.
*
* @param value
* allowed object is
* {@link BigDecimal }
*
*/
public void setDeclaredCashDividendPercentage(BigDecimal value) {
this.declaredCashDividendPercentage = value;
}
/**
* Gets the value of the declaredCashEquivalentDividendPercentage property.
*
* @return
* possible object is
* {@link BigDecimal }
*
*/
public BigDecimal getDeclaredCashEquivalentDividendPercentage() {
return declaredCashEquivalentDividendPercentage;
}
/**
* Sets the value of the declaredCashEquivalentDividendPercentage property.
*
* @param value
* allowed object is
* {@link BigDecimal }
*
*/
public void setDeclaredCashEquivalentDividendPercentage(BigDecimal value) {
this.declaredCashEquivalentDividendPercentage = value;
}
/**
* Gets the value of the dividendPeriod 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 dividendPeriod property.
*
*
* For example, to add a new item, do as follows:
*
* getDividendPeriod().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link DividendPeriodPayment }
*
*
*/
public List getDividendPeriod() {
if (dividendPeriod == null) {
dividendPeriod = new ArrayList();
}
return this.dividendPeriod;
}
/**
* Gets the value of the specialDividends property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isSpecialDividends() {
return specialDividends;
}
/**
* Sets the value of the specialDividends property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setSpecialDividends(Boolean value) {
this.specialDividends = value;
}
/**
* Gets the value of the materialDividend property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isMaterialDividend() {
return materialDividend;
}
/**
* Sets the value of the materialDividend property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setMaterialDividend(Boolean value) {
this.materialDividend = value;
}
}