Class FxAccrualOption
Java class for FxAccrualOption complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="FxAccrualOption"> <complexContent> <extension base="{http://www.fpml.org/FpML-5/confirmation}Option"> <sequence> <group ref="{http://www.fpml.org/FpML-5/confirmation}PutCallCurrency.model"/> <element name="notionalAmount" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeAmountSchedule"/> <element name="accrual" type="{http://www.fpml.org/FpML-5/confirmation}FxAccrual"/> <group ref="{http://www.fpml.org/FpML-5/confirmation}FxExpiryDateOrSchedule.model"/> <group ref="{http://www.fpml.org/FpML-5/confirmation}FxSettlementDateOrSchedule.model"/> <element name="exerciseProcedure" type="{http://www.fpml.org/FpML-5/confirmation}ExerciseProcedure" minOccurs="0"/> <element name="spotRate" type="{http://www.fpml.org/FpML-5/confirmation}PositiveDecimal" minOccurs="0"/> <choice> <sequence> <element name="strike" type="{http://www.fpml.org/FpML-5/confirmation}FxOptionStrikePrice"/> <element name="counterCurrencyAmount" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeAmountSchedule" minOccurs="0"/> </sequence> <element name="averageStrike" type="{http://www.fpml.org/FpML-5/confirmation}FxAverageStrike"/> </choice> <element name="averageRate" type="{http://www.fpml.org/FpML-5/confirmation}FxAverageRate" minOccurs="0"/> <element name="barrier" type="{http://www.fpml.org/FpML-5/confirmation}FxAccrualBarrier" maxOccurs="unbounded" minOccurs="0"/> <element name="premium" type="{http://www.fpml.org/FpML-5/confirmation}FxOptionPremium" maxOccurs="unbounded" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>
-
Field Summary
Modifier and TypeFieldDescriptionprotected FxAccrual
protected FxAverageRate
protected FxAverageStrike
protected List
<FxAccrualBarrier> protected Currency
protected NonNegativeAmountSchedule
protected ExerciseProcedure
protected FxExpiryDate
protected FxExpirySchedule
protected NonNegativeAmountSchedule
protected List
<FxOptionPremium> protected Currency
protected FxAdjustedDateAndDateAdjustments
protected FxSettlementSchedule
protected BigDecimal
protected FxOptionStrikePrice
Fields inherited from class net.finmath.smartcontract.product.xml.Option
buyerAccountReference, buyerPartyReference, sellerAccountReference, sellerPartyReference
Fields inherited from class net.finmath.smartcontract.product.xml.Product
assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the value of the accrual property.Gets the value of the averageRate property.Gets the value of the averageStrike property.Gets the value of the barrier property.Gets the value of the callCurrency property.Gets the value of the counterCurrencyAmount property.Gets the value of the exerciseProcedure property.Gets the value of the expiryDate property.Gets the value of the expirySchedule property.Gets the value of the notionalAmount property.Gets the value of the premium property.Gets the value of the putCurrency property.Gets the value of the settlementDate property.Gets the value of the settlementSchedule property.Gets the value of the spotRate property.Gets the value of the strike property.void
setAccrual
(FxAccrual value) Sets the value of the accrual property.void
setAverageRate
(FxAverageRate value) Sets the value of the averageRate property.void
setAverageStrike
(FxAverageStrike value) Sets the value of the averageStrike property.void
setCallCurrency
(Currency value) Sets the value of the callCurrency property.void
Sets the value of the counterCurrencyAmount property.void
Sets the value of the exerciseProcedure property.void
setExpiryDate
(FxExpiryDate value) Sets the value of the expiryDate property.void
Sets the value of the expirySchedule property.void
Sets the value of the notionalAmount property.void
setPutCurrency
(Currency value) Sets the value of the putCurrency property.void
Sets the value of the settlementDate property.void
Sets the value of the settlementSchedule property.void
setSpotRate
(BigDecimal value) Sets the value of the spotRate property.void
setStrike
(FxOptionStrikePrice value) Sets the value of the strike property.Methods inherited from class net.finmath.smartcontract.product.xml.Option
getBuyerAccountReference, getBuyerPartyReference, getSellerAccountReference, getSellerPartyReference, setBuyerAccountReference, setBuyerPartyReference, setSellerAccountReference, setSellerPartyReference
Methods inherited from class net.finmath.smartcontract.product.xml.Product
getAssetClass, getId, getPrimaryAssetClass, getProductId, getProductType, getSecondaryAssetClass, setId, setPrimaryAssetClass
-
Field Details
-
putCurrency
-
callCurrency
-
notionalAmount
-
accrual
-
expiryDate
-
expirySchedule
-
settlementDate
-
settlementSchedule
-
exerciseProcedure
-
spotRate
-
strike
-
counterCurrencyAmount
-
averageStrike
-
averageRate
-
barrier
-
-
Constructor Details
-
FxAccrualOption
public FxAccrualOption()
-
-
Method Details
-
getPutCurrency
-
setPutCurrency
-
getCallCurrency
-
setCallCurrency
-
getNotionalAmount
Gets the value of the notionalAmount property.- Returns:
- possible object is
NonNegativeAmountSchedule
-
setNotionalAmount
Sets the value of the notionalAmount property.- Parameters:
value
- allowed object isNonNegativeAmountSchedule
-
getAccrual
-
setAccrual
-
getExpiryDate
Gets the value of the expiryDate property.- Returns:
- possible object is
FxExpiryDate
-
setExpiryDate
Sets the value of the expiryDate property.- Parameters:
value
- allowed object isFxExpiryDate
-
getExpirySchedule
Gets the value of the expirySchedule property.- Returns:
- possible object is
FxExpirySchedule
-
setExpirySchedule
Sets the value of the expirySchedule property.- Parameters:
value
- allowed object isFxExpirySchedule
-
getSettlementDate
Gets the value of the settlementDate property.- Returns:
- possible object is
FxAdjustedDateAndDateAdjustments
-
setSettlementDate
Sets the value of the settlementDate property.- Parameters:
value
- allowed object isFxAdjustedDateAndDateAdjustments
-
getSettlementSchedule
Gets the value of the settlementSchedule property.- Returns:
- possible object is
FxSettlementSchedule
-
setSettlementSchedule
Sets the value of the settlementSchedule property.- Parameters:
value
- allowed object isFxSettlementSchedule
-
getExerciseProcedure
Gets the value of the exerciseProcedure property.- Returns:
- possible object is
ExerciseProcedure
-
setExerciseProcedure
Sets the value of the exerciseProcedure property.- Parameters:
value
- allowed object isExerciseProcedure
-
getSpotRate
Gets the value of the spotRate property.- Returns:
- possible object is
BigDecimal
-
setSpotRate
Sets the value of the spotRate property.- Parameters:
value
- allowed object isBigDecimal
-
getStrike
Gets the value of the strike property.- Returns:
- possible object is
FxOptionStrikePrice
-
setStrike
Sets the value of the strike property.- Parameters:
value
- allowed object isFxOptionStrikePrice
-
getCounterCurrencyAmount
Gets the value of the counterCurrencyAmount property.- Returns:
- possible object is
NonNegativeAmountSchedule
-
setCounterCurrencyAmount
Sets the value of the counterCurrencyAmount property.- Parameters:
value
- allowed object isNonNegativeAmountSchedule
-
getAverageStrike
Gets the value of the averageStrike property.- Returns:
- possible object is
FxAverageStrike
-
setAverageStrike
Sets the value of the averageStrike property.- Parameters:
value
- allowed object isFxAverageStrike
-
getAverageRate
Gets the value of the averageRate property.- Returns:
- possible object is
FxAverageRate
-
setAverageRate
Sets the value of the averageRate property.- Parameters:
value
- allowed object isFxAverageRate
-
getBarrier
Gets the value of the barrier 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 barrier property.For example, to add a new item, do as follows:
getBarrier().add(newItem);
Objects of the following type(s) are allowed in the list
FxAccrualBarrier
-
getPremium
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
FxOptionPremium
-