Class FxFlexibleForward
java.lang.Object
net.finmath.smartcontract.product.xml.Product
net.finmath.smartcontract.product.xml.FxFlexibleForward
Product model for a flexible-term fx forward (also known as callable
forward, window forward). This is a term forward transaction over a specific period, allowing the client
full flexibility on the timing of the transactional flow(s). The product allows for (full or partial)
execution at a predetermined forward rate, at any time between the start date and the expiry date.
Although, the product is an outright, it has some option-like characteristics, leading to the use of
option components in the model: (i) the BuyerSeller model expresses the roles of the parties in the
overall transaction - the client "buys" the product (ii) the PutCallCurrency model expresses the buyer's
perspective on the exchanged currencies i.e. the client may buy (call) or sell (put) the notional
currency for the alternative currency.
Java class for FxFlexibleForward complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="FxFlexibleForward">
<complexContent>
<extension base="{http://www.fpml.org/FpML-5/confirmation}Product">
<sequence>
<group ref="{http://www.fpml.org/FpML-5/confirmation}BuyerSeller.model"/>
<group ref="{http://www.fpml.org/FpML-5/confirmation}PutCallCurrency.model"/>
<sequence>
<element name="notionalAmount" type="{http://www.fpml.org/FpML-5/confirmation}PositiveMoney"/>
<element name="minimumExecutionAmount" type="{http://www.fpml.org/FpML-5/confirmation}PositiveMoney" minOccurs="0"/>
<element name="settlementAmount" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeMoney" minOccurs="0"/>
</sequence>
<element name="executionPeriodDates" type="{http://www.fpml.org/FpML-5/confirmation}FxFlexibleForwardExecutionPeriod"/>
<sequence minOccurs="0">
<element name="earliestExecutionTime" type="{http://www.fpml.org/FpML-5/confirmation}BusinessCenterTime"/>
<element name="latestExecutionTime" type="{http://www.fpml.org/FpML-5/confirmation}BusinessCenterTime"/>
</sequence>
<element name="settlementDateOffset" type="{http://www.fpml.org/FpML-5/confirmation}RelativeDateOffset" minOccurs="0"/>
<element name="finalSettlementDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
<element name="forwardRate" type="{http://www.fpml.org/FpML-5/confirmation}FxFlexibleForwardRate"/>
<element name="additionalPayment" type="{http://www.fpml.org/FpML-5/confirmation}Payment" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Paymentprotected AccountReferenceprotected PartyReferenceprotected Currencyprotected BusinessCenterTimeprotected FxFlexibleForwardExecutionPeriodprotected XMLGregorianCalendarprotected FxFlexibleForwardRateprotected BusinessCenterTimeprotected PositiveMoneyprotected PositiveMoneyprotected Currencyprotected AccountReferenceprotected PartyReferenceprotected NonNegativeMoneyprotected RelativeDateOffsetFields 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 buyerAccountReference property.Gets the value of the buyerPartyReference property.Gets the value of the callCurrency property.Gets the value of the earliestExecutionTime property.Gets the value of the executionPeriodDates property.Gets the value of the finalSettlementDate property.Gets the value of the forwardRate property.Gets the value of the latestExecutionTime property.Gets the value of the minimumExecutionAmount property.Gets the value of the notionalAmount property.Gets the value of the putCurrency property.Gets the value of the sellerAccountReference property.Gets the value of the sellerPartyReference property.Gets the value of the settlementAmount property.Gets the value of the settlementDateOffset property.voidsetAdditionalPayment(Payment value) Sets the value of the additionalPayment property.voidSets the value of the buyerAccountReference property.voidSets the value of the buyerPartyReference property.voidsetCallCurrency(Currency value) Sets the value of the callCurrency property.voidSets the value of the earliestExecutionTime property.voidSets the value of the executionPeriodDates property.voidSets the value of the finalSettlementDate property.voidSets the value of the forwardRate property.voidSets the value of the latestExecutionTime property.voidSets the value of the minimumExecutionAmount property.voidsetNotionalAmount(PositiveMoney value) Sets the value of the notionalAmount property.voidsetPutCurrency(Currency value) Sets the value of the putCurrency property.voidSets the value of the sellerAccountReference property.voidSets the value of the sellerPartyReference property.voidSets the value of the settlementAmount property.voidSets the value of the settlementDateOffset property.Methods inherited from class net.finmath.smartcontract.product.xml.Product
getAssetClass, getId, getPrimaryAssetClass, getProductId, getProductType, getSecondaryAssetClass, setId, setPrimaryAssetClass
-
Field Details
-
buyerPartyReference
-
buyerAccountReference
-
sellerPartyReference
-
sellerAccountReference
-
putCurrency
-
callCurrency
-
notionalAmount
-
minimumExecutionAmount
-
settlementAmount
-
executionPeriodDates
-
earliestExecutionTime
-
latestExecutionTime
-
settlementDateOffset
-
finalSettlementDate
-
forwardRate
-
additionalPayment
-
-
Constructor Details
-
FxFlexibleForward
public FxFlexibleForward()
-
-
Method Details
-
getBuyerPartyReference
Gets the value of the buyerPartyReference property.- Returns:
- possible object is
PartyReference
-
setBuyerPartyReference
Sets the value of the buyerPartyReference property.- Parameters:
value- allowed object isPartyReference
-
getBuyerAccountReference
Gets the value of the buyerAccountReference property.- Returns:
- possible object is
AccountReference
-
setBuyerAccountReference
Sets the value of the buyerAccountReference property.- Parameters:
value- allowed object isAccountReference
-
getSellerPartyReference
Gets the value of the sellerPartyReference property.- Returns:
- possible object is
PartyReference
-
setSellerPartyReference
Sets the value of the sellerPartyReference property.- Parameters:
value- allowed object isPartyReference
-
getSellerAccountReference
Gets the value of the sellerAccountReference property.- Returns:
- possible object is
AccountReference
-
setSellerAccountReference
Sets the value of the sellerAccountReference property.- Parameters:
value- allowed object isAccountReference
-
getPutCurrency
-
setPutCurrency
-
getCallCurrency
-
setCallCurrency
-
getNotionalAmount
Gets the value of the notionalAmount property.- Returns:
- possible object is
PositiveMoney
-
setNotionalAmount
Sets the value of the notionalAmount property.- Parameters:
value- allowed object isPositiveMoney
-
getMinimumExecutionAmount
Gets the value of the minimumExecutionAmount property.- Returns:
- possible object is
PositiveMoney
-
setMinimumExecutionAmount
Sets the value of the minimumExecutionAmount property.- Parameters:
value- allowed object isPositiveMoney
-
getSettlementAmount
Gets the value of the settlementAmount property.- Returns:
- possible object is
NonNegativeMoney
-
setSettlementAmount
Sets the value of the settlementAmount property.- Parameters:
value- allowed object isNonNegativeMoney
-
getExecutionPeriodDates
Gets the value of the executionPeriodDates property.- Returns:
- possible object is
FxFlexibleForwardExecutionPeriod
-
setExecutionPeriodDates
Sets the value of the executionPeriodDates property.- Parameters:
value- allowed object isFxFlexibleForwardExecutionPeriod
-
getEarliestExecutionTime
Gets the value of the earliestExecutionTime property.- Returns:
- possible object is
BusinessCenterTime
-
setEarliestExecutionTime
Sets the value of the earliestExecutionTime property.- Parameters:
value- allowed object isBusinessCenterTime
-
getLatestExecutionTime
Gets the value of the latestExecutionTime property.- Returns:
- possible object is
BusinessCenterTime
-
setLatestExecutionTime
Sets the value of the latestExecutionTime property.- Parameters:
value- allowed object isBusinessCenterTime
-
getSettlementDateOffset
Gets the value of the settlementDateOffset property.- Returns:
- possible object is
RelativeDateOffset
-
setSettlementDateOffset
Sets the value of the settlementDateOffset property.- Parameters:
value- allowed object isRelativeDateOffset
-
getFinalSettlementDate
Gets the value of the finalSettlementDate property.- Returns:
- possible object is
XMLGregorianCalendar
-
setFinalSettlementDate
Sets the value of the finalSettlementDate property.- Parameters:
value- allowed object isXMLGregorianCalendar
-
getForwardRate
Gets the value of the forwardRate property.- Returns:
- possible object is
FxFlexibleForwardRate
-
setForwardRate
Sets the value of the forwardRate property.- Parameters:
value- allowed object isFxFlexibleForwardRate
-
getAdditionalPayment
-
setAdditionalPayment
-