Class OptionExercise
Java class for OptionExercise complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="OptionExercise">
<complexContent>
<extension base="{http://www.fpml.org/FpML-5/confirmation}AbstractEvent">
<sequence>
<element name="optionSeller" type="{http://www.fpml.org/FpML-5/confirmation}PartyReference" minOccurs="0"/>
<element name="optionBuyer" type="{http://www.fpml.org/FpML-5/confirmation}PartyReference" minOccurs="0"/>
<choice>
<element name="originalTrade" type="{http://www.fpml.org/FpML-5/confirmation}Trade"/>
<element name="tradeIdentifier" type="{http://www.fpml.org/FpML-5/confirmation}PartyTradeIdentifier" maxOccurs="unbounded"/>
</choice>
<choice>
<sequence>
<element name="exerciseDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
<element name="exerciseTime" type="{http://www.w3.org/2001/XMLSchema}time" minOccurs="0"/>
</sequence>
<element name="exerciseTiming" type="{http://www.fpml.org/FpML-5/confirmation}ExerciseTimingEnum"/>
</choice>
<group ref="{http://www.fpml.org/FpML-5/confirmation}OptionExerciseAmount.model"/>
<element name="exerciseSide" type="{http://www.fpml.org/FpML-5/confirmation}ExerciseSideEnum" minOccurs="0"/>
<choice minOccurs="0">
<element name="settlementType" type="{http://www.fpml.org/FpML-5/confirmation}SettlementTypeEnum"/>
<element name="cashSettlement" type="{http://www.fpml.org/FpML-5/confirmation}SimplePayment"/>
<element name="physicalSettlement" type="{http://www.fpml.org/FpML-5/confirmation}PhysicalSettlement"/>
</choice>
<element name="payment" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativePayment" minOccurs="0"/>
<element name="clearingInstructions" type="{http://www.fpml.org/FpML-5/confirmation}ClearingInstructions" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected SimplePaymentprotected ClearingInstructionsprotected ExerciseActionEnumprotected XMLGregorianCalendarprotected Moneyprotected BigDecimalprotected BigDecimalprotected Stringprotected XMLGregorianCalendarprotected ExerciseTimingEnumprotected Booleanprotected Booleanprotected PartyReferenceprotected PartyReferenceprotected Tradeprotected Moneyprotected BigDecimalprotected BigDecimalprotected NonNegativePaymentprotected PhysicalSettlementprotected SettlementTypeEnumprotected List<OptionExerciseAmounts> protected List<PartyTradeIdentifier> Fields inherited from class net.finmath.smartcontract.product.xml.AbstractEvent
eventIdentifier -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the cashSettlement property.Gets the value of the clearingInstructions property.Gets the value of the exerciseAction property.Gets the value of the exerciseDate property.Gets the value of the exerciseInNotionalAmount property.Gets the value of the exerciseInNumberOfOptions property.Gets the value of the exerciseInNumberOfUnits property.Gets the value of the exerciseSide property.Gets the value of the exerciseTime property.Gets the value of the exerciseTiming property.Gets the value of the optionBuyer property.Gets the value of the optionSeller property.Gets the value of the originalTrade property.Gets the value of the outstandingNotionalAmount property.Gets the value of the outstandingNumberOfOptions property.Gets the value of the outstandingNumberOfUnits property.Gets the value of the payment property.Gets the value of the physicalSettlement property.Gets the value of the settlementType property.Gets the value of the specifiedExercise property.Gets the value of the tradeIdentifier property.isExpiry()Gets the value of the expiry property.Gets the value of the fullExercise property.voidsetCashSettlement(SimplePayment value) Sets the value of the cashSettlement property.voidSets the value of the clearingInstructions property.voidSets the value of the exerciseAction property.voidSets the value of the exerciseDate property.voidsetExerciseInNotionalAmount(Money value) Sets the value of the exerciseInNotionalAmount property.voidSets the value of the exerciseInNumberOfOptions property.voidSets the value of the exerciseInNumberOfUnits property.voidsetExerciseSide(String value) Sets the value of the exerciseSide property.voidSets the value of the exerciseTime property.voidSets the value of the exerciseTiming property.voidSets the value of the expiry property.voidsetFullExercise(Boolean value) Sets the value of the fullExercise property.voidsetOptionBuyer(PartyReference value) Sets the value of the optionBuyer property.voidsetOptionSeller(PartyReference value) Sets the value of the optionSeller property.voidsetOriginalTrade(Trade value) Sets the value of the originalTrade property.voidSets the value of the outstandingNotionalAmount property.voidSets the value of the outstandingNumberOfOptions property.voidSets the value of the outstandingNumberOfUnits property.voidsetPayment(NonNegativePayment value) Sets the value of the payment property.voidSets the value of the physicalSettlement property.voidSets the value of the settlementType property.Methods inherited from class net.finmath.smartcontract.product.xml.AbstractEvent
getEventIdentifier
-
Field Details
-
optionSeller
-
optionBuyer
-
originalTrade
-
tradeIdentifier
-
exerciseDate
-
exerciseTime
-
exerciseTiming
-
exerciseAction
-
expiry
-
fullExercise
-
exerciseInNotionalAmount
-
outstandingNotionalAmount
-
exerciseInNumberOfOptions
-
outstandingNumberOfOptions
-
exerciseInNumberOfUnits
-
outstandingNumberOfUnits
-
specifiedExercise
-
exerciseSide
-
settlementType
-
cashSettlement
-
physicalSettlement
-
payment
-
clearingInstructions
-
-
Constructor Details
-
OptionExercise
public OptionExercise()
-
-
Method Details
-
getOptionSeller
Gets the value of the optionSeller property.- Returns:
- possible object is
PartyReference
-
setOptionSeller
Sets the value of the optionSeller property.- Parameters:
value- allowed object isPartyReference
-
getOptionBuyer
Gets the value of the optionBuyer property.- Returns:
- possible object is
PartyReference
-
setOptionBuyer
Sets the value of the optionBuyer property.- Parameters:
value- allowed object isPartyReference
-
getOriginalTrade
-
setOriginalTrade
-
getTradeIdentifier
Gets the value of the tradeIdentifier 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 tradeIdentifier property.For example, to add a new item, do as follows:
getTradeIdentifier().add(newItem);Objects of the following type(s) are allowed in the list
PartyTradeIdentifier -
getExerciseDate
Gets the value of the exerciseDate property.- Returns:
- possible object is
XMLGregorianCalendar
-
setExerciseDate
Sets the value of the exerciseDate property.- Parameters:
value- allowed object isXMLGregorianCalendar
-
getExerciseTime
Gets the value of the exerciseTime property.- Returns:
- possible object is
XMLGregorianCalendar
-
setExerciseTime
Sets the value of the exerciseTime property.- Parameters:
value- allowed object isXMLGregorianCalendar
-
getExerciseTiming
Gets the value of the exerciseTiming property.- Returns:
- possible object is
ExerciseTimingEnum
-
setExerciseTiming
Sets the value of the exerciseTiming property.- Parameters:
value- allowed object isExerciseTimingEnum
-
getExerciseAction
Gets the value of the exerciseAction property.- Returns:
- possible object is
ExerciseActionEnum
-
setExerciseAction
Sets the value of the exerciseAction property.- Parameters:
value- allowed object isExerciseActionEnum
-
isExpiry
-
setExpiry
-
isFullExercise
-
setFullExercise
-
getExerciseInNotionalAmount
-
setExerciseInNotionalAmount
-
getOutstandingNotionalAmount
-
setOutstandingNotionalAmount
-
getExerciseInNumberOfOptions
Gets the value of the exerciseInNumberOfOptions property.- Returns:
- possible object is
BigDecimal
-
setExerciseInNumberOfOptions
Sets the value of the exerciseInNumberOfOptions property.- Parameters:
value- allowed object isBigDecimal
-
getOutstandingNumberOfOptions
Gets the value of the outstandingNumberOfOptions property.- Returns:
- possible object is
BigDecimal
-
setOutstandingNumberOfOptions
Sets the value of the outstandingNumberOfOptions property.- Parameters:
value- allowed object isBigDecimal
-
getExerciseInNumberOfUnits
Gets the value of the exerciseInNumberOfUnits property.- Returns:
- possible object is
BigDecimal
-
setExerciseInNumberOfUnits
Sets the value of the exerciseInNumberOfUnits property.- Parameters:
value- allowed object isBigDecimal
-
getOutstandingNumberOfUnits
Gets the value of the outstandingNumberOfUnits property.- Returns:
- possible object is
BigDecimal
-
setOutstandingNumberOfUnits
Sets the value of the outstandingNumberOfUnits property.- Parameters:
value- allowed object isBigDecimal
-
getSpecifiedExercise
Gets the value of the specifiedExercise 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 specifiedExercise property.For example, to add a new item, do as follows:
getSpecifiedExercise().add(newItem);Objects of the following type(s) are allowed in the list
OptionExerciseAmounts -
getExerciseSide
-
setExerciseSide
-
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
-
getCashSettlement
Gets the value of the cashSettlement property.- Returns:
- possible object is
SimplePayment
-
setCashSettlement
Sets the value of the cashSettlement property.- Parameters:
value- allowed object isSimplePayment
-
getPhysicalSettlement
Gets the value of the physicalSettlement property.- Returns:
- possible object is
PhysicalSettlement
-
setPhysicalSettlement
Sets the value of the physicalSettlement property.- Parameters:
value- allowed object isPhysicalSettlement
-
getPayment
Gets the value of the payment property.- Returns:
- possible object is
NonNegativePayment
-
setPayment
Sets the value of the payment property.- Parameters:
value- allowed object isNonNegativePayment
-
getClearingInstructions
Gets the value of the clearingInstructions property.- Returns:
- possible object is
ClearingInstructions
-
setClearingInstructions
Sets the value of the clearingInstructions property.- Parameters:
value- allowed object isClearingInstructions
-