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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of finmath-smart-derivative-contract Show documentation

Project to support the implementation a of smart derivative contract.

There is a newer version: 1.0.6

Show newest version

//
// 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 jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;


/**
 * A time bounded dividend period, with an expected dividend for each
 *                 period.
 *             
 * 
 * Java class for DividendPeriodDividend complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="DividendPeriodDividend">
 *   <complexContent>
 *     <extension base="{http://www.fpml.org/FpML-5/confirmation}DividendPeriod">
 *       <sequence>
 *         <element name="dividend" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeMoney"/>
 *         <element name="multiplier" type="{http://www.fpml.org/FpML-5/confirmation}PositiveDecimal"/>
 *       </sequence>
 *     </extension>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "DividendPeriodDividend", propOrder = {
    "dividend",
    "multiplier"
})
public class DividendPeriodDividend
    extends DividendPeriod
{

    @XmlElement(required = true)
    protected NonNegativeMoney dividend;
    @XmlElement(required = true)
    protected BigDecimal multiplier;

    /**
     * Gets the value of the dividend property.
     * 
     * @return
     *     possible object is
     *     {@link NonNegativeMoney }
     *     
     */
    public NonNegativeMoney getDividend() {
        return dividend;
    }

    /**
     * Sets the value of the dividend property.
     * 
     * @param value
     *     allowed object is
     *     {@link NonNegativeMoney }
     *     
     */
    public void setDividend(NonNegativeMoney value) {
        this.dividend = value;
    }

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

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

}