net.finmath.smartcontract.product.xml.Swaption Maven / Gradle / Ivy
Show all versions of finmath-smart-derivative-contract Show documentation
//
// 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.util.ArrayList;
import java.util.List;
import jakarta.xml.bind.JAXBElement;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlElementRef;
import jakarta.xml.bind.annotation.XmlType;
/**
* A type to define an option on a swap.
*
* Java class for Swaption complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="Swaption">
* <complexContent>
* <extension base="{http://www.fpml.org/FpML-5/confirmation}Product">
* <sequence>
* <group ref="{http://www.fpml.org/FpML-5/confirmation}BuyerSeller.model"/>
* <element name="premium" type="{http://www.fpml.org/FpML-5/confirmation}Payment" maxOccurs="unbounded" minOccurs="0"/>
* <element ref="{http://www.fpml.org/FpML-5/confirmation}exercise"/>
* <element name="exerciseProcedure" type="{http://www.fpml.org/FpML-5/confirmation}ExerciseProcedure" minOccurs="0"/>
* <element name="calculationAgent" type="{http://www.fpml.org/FpML-5/confirmation}CalculationAgent" minOccurs="0"/>
* <choice minOccurs="0">
* <element name="cashSettlement" type="{http://www.fpml.org/FpML-5/confirmation}CashSettlement"/>
* <element name="physicalSettlement" type="{http://www.fpml.org/FpML-5/confirmation}SwaptionPhysicalSettlement"/>
* </choice>
* <element name="swaptionStraddle" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
* <element name="swaptionAdjustedDates" type="{http://www.fpml.org/FpML-5/confirmation}SwaptionAdjustedDates" minOccurs="0"/>
* <element name="swap" type="{http://www.fpml.org/FpML-5/confirmation}Swap"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Swaption", propOrder = {
"buyerPartyReference",
"buyerAccountReference",
"sellerPartyReference",
"sellerAccountReference",
"premium",
"exercise",
"exerciseProcedure",
"calculationAgent",
"cashSettlement",
"physicalSettlement",
"swaptionStraddle",
"swaptionAdjustedDates",
"swap"
})
public class Swaption
extends Product
{
@XmlElement(required = true)
protected PartyReference buyerPartyReference;
protected AccountReference buyerAccountReference;
@XmlElement(required = true)
protected PartyReference sellerPartyReference;
protected AccountReference sellerAccountReference;
protected List premium;
@XmlElementRef(name = "exercise", namespace = "http://www.fpml.org/FpML-5/confirmation", type = JAXBElement.class)
protected JAXBElement exercise;
protected ExerciseProcedure exerciseProcedure;
protected CalculationAgent calculationAgent;
protected CashSettlement cashSettlement;
protected SwaptionPhysicalSettlement physicalSettlement;
protected boolean swaptionStraddle;
protected SwaptionAdjustedDates swaptionAdjustedDates;
@XmlElement(required = true)
protected Swap swap;
/**
* Gets the value of the buyerPartyReference property.
*
* @return
* possible object is
* {@link PartyReference }
*
*/
public PartyReference getBuyerPartyReference() {
return buyerPartyReference;
}
/**
* Sets the value of the buyerPartyReference property.
*
* @param value
* allowed object is
* {@link PartyReference }
*
*/
public void setBuyerPartyReference(PartyReference value) {
this.buyerPartyReference = value;
}
/**
* Gets the value of the buyerAccountReference property.
*
* @return
* possible object is
* {@link AccountReference }
*
*/
public AccountReference getBuyerAccountReference() {
return buyerAccountReference;
}
/**
* Sets the value of the buyerAccountReference property.
*
* @param value
* allowed object is
* {@link AccountReference }
*
*/
public void setBuyerAccountReference(AccountReference value) {
this.buyerAccountReference = value;
}
/**
* Gets the value of the sellerPartyReference property.
*
* @return
* possible object is
* {@link PartyReference }
*
*/
public PartyReference getSellerPartyReference() {
return sellerPartyReference;
}
/**
* Sets the value of the sellerPartyReference property.
*
* @param value
* allowed object is
* {@link PartyReference }
*
*/
public void setSellerPartyReference(PartyReference value) {
this.sellerPartyReference = value;
}
/**
* Gets the value of the sellerAccountReference property.
*
* @return
* possible object is
* {@link AccountReference }
*
*/
public AccountReference getSellerAccountReference() {
return sellerAccountReference;
}
/**
* Sets the value of the sellerAccountReference property.
*
* @param value
* allowed object is
* {@link AccountReference }
*
*/
public void setSellerAccountReference(AccountReference value) {
this.sellerAccountReference = value;
}
/**
* Gets the value of the premium property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the Jakarta XML Binding object.
* This is why there is not a set method for the premium property.
*
*
* For example, to add a new item, do as follows:
*
* getPremium().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Payment }
*
*
*/
public List getPremium() {
if (premium == null) {
premium = new ArrayList();
}
return this.premium;
}
/**
* Gets the value of the exercise property.
*
* @return
* possible object is
* {@link JAXBElement }{@code <}{@link BermudaExercise }{@code >}
* {@link JAXBElement }{@code <}{@link EuropeanExercise }{@code >}
* {@link JAXBElement }{@code <}{@link AmericanExercise }{@code >}
* {@link JAXBElement }{@code <}{@link Exercise }{@code >}
*
*/
public JAXBElement getExercise() {
return exercise;
}
/**
* Sets the value of the exercise property.
*
* @param value
* allowed object is
* {@link JAXBElement }{@code <}{@link BermudaExercise }{@code >}
* {@link JAXBElement }{@code <}{@link EuropeanExercise }{@code >}
* {@link JAXBElement }{@code <}{@link AmericanExercise }{@code >}
* {@link JAXBElement }{@code <}{@link Exercise }{@code >}
*
*/
public void setExercise(JAXBElement value) {
this.exercise = value;
}
/**
* Gets the value of the exerciseProcedure property.
*
* @return
* possible object is
* {@link ExerciseProcedure }
*
*/
public ExerciseProcedure getExerciseProcedure() {
return exerciseProcedure;
}
/**
* Sets the value of the exerciseProcedure property.
*
* @param value
* allowed object is
* {@link ExerciseProcedure }
*
*/
public void setExerciseProcedure(ExerciseProcedure value) {
this.exerciseProcedure = value;
}
/**
* Gets the value of the calculationAgent property.
*
* @return
* possible object is
* {@link CalculationAgent }
*
*/
public CalculationAgent getCalculationAgent() {
return calculationAgent;
}
/**
* Sets the value of the calculationAgent property.
*
* @param value
* allowed object is
* {@link CalculationAgent }
*
*/
public void setCalculationAgent(CalculationAgent value) {
this.calculationAgent = value;
}
/**
* Gets the value of the cashSettlement property.
*
* @return
* possible object is
* {@link CashSettlement }
*
*/
public CashSettlement getCashSettlement() {
return cashSettlement;
}
/**
* Sets the value of the cashSettlement property.
*
* @param value
* allowed object is
* {@link CashSettlement }
*
*/
public void setCashSettlement(CashSettlement value) {
this.cashSettlement = value;
}
/**
* Gets the value of the physicalSettlement property.
*
* @return
* possible object is
* {@link SwaptionPhysicalSettlement }
*
*/
public SwaptionPhysicalSettlement getPhysicalSettlement() {
return physicalSettlement;
}
/**
* Sets the value of the physicalSettlement property.
*
* @param value
* allowed object is
* {@link SwaptionPhysicalSettlement }
*
*/
public void setPhysicalSettlement(SwaptionPhysicalSettlement value) {
this.physicalSettlement = value;
}
/**
* Gets the value of the swaptionStraddle property.
*
*/
public boolean isSwaptionStraddle() {
return swaptionStraddle;
}
/**
* Sets the value of the swaptionStraddle property.
*
*/
public void setSwaptionStraddle(boolean value) {
this.swaptionStraddle = value;
}
/**
* Gets the value of the swaptionAdjustedDates property.
*
* @return
* possible object is
* {@link SwaptionAdjustedDates }
*
*/
public SwaptionAdjustedDates getSwaptionAdjustedDates() {
return swaptionAdjustedDates;
}
/**
* Sets the value of the swaptionAdjustedDates property.
*
* @param value
* allowed object is
* {@link SwaptionAdjustedDates }
*
*/
public void setSwaptionAdjustedDates(SwaptionAdjustedDates value) {
this.swaptionAdjustedDates = value;
}
/**
* Gets the value of the swap property.
*
* @return
* possible object is
* {@link Swap }
*
*/
public Swap getSwap() {
return swap;
}
/**
* Sets the value of the swap property.
*
* @param value
* allowed object is
* {@link Swap }
*
*/
public void setSwap(Swap value) {
this.swap = value;
}
}