net.finmath.smartcontract.product.xml.DividendPayout Maven / Gradle / Ivy

Go to download
//
// This file was generated by the Eclipse Implementation of JAXB, v3.0.0 
// See https://eclipse-ee4j.github.io/jaxb-ri 
// Any modifications to this file will be lost upon recompilation of the source schema. 
// Generated on: 2024.12.05 at 10:53:57 AM CET 
//


package net.finmath.smartcontract.product.xml;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlType;


/**
 * A type describing the dividend payout ratio associated with an equity
 *                 underlyer. In certain cases the actual ratio is not known on trade inception, and only general
 *                 conditions are then specified.
 *             
 * 
 * Java class for DividendPayout complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="DividendPayout">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <choice>
 *           <sequence>
 *             <element name="dividendPayoutRatio" type="{http://www.w3.org/2001/XMLSchema}decimal"/>
 *             <element name="dividendPayoutRatioCash" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
 *             <element name="dividendPayoutRatioNonCash" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
 *           </sequence>
 *           <element name="dividendPayoutConditions" type="{http://www.fpml.org/FpML-5/confirmation}String"/>
 *         </choice>
 *         <element name="dividendPayment" type="{http://www.fpml.org/FpML-5/confirmation}PendingPayment" maxOccurs="unbounded" minOccurs="0"/>
 *       </sequence>
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "DividendPayout", propOrder = {
    "dividendPayoutRatio",
    "dividendPayoutRatioCash",
    "dividendPayoutRatioNonCash",
    "dividendPayoutConditions",
    "dividendPayment"
})
public class DividendPayout {

    protected BigDecimal dividendPayoutRatio;
    protected BigDecimal dividendPayoutRatioCash;
    protected BigDecimal dividendPayoutRatioNonCash;
    protected String dividendPayoutConditions;
    protected List dividendPayment;

    /**
     * Gets the value of the dividendPayoutRatio property.
     * 
     * @return
     *     possible object is
     *     {@link BigDecimal }
     *     
     */
    public BigDecimal getDividendPayoutRatio() {
        return dividendPayoutRatio;
    }

    /**
     * Sets the value of the dividendPayoutRatio property.
     * 
     * @param value
     *     allowed object is
     *     {@link BigDecimal }
     *     
     */
    public void setDividendPayoutRatio(BigDecimal value) {
        this.dividendPayoutRatio = value;
    }

    /**
     * Gets the value of the dividendPayoutRatioCash property.
     * 
     * @return
     *     possible object is
     *     {@link BigDecimal }
     *     
     */
    public BigDecimal getDividendPayoutRatioCash() {
        return dividendPayoutRatioCash;
    }

    /**
     * Sets the value of the dividendPayoutRatioCash property.
     * 
     * @param value
     *     allowed object is
     *     {@link BigDecimal }
     *     
     */
    public void setDividendPayoutRatioCash(BigDecimal value) {
        this.dividendPayoutRatioCash = value;
    }

    /**
     * Gets the value of the dividendPayoutRatioNonCash property.
     * 
     * @return
     *     possible object is
     *     {@link BigDecimal }
     *     
     */
    public BigDecimal getDividendPayoutRatioNonCash() {
        return dividendPayoutRatioNonCash;
    }

    /**
     * Sets the value of the dividendPayoutRatioNonCash property.
     * 
     * @param value
     *     allowed object is
     *     {@link BigDecimal }
     *     
     */
    public void setDividendPayoutRatioNonCash(BigDecimal value) {
        this.dividendPayoutRatioNonCash = value;
    }

    /**
     * Gets the value of the dividendPayoutConditions property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getDividendPayoutConditions() {
        return dividendPayoutConditions;
    }

    /**
     * Sets the value of the dividendPayoutConditions property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setDividendPayoutConditions(String value) {
        this.dividendPayoutConditions = value;
    }

    /**
     * Gets the value of the dividendPayment 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 Jakarta XML Binding object.
     * This is why there is not a set method for the dividendPayment property.
     * 
     * 

     * For example, to add a new item, do as follows:
     * 
     *    getDividendPayment().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link PendingPayment }
     * 
     * 
     */
    public List getDividendPayment() {
        if (dividendPayment == null) {
            dividendPayment = new ArrayList();
        }
        return this.dividendPayment;
    }

}