Package net.finmath.smartcontract.product.xml

Class FxTargetKnockoutForward

java.lang.Object

net.finmath.smartcontract.product.xml.Product

net.finmath.smartcontract.product.xml.FxTargetKnockoutForward

public class FxTargetKnockoutForward
extends Product

A structured forward product which consists of a strip of forwards. Each forward may be settled as an exchange of currencies or cash settled. At each settlement, the amount of gain that one party achieves is measured. The product has a target level of gain. Once the accumulated gain exceeds the target level, the product terminates and there are no further settlements.

Java class for FxTargetKnockoutForward complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="FxTargetKnockoutForward">
   <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="notionalAmount" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeAmountSchedule"/>
         <element name="target" type="{http://www.fpml.org/FpML-5/confirmation}FxTarget" maxOccurs="2"/>
         <element name="expirySchedule" type="{http://www.fpml.org/FpML-5/confirmation}FxExpirySchedule"/>
         <element name="settlementSchedule" type="{http://www.fpml.org/FpML-5/confirmation}FxSettlementSchedule"/>
         <element name="fixingInformationSource" type="{http://www.fpml.org/FpML-5/confirmation}FxInformationSource"/>
         <element name="spotRate" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeDecimal" minOccurs="0"/>
         <sequence>
           <sequence minOccurs="0">
             <element name="pivot" type="{http://www.fpml.org/FpML-5/confirmation}FxPivot"/>
             <element name="constantPayoffRegion" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetConstantPayoffRegion" maxOccurs="unbounded" minOccurs="0"/>
             <element name="linearPayoffRegion" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetLinearPayoffRegion"/>
           </sequence>
           <sequence>
             <element name="constantPayoffRegion" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetConstantPayoffRegion" maxOccurs="unbounded" minOccurs="0"/>
             <element name="linearPayoffRegion" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetLinearPayoffRegion"/>
           </sequence>
           <choice maxOccurs="unbounded" minOccurs="0">
             <element name="constantPayoffRegion" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetConstantPayoffRegion"/>
             <element name="linearPayoffRegion" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetLinearPayoffRegion"/>
           </choice>
         </sequence>
         <element name="barrier" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetBarrier" maxOccurs="unbounded" minOccurs="0"/>
         <element name="additionalPayment" type="{http://www.fpml.org/FpML-5/confirmation}SimplePayment" maxOccurs="unbounded" minOccurs="0"/>
         <element name="cashSettlement" type="{http://www.fpml.org/FpML-5/confirmation}FxCashSettlementSimple" minOccurs="0"/>
         <element name="settlementPeriodSchedule" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetSettlementPeriodSchedule" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<jakarta.xml.bind.JAXBElement<?>>	rest

Fields inherited from class net.finmath.smartcontract.product.xml.Product

assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass

Constructor Summary

Constructors

Constructor	Description
FxTargetKnockoutForward()

Method Summary

Modifier and Type	Method	Description
List<jakarta.xml.bind.JAXBElement<?>>	getRest()	Gets the rest of the content model.

Methods inherited from class net.finmath.smartcontract.product.xml.Product

getAssetClass, getId, getPrimaryAssetClass, getProductId, getProductType, getSecondaryAssetClass, setId, setPrimaryAssetClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rest

protected List<jakarta.xml.bind.JAXBElement<?>> rest

Constructor Details

FxTargetKnockoutForward

public FxTargetKnockoutForward()

Method Details

getRest

public List<jakarta.xml.bind.JAXBElement<?>> getRest()

Gets the rest of the content model.

You are getting this "catch-all" property because of the following reason: The field name "ConstantPayoffRegion" is used by two different parts of a schema. See: line 616 of file:/Users/fries/git-sdc/finmath-smart-derivative-contract/target/checkout/src/main/resources/schemas/fpml-schemas/fpml-fx-targets-5-9.xsd line 596 of file:/Users/fries/git-sdc/finmath-smart-derivative-contract/target/checkout/src/main/resources/schemas/fpml-schemas/fpml-fx-targets-5-9.xsd

To get rid of this property, apply a property customization to one of both of the following declarations to change their names: Gets the value of the rest 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 rest property.

For example, to add a new item, do as follows:

    getRest().add(newItem);
 

Objects of the following type(s) are allowed in the list JAXBElement<QuotedCurrencyPair> JAXBElement<NonNegativeAmountSchedule> JAXBElement<FxTarget> JAXBElement<FxExpirySchedule> JAXBElement<FxSettlementSchedule> JAXBElement<FxInformationSource> JAXBElement<BigDecimal> JAXBElement<FxPivot> JAXBElement<FxTargetConstantPayoffRegion> JAXBElement<FxTargetLinearPayoffRegion> JAXBElement<FxTargetBarrier> JAXBElement<SimplePayment> JAXBElement<FxCashSettlementSimple> JAXBElement<FxTargetSettlementPeriodSchedule>