Class OptionBaseExtended
java.lang.Object
net.finmath.smartcontract.product.xml.Product
net.finmath.smartcontract.product.xml.Option
net.finmath.smartcontract.product.xml.OptionBase
net.finmath.smartcontract.product.xml.OptionBaseExtended
- Direct Known Subclasses:
BondOption,CreditDefaultSwapOption
Base type for options starting with the 4-3 release, until we refactor the
schema as part of the 5-0 release series.
Java class for OptionBaseExtended complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="OptionBaseExtended">
<complexContent>
<extension base="{http://www.fpml.org/FpML-5/confirmation}OptionBase">
<sequence>
<element name="premium" type="{http://www.fpml.org/FpML-5/confirmation}Premium" minOccurs="0"/>
<element ref="{http://www.fpml.org/FpML-5/confirmation}exercise"/>
<element name="exerciseProcedure" type="{http://www.fpml.org/FpML-5/confirmation}ExerciseProcedure"/>
<element name="feature" type="{http://www.fpml.org/FpML-5/confirmation}OptionFeature" minOccurs="0"/>
<choice minOccurs="0">
<element name="notionalReference" type="{http://www.fpml.org/FpML-5/confirmation}NotionalAmountReference"/>
<element name="notionalAmount" type="{http://www.fpml.org/FpML-5/confirmation}Money"/>
</choice>
<group ref="{http://www.fpml.org/FpML-5/confirmation}OptionDenomination.model" minOccurs="0"/>
<group ref="{http://www.fpml.org/FpML-5/confirmation}OptionSettlement.model"/>
</sequence>
</extension>
</complexContent>
</complexType>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Currencyprotected jakarta.xml.bind.JAXBElement<? extends Exercise> protected ExerciseProcedureprotected OptionFeatureprotected Moneyprotected NotionalAmountReferenceprotected BigDecimalprotected BigDecimalprotected Premiumprotected Moneyprotected Currencyprotected AdjustableOrRelativeDateprotected SettlementTypeEnumFields inherited from class net.finmath.smartcontract.product.xml.OptionBase
optionTypeFields inherited from class net.finmath.smartcontract.product.xml.Option
buyerAccountReference, buyerPartyReference, sellerAccountReference, sellerPartyReferenceFields 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 entitlementCurrency property.jakarta.xml.bind.JAXBElement<? extends Exercise> Gets the value of the exercise property.Gets the value of the exerciseProcedure property.Gets the value of the feature property.Gets the value of the notionalAmount property.Gets the value of the notionalReference property.Gets the value of the numberOfOptions property.Gets the value of the optionEntitlement property.Gets the value of the premium property.Gets the value of the settlementAmount property.Gets the value of the settlementCurrency property.Gets the value of the settlementDate property.Gets the value of the settlementType property.voidsetEntitlementCurrency(Currency value) Sets the value of the entitlementCurrency property.voidsetExercise(jakarta.xml.bind.JAXBElement<? extends Exercise> value) Sets the value of the exercise property.voidSets the value of the exerciseProcedure property.voidsetFeature(OptionFeature value) Sets the value of the feature property.voidsetNotionalAmount(Money value) Sets the value of the notionalAmount property.voidSets the value of the notionalReference property.voidsetNumberOfOptions(BigDecimal value) Sets the value of the numberOfOptions property.voidsetOptionEntitlement(BigDecimal value) Sets the value of the optionEntitlement property.voidsetPremium(Premium value) Sets the value of the premium property.voidsetSettlementAmount(Money value) Sets the value of the settlementAmount property.voidsetSettlementCurrency(Currency value) Sets the value of the settlementCurrency property.voidSets the value of the settlementDate property.voidSets the value of the settlementType property.Methods inherited from class net.finmath.smartcontract.product.xml.OptionBase
getOptionType, setOptionTypeMethods inherited from class net.finmath.smartcontract.product.xml.Option
getBuyerAccountReference, getBuyerPartyReference, getSellerAccountReference, getSellerPartyReference, setBuyerAccountReference, setBuyerPartyReference, setSellerAccountReference, setSellerPartyReferenceMethods inherited from class net.finmath.smartcontract.product.xml.Product
getAssetClass, getId, getPrimaryAssetClass, getProductId, getProductType, getSecondaryAssetClass, setId, setPrimaryAssetClass
-
Field Details
-
exercise
-
exerciseProcedure
-
feature
-
notionalReference
-
notionalAmount
-
optionEntitlement
-
entitlementCurrency
-
numberOfOptions
-
settlementType
-
settlementDate
-
settlementAmount
-
settlementCurrency
-
Constructor Details
-
OptionBaseExtended
public OptionBaseExtended()
-
-
Method Details
-
getPremium
-
setPremium
-
getExercise
Gets the value of the exercise property.- Returns:
- possible object is
JAXBElement<EuropeanExercise>JAXBElement<AmericanExercise>JAXBElement<BermudaExercise>JAXBElement<Exercise>
-
setExercise
Sets the value of the exercise property.- Parameters:
value- allowed object isJAXBElement<EuropeanExercise>JAXBElement<AmericanExercise>JAXBElement<BermudaExercise>JAXBElement<Exercise>
-
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
-
getFeature
Gets the value of the feature property.- Returns:
- possible object is
OptionFeature
-
setFeature
Sets the value of the feature property.- Parameters:
value- allowed object isOptionFeature
-
getNotionalReference
Gets the value of the notionalReference property.- Returns:
- possible object is
NotionalAmountReference
-
setNotionalReference
Sets the value of the notionalReference property.- Parameters:
value- allowed object isNotionalAmountReference
-
getNotionalAmount
-
setNotionalAmount
-
getOptionEntitlement
Gets the value of the optionEntitlement property.- Returns:
- possible object is
BigDecimal
-
setOptionEntitlement
Sets the value of the optionEntitlement property.- Parameters:
value- allowed object isBigDecimal
-
getEntitlementCurrency
-
setEntitlementCurrency
-
getNumberOfOptions
Gets the value of the numberOfOptions property.- Returns:
- possible object is
BigDecimal
-
setNumberOfOptions
Sets the value of the numberOfOptions property.- Parameters:
value- allowed object isBigDecimal
-
getSettlementType
Gets the value of the settlementType property.- Returns:
- possible object is
SettlementTypeEnum
-
setSettlementType
Sets the value of the settlementType property.- Parameters:
value- allowed object isSettlementTypeEnum
-
getSettlementDate
Gets the value of the settlementDate property.- Returns:
- possible object is
AdjustableOrRelativeDate
-
setSettlementDate
Sets the value of the settlementDate property.- Parameters:
value- allowed object isAdjustableOrRelativeDate
-
getSettlementAmount
-
setSettlementAmount
-
getSettlementCurrency
-
setSettlementCurrency
-