Class CommodityExercise
java.lang.Object
net.finmath.smartcontract.product.xml.CommodityExercise
The parameters for defining how the commodity option can be exercised, how
it is priced and how it is settled.
Java class for CommodityExercise complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="CommodityExercise">
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
<choice>
<element name="americanExercise" type="{http://www.fpml.org/FpML-5/confirmation}CommodityAmericanExercise"/>
<element name="europeanExercise" type="{http://www.fpml.org/FpML-5/confirmation}CommodityEuropeanExercise"/>
</choice>
<element name="automaticExercise" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
<element name="writtenConfirmation" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
<element name="settlementCurrency" type="{http://www.fpml.org/FpML-5/confirmation}IdentifiedCurrency"/>
<element name="fx" type="{http://www.fpml.org/FpML-5/confirmation}CommodityFx" minOccurs="0"/>
<element name="conversionFactor" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
<group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityPaymentDates.model"/>
</sequence>
</restriction>
</complexContent>
</complexType>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CommodityAmericanExerciseprotected Booleanprotected BigDecimalprotected CommodityEuropeanExerciseprotected CommodityFxprotected Booleanprotected AdjustableDatesOrRelativeDateOffsetprotected CommodityRelativePaymentDatesprotected IdentifiedCurrencyprotected Boolean -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the americanExercise property.Gets the value of the conversionFactor property.Gets the value of the europeanExercise property.getFx()Gets the value of the fx property.Gets the value of the paymentDates property.Gets the value of the relativePaymentDates property.Gets the value of the settlementCurrency property.Gets the value of the automaticExercise property.Gets the value of the masterAgreementPaymentDates property.Gets the value of the writtenConfirmation property.voidSets the value of the americanExercise property.voidsetAutomaticExercise(Boolean value) Sets the value of the automaticExercise property.voidsetConversionFactor(BigDecimal value) Sets the value of the conversionFactor property.voidSets the value of the europeanExercise property.voidsetFx(CommodityFx value) Sets the value of the fx property.voidSets the value of the masterAgreementPaymentDates property.voidSets the value of the paymentDates property.voidSets the value of the relativePaymentDates property.voidSets the value of the settlementCurrency property.voidsetWrittenConfirmation(Boolean value) Sets the value of the writtenConfirmation property.
-
Field Details
-
americanExercise
-
europeanExercise
-
automaticExercise
-
writtenConfirmation
-
settlementCurrency
-
fx
-
conversionFactor
-
relativePaymentDates
-
paymentDates
-
masterAgreementPaymentDates
-
-
Constructor Details
-
CommodityExercise
public CommodityExercise()
-
-
Method Details
-
getAmericanExercise
Gets the value of the americanExercise property.- Returns:
- possible object is
CommodityAmericanExercise
-
setAmericanExercise
Sets the value of the americanExercise property.- Parameters:
value- allowed object isCommodityAmericanExercise
-
getEuropeanExercise
Gets the value of the europeanExercise property.- Returns:
- possible object is
CommodityEuropeanExercise
-
setEuropeanExercise
Sets the value of the europeanExercise property.- Parameters:
value- allowed object isCommodityEuropeanExercise
-
isAutomaticExercise
-
setAutomaticExercise
-
isWrittenConfirmation
-
setWrittenConfirmation
-
getSettlementCurrency
Gets the value of the settlementCurrency property.- Returns:
- possible object is
IdentifiedCurrency
-
setSettlementCurrency
Sets the value of the settlementCurrency property.- Parameters:
value- allowed object isIdentifiedCurrency
-
getFx
Gets the value of the fx property.- Returns:
- possible object is
CommodityFx
-
setFx
Sets the value of the fx property.- Parameters:
value- allowed object isCommodityFx
-
getConversionFactor
Gets the value of the conversionFactor property.- Returns:
- possible object is
BigDecimal
-
setConversionFactor
Sets the value of the conversionFactor property.- Parameters:
value- allowed object isBigDecimal
-
getRelativePaymentDates
Gets the value of the relativePaymentDates property.- Returns:
- possible object is
CommodityRelativePaymentDates
-
setRelativePaymentDates
Sets the value of the relativePaymentDates property.- Parameters:
value- allowed object isCommodityRelativePaymentDates
-
getPaymentDates
Gets the value of the paymentDates property.- Returns:
- possible object is
AdjustableDatesOrRelativeDateOffset
-
setPaymentDates
Sets the value of the paymentDates property.- Parameters:
value- allowed object isAdjustableDatesOrRelativeDateOffset
-
isMasterAgreementPaymentDates
-
setMasterAgreementPaymentDates
-