net.finmath.smartcontract.product.xml.RelativeDateOffset 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 jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlSeeAlso;
import jakarta.xml.bind.annotation.XmlType;


/**
 * A type defining a date (referred to as the derived date) as a relative
 *                 offset from another date (referred to as the anchor date). If the anchor date is itself an adjustable
 *                 date then the offset is assumed to be calculated from the adjusted anchor date. A number of different
 *                 scenarios can be supported, namely; 1) the derived date may simply be a number of calendar periods
 *                 (days, weeks, months or years) preceding or following the anchor date; 2) the unadjusted derived date
 *                 may be a number of calendar periods (days, weeks, months or years) preceding or following the anchor
 *                 date with the resulting unadjusted derived date subject to adjustment in accordance with a specified
 *                 business day convention, i.e. the derived date must fall on a good business day; 3) the derived date may
 *                 be a number of business days preceding or following the anchor date. Note that the businessDayConvention
 *                 specifies any required adjustment to the unadjusted derived date. A negative or positive value in the
 *                 periodMultiplier indicates whether the unadjusted derived precedes or follows the anchor date. The
 *                 businessDayConvention should contain a value NONE if the day type element contains a value of Business
 *                 (since specifying a negative or positive business days offset would already guarantee that the derived
 *                 date would fall on a good business day in the specified business centers).
 *             
 * 
 * Java class for RelativeDateOffset complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="RelativeDateOffset">
 *   <complexContent>
 *     <extension base="{http://www.fpml.org/FpML-5/confirmation}Offset">
 *       <sequence>
 *         <element name="businessDayConvention" type="{http://www.fpml.org/FpML-5/confirmation}BusinessDayConventionEnum"/>
 *         <group ref="{http://www.fpml.org/FpML-5/confirmation}BusinessCentersOrReference.model" minOccurs="0"/>
 *         <element name="dateRelativeTo" type="{http://www.fpml.org/FpML-5/confirmation}DateReference"/>
 *         <element name="adjustedDate" type="{http://www.fpml.org/FpML-5/confirmation}IdentifiedDate" minOccurs="0"/>
 *       </sequence>
 *     </extension>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "RelativeDateOffset", propOrder = {
    "businessDayConvention",
    "businessCentersReference",
    "businessCenters",
    "dateRelativeTo",
    "adjustedDate"
})
@XmlSeeAlso({
    AdjustedRelativeDateOffset.class,
    RelativeDates.class
})
public class RelativeDateOffset
    extends Offset
{

    @XmlElement(required = true)
    @XmlSchemaType(name = "token")
    protected BusinessDayConventionEnum businessDayConvention;
    protected BusinessCentersReference businessCentersReference;
    protected BusinessCenters businessCenters;
    @XmlElement(required = true)
    protected DateReference dateRelativeTo;
    protected IdentifiedDate adjustedDate;

    /**
     * Gets the value of the businessDayConvention property.
     * 
     * @return
     *     possible object is
     *     {@link BusinessDayConventionEnum }
     *     
     */
    public BusinessDayConventionEnum getBusinessDayConvention() {
        return businessDayConvention;
    }

    /**
     * Sets the value of the businessDayConvention property.
     * 
     * @param value
     *     allowed object is
     *     {@link BusinessDayConventionEnum }
     *     
     */
    public void setBusinessDayConvention(BusinessDayConventionEnum value) {
        this.businessDayConvention = value;
    }

    /**
     * Gets the value of the businessCentersReference property.
     * 
     * @return
     *     possible object is
     *     {@link BusinessCentersReference }
     *     
     */
    public BusinessCentersReference getBusinessCentersReference() {
        return businessCentersReference;
    }

    /**
     * Sets the value of the businessCentersReference property.
     * 
     * @param value
     *     allowed object is
     *     {@link BusinessCentersReference }
     *     
     */
    public void setBusinessCentersReference(BusinessCentersReference value) {
        this.businessCentersReference = value;
    }

    /**
     * Gets the value of the businessCenters property.
     * 
     * @return
     *     possible object is
     *     {@link BusinessCenters }
     *     
     */
    public BusinessCenters getBusinessCenters() {
        return businessCenters;
    }

    /**
     * Sets the value of the businessCenters property.
     * 
     * @param value
     *     allowed object is
     *     {@link BusinessCenters }
     *     
     */
    public void setBusinessCenters(BusinessCenters value) {
        this.businessCenters = value;
    }

    /**
     * Gets the value of the dateRelativeTo property.
     * 
     * @return
     *     possible object is
     *     {@link DateReference }
     *     
     */
    public DateReference getDateRelativeTo() {
        return dateRelativeTo;
    }

    /**
     * Sets the value of the dateRelativeTo property.
     * 
     * @param value
     *     allowed object is
     *     {@link DateReference }
     *     
     */
    public void setDateRelativeTo(DateReference value) {
        this.dateRelativeTo = value;
    }

    /**
     * Gets the value of the adjustedDate property.
     * 
     * @return
     *     possible object is
     *     {@link IdentifiedDate }
     *     
     */
    public IdentifiedDate getAdjustedDate() {
        return adjustedDate;
    }

    /**
     * Sets the value of the adjustedDate property.
     * 
     * @param value
     *     allowed object is
     *     {@link IdentifiedDate }
     *     
     */
    public void setAdjustedDate(IdentifiedDate value) {
        this.adjustedDate = value;
    }

}