net.finmath.smartcontract.product.xml.RateObservation 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 java.math.BigInteger;
import javax.xml.datatype.XMLGregorianCalendar;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlID;
import jakarta.xml.bind.annotation.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.adapters.CollapsedStringAdapter;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;


/**
 * A type defining parameters associated with an individual observation or
 *                 fixing. This type forms part of the cashflow representation of a stream.
 *             
 * 
 * Java class for RateObservation complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="RateObservation">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <element name="resetDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
 *         <element name="adjustedFixingDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
 *         <element name="observedRate" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
 *         <element name="treatedRate" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
 *         <element name="observationWeight" type="{http://www.w3.org/2001/XMLSchema}positiveInteger"/>
 *         <element name="rateReference" type="{http://www.fpml.org/FpML-5/confirmation}RateReference" minOccurs="0"/>
 *         <element name="forecastRate" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
 *         <element name="treatedForecastRate" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
 *       </sequence>
 *       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "RateObservation", propOrder = {
    "resetDate",
    "adjustedFixingDate",
    "observedRate",
    "treatedRate",
    "observationWeight",
    "rateReference",
    "forecastRate",
    "treatedForecastRate"
})
public class RateObservation {

    @XmlSchemaType(name = "date")
    protected XMLGregorianCalendar resetDate;
    @XmlSchemaType(name = "date")
    protected XMLGregorianCalendar adjustedFixingDate;
    protected BigDecimal observedRate;
    protected BigDecimal treatedRate;
    @XmlElement(required = true)
    @XmlSchemaType(name = "positiveInteger")
    protected BigInteger observationWeight;
    protected RateReference rateReference;
    protected BigDecimal forecastRate;
    protected BigDecimal treatedForecastRate;
    @XmlAttribute(name = "id")
    @XmlJavaTypeAdapter(CollapsedStringAdapter.class)
    @XmlID
    @XmlSchemaType(name = "ID")
    protected String id;

    /**
     * Gets the value of the resetDate property.
     * 
     * @return
     *     possible object is
     *     {@link XMLGregorianCalendar }
     *     
     */
    public XMLGregorianCalendar getResetDate() {
        return resetDate;
    }

    /**
     * Sets the value of the resetDate property.
     * 
     * @param value
     *     allowed object is
     *     {@link XMLGregorianCalendar }
     *     
     */
    public void setResetDate(XMLGregorianCalendar value) {
        this.resetDate = value;
    }

    /**
     * Gets the value of the adjustedFixingDate property.
     * 
     * @return
     *     possible object is
     *     {@link XMLGregorianCalendar }
     *     
     */
    public XMLGregorianCalendar getAdjustedFixingDate() {
        return adjustedFixingDate;
    }

    /**
     * Sets the value of the adjustedFixingDate property.
     * 
     * @param value
     *     allowed object is
     *     {@link XMLGregorianCalendar }
     *     
     */
    public void setAdjustedFixingDate(XMLGregorianCalendar value) {
        this.adjustedFixingDate = value;
    }

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

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

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

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

    /**
     * Gets the value of the observationWeight property.
     * 
     * @return
     *     possible object is
     *     {@link BigInteger }
     *     
     */
    public BigInteger getObservationWeight() {
        return observationWeight;
    }

    /**
     * Sets the value of the observationWeight property.
     * 
     * @param value
     *     allowed object is
     *     {@link BigInteger }
     *     
     */
    public void setObservationWeight(BigInteger value) {
        this.observationWeight = value;
    }

    /**
     * Gets the value of the rateReference property.
     * 
     * @return
     *     possible object is
     *     {@link RateReference }
     *     
     */
    public RateReference getRateReference() {
        return rateReference;
    }

    /**
     * Sets the value of the rateReference property.
     * 
     * @param value
     *     allowed object is
     *     {@link RateReference }
     *     
     */
    public void setRateReference(RateReference value) {
        this.rateReference = value;
    }

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

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

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

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

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

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

}