net.finmath.smartcontract.product.xml.CommodityExerciseBasket 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.XmlType;


/**
 * The parameters for defining how the commodity option can be exercised, how
 *                 it is priced and how it is settled.
 *             
 * 
 * Java class for CommodityExerciseBasket complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="CommodityExerciseBasket">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <choice>
 *           <element name="americanExercise" type="{http://www.fpml.org/FpML-5/confirmation}CommodityAmericanExercise"/>
 *           <element name="europeanExercise" type="{http://www.fpml.org/FpML-5/confirmation}CommodityEuropeanExercise"/>
 *         </choice>
 *         <element name="automaticExercise" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
 *         <element name="writtenConfirmation" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
 *         <element name="settlementCurrency" type="{http://www.fpml.org/FpML-5/confirmation}IdentifiedCurrency"/>
 *         <group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityPaymentDates.model"/>
 *       </sequence>
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "CommodityExerciseBasket", propOrder = {
    "americanExercise",
    "europeanExercise",
    "automaticExercise",
    "writtenConfirmation",
    "settlementCurrency",
    "relativePaymentDates",
    "paymentDates",
    "masterAgreementPaymentDates"
})
public class CommodityExerciseBasket {

    protected CommodityAmericanExercise americanExercise;
    protected CommodityEuropeanExercise europeanExercise;
    protected Boolean automaticExercise;
    protected Boolean writtenConfirmation;
    @XmlElement(required = true)
    protected IdentifiedCurrency settlementCurrency;
    protected CommodityRelativePaymentDates relativePaymentDates;
    protected AdjustableDatesOrRelativeDateOffset paymentDates;
    protected Boolean masterAgreementPaymentDates;

    /**
     * Gets the value of the americanExercise property.
     * 
     * @return
     *     possible object is
     *     {@link CommodityAmericanExercise }
     *     
     */
    public CommodityAmericanExercise getAmericanExercise() {
        return americanExercise;
    }

    /**
     * Sets the value of the americanExercise property.
     * 
     * @param value
     *     allowed object is
     *     {@link CommodityAmericanExercise }
     *     
     */
    public void setAmericanExercise(CommodityAmericanExercise value) {
        this.americanExercise = value;
    }

    /**
     * Gets the value of the europeanExercise property.
     * 
     * @return
     *     possible object is
     *     {@link CommodityEuropeanExercise }
     *     
     */
    public CommodityEuropeanExercise getEuropeanExercise() {
        return europeanExercise;
    }

    /**
     * Sets the value of the europeanExercise property.
     * 
     * @param value
     *     allowed object is
     *     {@link CommodityEuropeanExercise }
     *     
     */
    public void setEuropeanExercise(CommodityEuropeanExercise value) {
        this.europeanExercise = value;
    }

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

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

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

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

    /**
     * Gets the value of the settlementCurrency property.
     * 
     * @return
     *     possible object is
     *     {@link IdentifiedCurrency }
     *     
     */
    public IdentifiedCurrency getSettlementCurrency() {
        return settlementCurrency;
    }

    /**
     * Sets the value of the settlementCurrency property.
     * 
     * @param value
     *     allowed object is
     *     {@link IdentifiedCurrency }
     *     
     */
    public void setSettlementCurrency(IdentifiedCurrency value) {
        this.settlementCurrency = value;
    }

    /**
     * Gets the value of the relativePaymentDates property.
     * 
     * @return
     *     possible object is
     *     {@link CommodityRelativePaymentDates }
     *     
     */
    public CommodityRelativePaymentDates getRelativePaymentDates() {
        return relativePaymentDates;
    }

    /**
     * Sets the value of the relativePaymentDates property.
     * 
     * @param value
     *     allowed object is
     *     {@link CommodityRelativePaymentDates }
     *     
     */
    public void setRelativePaymentDates(CommodityRelativePaymentDates value) {
        this.relativePaymentDates = value;
    }

    /**
     * Gets the value of the paymentDates property.
     * 
     * @return
     *     possible object is
     *     {@link AdjustableDatesOrRelativeDateOffset }
     *     
     */
    public AdjustableDatesOrRelativeDateOffset getPaymentDates() {
        return paymentDates;
    }

    /**
     * Sets the value of the paymentDates property.
     * 
     * @param value
     *     allowed object is
     *     {@link AdjustableDatesOrRelativeDateOffset }
     *     
     */
    public void setPaymentDates(AdjustableDatesOrRelativeDateOffset value) {
        this.paymentDates = value;
    }

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

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

}