Class FxPerformanceSwap
java.lang.Object
net.finmath.smartcontract.product.xml.Product
net.finmath.smartcontract.product.xml.FxPerformanceSwap
Describes an FX volatility and variance swap.
Java class for FxPerformanceSwap complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="FxPerformanceSwap">
<complexContent>
<extension base="{http://www.fpml.org/FpML-5/confirmation}Product">
<sequence>
<element name="quotedCurrencyPair" type="{http://www.fpml.org/FpML-5/confirmation}QuotedCurrencyPair"/>
<element name="vegaNotional" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeMoney"/>
<element name="notional" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeMoney" minOccurs="0"/>
<element name="fixedLeg" type="{http://www.fpml.org/FpML-5/confirmation}FxPerformanceFixedLeg"/>
<element name="floatingLeg" type="{http://www.fpml.org/FpML-5/confirmation}FxPerformanceFloatingLeg"/>
<element name="fixingInformationSource" type="{http://www.fpml.org/FpML-5/confirmation}FxSpotRateSource"/>
<element name="fixingSchedule" type="{http://www.fpml.org/FpML-5/confirmation}FxFixingScheduleSimple"/>
<choice minOccurs="0">
<element name="valuationDate" type="{http://www.w3.org/2001/XMLSchema}date"/>
<element name="valuationDateOffset" type="{http://www.fpml.org/FpML-5/confirmation}FxValuationDateOffset"/>
</choice>
<element name="settlementDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableOrAdjustedDate"/>
<element name="annualizationFactor" type="{http://www.w3.org/2001/XMLSchema}decimal"/>
<element name="meanAdjustment" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
<element name="numberOfReturns" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" minOccurs="0"/>
<element name="additionalPayment" type="{http://www.fpml.org/FpML-5/confirmation}Payment" maxOccurs="unbounded" minOccurs="0"/>
<element name="cashSettlement" type="{http://www.fpml.org/FpML-5/confirmation}FxCashSettlementSimple" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected BigDecimalprotected FxCashSettlementSimpleprotected FxPerformanceFixedLegprotected FxSpotRateSourceprotected FxFixingScheduleSimpleprotected FxPerformanceFloatingLegprotected booleanprotected NonNegativeMoneyprotected BigIntegerprotected QuotedCurrencyPairprotected AdjustableOrAdjustedDateprotected XMLGregorianCalendarprotected FxValuationDateOffsetprotected NonNegativeMoneyFields inherited from class net.finmath.smartcontract.product.xml.Product
assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the additionalPayment property.Gets the value of the annualizationFactor property.Gets the value of the cashSettlement property.Gets the value of the fixedLeg property.Gets the value of the fixingInformationSource property.Gets the value of the fixingSchedule property.Gets the value of the floatingLeg property.Gets the value of the notional property.Gets the value of the numberOfReturns property.Gets the value of the quotedCurrencyPair property.Gets the value of the settlementDate property.Gets the value of the valuationDate property.Gets the value of the valuationDateOffset property.Gets the value of the vegaNotional property.booleanGets the value of the meanAdjustment property.voidsetAnnualizationFactor(BigDecimal value)Sets the value of the annualizationFactor property.voidSets the value of the cashSettlement property.voidsetFixedLeg(FxPerformanceFixedLeg value)Sets the value of the fixedLeg property.voidSets the value of the fixingInformationSource property.voidSets the value of the fixingSchedule property.voidSets the value of the floatingLeg property.voidsetMeanAdjustment(boolean value)Sets the value of the meanAdjustment property.voidsetNotional(NonNegativeMoney value)Sets the value of the notional property.voidsetNumberOfReturns(BigInteger value)Sets the value of the numberOfReturns property.voidSets the value of the quotedCurrencyPair property.voidSets the value of the settlementDate property.voidsetValuationDate(XMLGregorianCalendar value)Sets the value of the valuationDate property.voidSets the value of the valuationDateOffset property.voidsetVegaNotional(NonNegativeMoney value)Sets the value of the vegaNotional property.Methods inherited from class net.finmath.smartcontract.product.xml.Product
getAssetClass, getId, getPrimaryAssetClass, getProductId, getProductType, getSecondaryAssetClass, setId, setPrimaryAssetClass
-
Field Details
-
quotedCurrencyPair
-
vegaNotional
-
notional
-
fixedLeg
-
floatingLeg
-
fixingInformationSource
-
fixingSchedule
-
valuationDate
-
valuationDateOffset
-
settlementDate
-
annualizationFactor
-
meanAdjustment
protected boolean meanAdjustment -
numberOfReturns
-
additionalPayment
-
cashSettlement
-
-
Constructor Details
-
FxPerformanceSwap
public FxPerformanceSwap()
-
-
Method Details
-
getQuotedCurrencyPair
Gets the value of the quotedCurrencyPair property.- Returns:
- possible object is
QuotedCurrencyPair
-
setQuotedCurrencyPair
Sets the value of the quotedCurrencyPair property.- Parameters:
value- allowed object isQuotedCurrencyPair
-
getVegaNotional
Gets the value of the vegaNotional property.- Returns:
- possible object is
NonNegativeMoney
-
setVegaNotional
Sets the value of the vegaNotional property.- Parameters:
value- allowed object isNonNegativeMoney
-
getNotional
Gets the value of the notional property.- Returns:
- possible object is
NonNegativeMoney
-
setNotional
Sets the value of the notional property.- Parameters:
value- allowed object isNonNegativeMoney
-
getFixedLeg
Gets the value of the fixedLeg property.- Returns:
- possible object is
FxPerformanceFixedLeg
-
setFixedLeg
Sets the value of the fixedLeg property.- Parameters:
value- allowed object isFxPerformanceFixedLeg
-
getFloatingLeg
Gets the value of the floatingLeg property.- Returns:
- possible object is
FxPerformanceFloatingLeg
-
setFloatingLeg
Sets the value of the floatingLeg property.- Parameters:
value- allowed object isFxPerformanceFloatingLeg
-
getFixingInformationSource
Gets the value of the fixingInformationSource property.- Returns:
- possible object is
FxSpotRateSource
-
setFixingInformationSource
Sets the value of the fixingInformationSource property.- Parameters:
value- allowed object isFxSpotRateSource
-
getFixingSchedule
Gets the value of the fixingSchedule property.- Returns:
- possible object is
FxFixingScheduleSimple
-
setFixingSchedule
Sets the value of the fixingSchedule property.- Parameters:
value- allowed object isFxFixingScheduleSimple
-
getValuationDate
Gets the value of the valuationDate property.- Returns:
- possible object is
XMLGregorianCalendar
-
setValuationDate
Sets the value of the valuationDate property.- Parameters:
value- allowed object isXMLGregorianCalendar
-
getValuationDateOffset
Gets the value of the valuationDateOffset property.- Returns:
- possible object is
FxValuationDateOffset
-
setValuationDateOffset
Sets the value of the valuationDateOffset property.- Parameters:
value- allowed object isFxValuationDateOffset
-
getSettlementDate
Gets the value of the settlementDate property.- Returns:
- possible object is
AdjustableOrAdjustedDate
-
setSettlementDate
Sets the value of the settlementDate property.- Parameters:
value- allowed object isAdjustableOrAdjustedDate
-
getAnnualizationFactor
Gets the value of the annualizationFactor property.- Returns:
- possible object is
BigDecimal
-
setAnnualizationFactor
Sets the value of the annualizationFactor property.- Parameters:
value- allowed object isBigDecimal
-
isMeanAdjustment
public boolean isMeanAdjustment()Gets the value of the meanAdjustment property. -
setMeanAdjustment
public void setMeanAdjustment(boolean value)Sets the value of the meanAdjustment property. -
getNumberOfReturns
Gets the value of the numberOfReturns property.- Returns:
- possible object is
BigInteger
-
setNumberOfReturns
Sets the value of the numberOfReturns property.- Parameters:
value- allowed object isBigInteger
-
getAdditionalPayment
Gets the value of the additionalPayment 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
setmethod for the additionalPayment property.For example, to add a new item, do as follows:
getAdditionalPayment().add(newItem);Objects of the following type(s) are allowed in the list
Payment -
getCashSettlement
Gets the value of the cashSettlement property.- Returns:
- possible object is
FxCashSettlementSimple
-
setCashSettlement
Sets the value of the cashSettlement property.- Parameters:
value- allowed object isFxCashSettlementSimple
-