org.fpml.fpml_5.confirmation.CalculatedAmount Maven / Gradle / Ivy

Go to download
//
// 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 javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlType;


/**
 * An abstract base class for all calculated money amounts, which are in the currency of the cash multiplier of the calculation.
 * 
 * Java class for CalculatedAmount complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="CalculatedAmount">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <element name="calculationDates" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableRelativeOrPeriodicDates" minOccurs="0"/>
 *         <element name="observationStartDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableOrRelativeDate" minOccurs="0"/>
 *         <group ref="{http://www.fpml.org/FpML-5/confirmation}Dividends.model"/>
 *       </sequence>
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "CalculatedAmount", propOrder = {
    "calculationDates",
    "observationStartDate",
    "optionsExchangeDividends",
    "additionalDividends",
    "allDividends"
})
@XmlSeeAlso({
    CorrelationAmount.class,
    VarianceAmount.class,
    VolatilityAmount.class
})
public abstract class CalculatedAmount {

    protected AdjustableRelativeOrPeriodicDates calculationDates;
    protected AdjustableOrRelativeDate observationStartDate;
    protected Boolean optionsExchangeDividends;
    protected Boolean additionalDividends;
    protected Boolean allDividends;

    /**
     * Gets the value of the calculationDates property.
     * 
     * @return
     *     possible object is
     *     {@link AdjustableRelativeOrPeriodicDates }
     *     
     */
    public AdjustableRelativeOrPeriodicDates getCalculationDates() {
        return calculationDates;
    }

    /**
     * Sets the value of the calculationDates property.
     * 
     * @param value
     *     allowed object is
     *     {@link AdjustableRelativeOrPeriodicDates }
     *     
     */
    public void setCalculationDates(AdjustableRelativeOrPeriodicDates value) {
        this.calculationDates = value;
    }

    /**
     * Gets the value of the observationStartDate property.
     * 
     * @return
     *     possible object is
     *     {@link AdjustableOrRelativeDate }
     *     
     */
    public AdjustableOrRelativeDate getObservationStartDate() {
        return observationStartDate;
    }

    /**
     * Sets the value of the observationStartDate property.
     * 
     * @param value
     *     allowed object is
     *     {@link AdjustableOrRelativeDate }
     *     
     */
    public void setObservationStartDate(AdjustableOrRelativeDate value) {
        this.observationStartDate = value;
    }

    /**
     * Gets the value of the optionsExchangeDividends property.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isOptionsExchangeDividends() {
        return optionsExchangeDividends;
    }

    /**
     * Sets the value of the optionsExchangeDividends property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     */
    public void setOptionsExchangeDividends(Boolean value) {
        this.optionsExchangeDividends = value;
    }

    /**
     * Gets the value of the additionalDividends property.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isAdditionalDividends() {
        return additionalDividends;
    }

    /**
     * Sets the value of the additionalDividends property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     */
    public void setAdditionalDividends(Boolean value) {
        this.additionalDividends = value;
    }

    /**
     * Gets the value of the allDividends property.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isAllDividends() {
        return allDividends;
    }

    /**
     * Sets the value of the allDividends property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     */
    public void setAllDividends(Boolean value) {
        this.allDividends = value;
    }

}