Class CommodityBasketOption
java.lang.Object
net.finmath.smartcontract.product.xml.Product
net.finmath.smartcontract.product.xml.Option
net.finmath.smartcontract.product.xml.CommodityBasketOption
Java class for CommodityBasketOption complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="CommodityBasketOption">
<complexContent>
<extension base="{http://www.fpml.org/FpML-5/confirmation}Option">
<sequence>
<element name="optionType" type="{http://www.fpml.org/FpML-5/confirmation}PutCallEnum"/>
<group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityBasketOptionFeatures.model" minOccurs="0"/>
<group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityBasket.model"/>
<sequence>
<choice>
<element name="strikePriceUnderlyingReference" type="{http://www.fpml.org/FpML-5/confirmation}StrikePriceUnderlyingReference"/>
<element name="strikePriceBasketReference" type="{http://www.fpml.org/FpML-5/confirmation}StrikePriceBasketReference"/>
</choice>
<choice>
<group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityStrikePrice.model"/>
<group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityFloatingStrikePrice.model"/>
</choice>
</sequence>
<element name="exercise" type="{http://www.fpml.org/FpML-5/confirmation}CommodityExerciseBasket"/>
<element name="premium" type="{http://www.fpml.org/FpML-5/confirmation}CommodityPremium" maxOccurs="unbounded"/>
<group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityContent.model" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected AdjustableDatesprotected CommodityCalculationPeriodsScheduleprotected Booleanprotected AdjustableOrRelativeDateprotected CommodityExerciseBasketprotected FloatingStrikePriceprotected CommodityCalculationPeriodsScheduleprotected CommodityMarketDisruptionprotected CommodityBasketByPercentageprotected CommodityBasketByNotionalprotected PutCallEnumprotected List<CommodityPremium> protected Roundingprotected CommodityBullionSettlementDisruptionEnumprotected StrikePriceBasketReferenceprotected NonNegativeMoneyprotected CommodityStrikeScheduleprotected StrikePriceUnderlyingReferenceprotected AdjustableOrRelativeDateFields 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 calculationPeriods property.Gets the value of the calculationPeriodsSchedule property.Gets the value of the effectiveDate property.Gets the value of the exercise property.Gets the value of the floatingStrikePricePerUnit property.Gets the value of the floatingStrikePricePerUnitSchedule property.Gets the value of the marketDisruption property.Gets the value of the notionalAmountBasket property.Gets the value of the notionalQuantityBasket property.Gets the value of the optionType property.Gets the value of the premium property.Gets the value of the rounding property.Gets the value of the settlementDisruption property.Gets the value of the strikePriceBasketReference property.Gets the value of the strikePricePerUnit property.Gets the value of the strikePricePerUnitSchedule property.Gets the value of the strikePriceUnderlyingReference property.Gets the value of the terminationDate property.Gets the value of the commonPricing property.voidSets the value of the calculationPeriods property.voidSets the value of the calculationPeriodsSchedule property.voidsetCommonPricing(Boolean value) Sets the value of the commonPricing property.voidSets the value of the effectiveDate property.voidSets the value of the exercise property.voidSets the value of the floatingStrikePricePerUnit property.voidSets the value of the floatingStrikePricePerUnitSchedule property.voidSets the value of the marketDisruption property.voidSets the value of the notionalAmountBasket property.voidSets the value of the notionalQuantityBasket property.voidsetOptionType(PutCallEnum value) Sets the value of the optionType property.voidsetRounding(Rounding value) Sets the value of the rounding property.voidSets the value of the settlementDisruption property.voidSets the value of the strikePriceBasketReference property.voidSets the value of the strikePricePerUnit property.voidSets the value of the strikePricePerUnitSchedule property.voidSets the value of the strikePriceUnderlyingReference property.voidSets the value of the terminationDate property.Methods 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
-
optionType
-
effectiveDate
-
terminationDate
-
calculationPeriodsSchedule
-
calculationPeriods
-
notionalQuantityBasket
-
notionalAmountBasket
-
strikePriceUnderlyingReference
-
strikePriceBasketReference
-
strikePricePerUnit
-
strikePricePerUnitSchedule
-
floatingStrikePricePerUnit
-
floatingStrikePricePerUnitSchedule
-
exercise
-
commonPricing
-
marketDisruption
-
settlementDisruption
-
rounding
-
-
Constructor Details
-
CommodityBasketOption
public CommodityBasketOption()
-
-
Method Details
-
getOptionType
Gets the value of the optionType property.- Returns:
- possible object is
PutCallEnum
-
setOptionType
Sets the value of the optionType property.- Parameters:
value- allowed object isPutCallEnum
-
getEffectiveDate
Gets the value of the effectiveDate property.- Returns:
- possible object is
AdjustableOrRelativeDate
-
setEffectiveDate
Sets the value of the effectiveDate property.- Parameters:
value- allowed object isAdjustableOrRelativeDate
-
getTerminationDate
Gets the value of the terminationDate property.- Returns:
- possible object is
AdjustableOrRelativeDate
-
setTerminationDate
Sets the value of the terminationDate property.- Parameters:
value- allowed object isAdjustableOrRelativeDate
-
getCalculationPeriodsSchedule
Gets the value of the calculationPeriodsSchedule property.- Returns:
- possible object is
CommodityCalculationPeriodsSchedule
-
setCalculationPeriodsSchedule
Sets the value of the calculationPeriodsSchedule property.- Parameters:
value- allowed object isCommodityCalculationPeriodsSchedule
-
getCalculationPeriods
Gets the value of the calculationPeriods property.- Returns:
- possible object is
AdjustableDates
-
setCalculationPeriods
Sets the value of the calculationPeriods property.- Parameters:
value- allowed object isAdjustableDates
-
getNotionalQuantityBasket
Gets the value of the notionalQuantityBasket property.- Returns:
- possible object is
CommodityBasketByNotional
-
setNotionalQuantityBasket
Sets the value of the notionalQuantityBasket property.- Parameters:
value- allowed object isCommodityBasketByNotional
-
getNotionalAmountBasket
Gets the value of the notionalAmountBasket property.- Returns:
- possible object is
CommodityBasketByPercentage
-
setNotionalAmountBasket
Sets the value of the notionalAmountBasket property.- Parameters:
value- allowed object isCommodityBasketByPercentage
-
getStrikePriceUnderlyingReference
Gets the value of the strikePriceUnderlyingReference property.- Returns:
- possible object is
StrikePriceUnderlyingReference
-
setStrikePriceUnderlyingReference
Sets the value of the strikePriceUnderlyingReference property.- Parameters:
value- allowed object isStrikePriceUnderlyingReference
-
getStrikePriceBasketReference
Gets the value of the strikePriceBasketReference property.- Returns:
- possible object is
StrikePriceBasketReference
-
setStrikePriceBasketReference
Sets the value of the strikePriceBasketReference property.- Parameters:
value- allowed object isStrikePriceBasketReference
-
getStrikePricePerUnit
Gets the value of the strikePricePerUnit property.- Returns:
- possible object is
NonNegativeMoney
-
setStrikePricePerUnit
Sets the value of the strikePricePerUnit property.- Parameters:
value- allowed object isNonNegativeMoney
-
getStrikePricePerUnitSchedule
Gets the value of the strikePricePerUnitSchedule property.- Returns:
- possible object is
CommodityStrikeSchedule
-
setStrikePricePerUnitSchedule
Sets the value of the strikePricePerUnitSchedule property.- Parameters:
value- allowed object isCommodityStrikeSchedule
-
getFloatingStrikePricePerUnit
Gets the value of the floatingStrikePricePerUnit property.- Returns:
- possible object is
FloatingStrikePrice
-
setFloatingStrikePricePerUnit
Sets the value of the floatingStrikePricePerUnit property.- Parameters:
value- allowed object isFloatingStrikePrice
-
getFloatingStrikePricePerUnitSchedule
Gets the value of the floatingStrikePricePerUnitSchedule property.- Returns:
- possible object is
CommodityCalculationPeriodsSchedule
-
setFloatingStrikePricePerUnitSchedule
Sets the value of the floatingStrikePricePerUnitSchedule property.- Parameters:
value- allowed object isCommodityCalculationPeriodsSchedule
-
getExercise
Gets the value of the exercise property.- Returns:
- possible object is
CommodityExerciseBasket
-
setExercise
Sets the value of the exercise property.- Parameters:
value- allowed object isCommodityExerciseBasket
-
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
setmethod 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
CommodityPremium -
isCommonPricing
-
setCommonPricing
-
getMarketDisruption
Gets the value of the marketDisruption property.- Returns:
- possible object is
CommodityMarketDisruption
-
setMarketDisruption
Sets the value of the marketDisruption property.- Parameters:
value- allowed object isCommodityMarketDisruption
-
getSettlementDisruption
Gets the value of the settlementDisruption property.- Returns:
- possible object is
CommodityBullionSettlementDisruptionEnum
-
setSettlementDisruption
Sets the value of the settlementDisruption property.- Parameters:
value- allowed object isCommodityBullionSettlementDisruptionEnum
-
getRounding
-
setRounding
-