Package net.finmath.smartcontract.product.xml

Class OptionExercise

java.lang.Object
net.finmath.smartcontract.product.xml.AbstractEvent
net.finmath.smartcontract.product.xml.OptionExercise
public class OptionExercise extends AbstractEvent
A structure describing an option exercise. The OptionExercise type supports partial exercise (specify the number of options or amount to exercise), full exercise (use fullExercise flag), as well as the option to request options not to be exercised.

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 Details

  • Constructor Details

    • OptionExercise

      public OptionExercise()

  • Method Details

    • getOptionSeller

      public PartyReference getOptionSeller()
      Gets the value of the optionSeller property.
      Returns:
      possible object is PartyReference

    • setOptionSeller

      public void setOptionSeller​(PartyReference value)
      Sets the value of the optionSeller property.
      Parameters:
      value - allowed object is PartyReference

    • getOptionBuyer

      public PartyReference getOptionBuyer()
      Gets the value of the optionBuyer property.
      Returns:
      possible object is PartyReference

    • setOptionBuyer

      public void setOptionBuyer​(PartyReference value)
      Sets the value of the optionBuyer property.
      Parameters:
      value - allowed object is PartyReference

    • getOriginalTrade

      public Trade getOriginalTrade()
      Gets the value of the originalTrade property.
      Returns:
      possible object is Trade

    • setOriginalTrade

      public void setOriginalTrade​(Trade value)
      Sets the value of the originalTrade property.
      Parameters:
      value - allowed object is Trade

    • getTradeIdentifier

      public List<PartyTradeIdentifier> 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 set method 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

      public XMLGregorianCalendar getExerciseDate()
      Gets the value of the exerciseDate property.
      Returns:
      possible object is XMLGregorianCalendar

    • setExerciseDate

      public void setExerciseDate​(XMLGregorianCalendar value)
      Sets the value of the exerciseDate property.
      Parameters:
      value - allowed object is XMLGregorianCalendar

    • getExerciseTime

      public XMLGregorianCalendar getExerciseTime()
      Gets the value of the exerciseTime property.
      Returns:
      possible object is XMLGregorianCalendar

    • setExerciseTime

      public void setExerciseTime​(XMLGregorianCalendar value)
      Sets the value of the exerciseTime property.
      Parameters:
      value - allowed object is XMLGregorianCalendar

    • getExerciseTiming

      public ExerciseTimingEnum getExerciseTiming()
      Gets the value of the exerciseTiming property.
      Returns:
      possible object is ExerciseTimingEnum

    • setExerciseTiming

      public void setExerciseTiming​(ExerciseTimingEnum value)
      Sets the value of the exerciseTiming property.
      Parameters:
      value - allowed object is ExerciseTimingEnum

    • getExerciseAction

      public ExerciseActionEnum getExerciseAction()
      Gets the value of the exerciseAction property.
      Returns:
      possible object is ExerciseActionEnum

    • setExerciseAction

      public void setExerciseAction​(ExerciseActionEnum value)
      Sets the value of the exerciseAction property.
      Parameters:
      value - allowed object is ExerciseActionEnum

    • isExpiry

      public Boolean isExpiry()
      Gets the value of the expiry property.
      Returns:
      possible object is Boolean

    • setExpiry

      public void setExpiry​(Boolean value)
      Sets the value of the expiry property.
      Parameters:
      value - allowed object is Boolean

    • isFullExercise

      public Boolean isFullExercise()
      Gets the value of the fullExercise property.
      Returns:
      possible object is Boolean

    • setFullExercise

      public void setFullExercise​(Boolean value)
      Sets the value of the fullExercise property.
      Parameters:
      value - allowed object is Boolean

    • getExerciseInNotionalAmount

      public Money getExerciseInNotionalAmount()
      Gets the value of the exerciseInNotionalAmount property.
      Returns:
      possible object is Money

    • setExerciseInNotionalAmount

      public void setExerciseInNotionalAmount​(Money value)
      Sets the value of the exerciseInNotionalAmount property.
      Parameters:
      value - allowed object is Money

    • getOutstandingNotionalAmount

      public Money getOutstandingNotionalAmount()
      Gets the value of the outstandingNotionalAmount property.
      Returns:
      possible object is Money

    • setOutstandingNotionalAmount

      public void setOutstandingNotionalAmount​(Money value)
      Sets the value of the outstandingNotionalAmount property.
      Parameters:
      value - allowed object is Money

    • getExerciseInNumberOfOptions

      public BigDecimal getExerciseInNumberOfOptions()
      Gets the value of the exerciseInNumberOfOptions property.
      Returns:
      possible object is BigDecimal

    • setExerciseInNumberOfOptions

      public void setExerciseInNumberOfOptions​(BigDecimal value)
      Sets the value of the exerciseInNumberOfOptions property.
      Parameters:
      value - allowed object is BigDecimal

    • getOutstandingNumberOfOptions

      public BigDecimal getOutstandingNumberOfOptions()
      Gets the value of the outstandingNumberOfOptions property.
      Returns:
      possible object is BigDecimal

    • setOutstandingNumberOfOptions

      public void setOutstandingNumberOfOptions​(BigDecimal value)
      Sets the value of the outstandingNumberOfOptions property.
      Parameters:
      value - allowed object is BigDecimal

    • getExerciseInNumberOfUnits

      public BigDecimal getExerciseInNumberOfUnits()
      Gets the value of the exerciseInNumberOfUnits property.
      Returns:
      possible object is BigDecimal

    • setExerciseInNumberOfUnits

      public void setExerciseInNumberOfUnits​(BigDecimal value)
      Sets the value of the exerciseInNumberOfUnits property.
      Parameters:
      value - allowed object is BigDecimal

    • getOutstandingNumberOfUnits

      public BigDecimal getOutstandingNumberOfUnits()
      Gets the value of the outstandingNumberOfUnits property.
      Returns:
      possible object is BigDecimal

    • setOutstandingNumberOfUnits

      public void setOutstandingNumberOfUnits​(BigDecimal value)
      Sets the value of the outstandingNumberOfUnits property.
      Parameters:
      value - allowed object is BigDecimal

    • getSpecifiedExercise

      public List<OptionExerciseAmounts> 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 set method 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

      public String getExerciseSide()
      Gets the value of the exerciseSide property.
      Returns:
      possible object is String

    • setExerciseSide

      public void setExerciseSide​(String value)
      Sets the value of the exerciseSide property.
      Parameters:
      value - allowed object is String

    • getSettlementType

      public SettlementTypeEnum getSettlementType()
      Gets the value of the settlementType property.
      Returns:
      possible object is SettlementTypeEnum

    • setSettlementType

      public void setSettlementType​(SettlementTypeEnum value)
      Sets the value of the settlementType property.
      Parameters:
      value - allowed object is SettlementTypeEnum

    • getCashSettlement

      public SimplePayment getCashSettlement()
      Gets the value of the cashSettlement property.
      Returns:
      possible object is SimplePayment

    • setCashSettlement

      public void setCashSettlement​(SimplePayment value)
      Sets the value of the cashSettlement property.
      Parameters:
      value - allowed object is SimplePayment

    • getPhysicalSettlement

      public PhysicalSettlement getPhysicalSettlement()
      Gets the value of the physicalSettlement property.
      Returns:
      possible object is PhysicalSettlement

    • setPhysicalSettlement

      public void setPhysicalSettlement​(PhysicalSettlement value)
      Sets the value of the physicalSettlement property.
      Parameters:
      value - allowed object is PhysicalSettlement

    • getPayment

      public NonNegativePayment getPayment()
      Gets the value of the payment property.
      Returns:
      possible object is NonNegativePayment

    • setPayment

      public void setPayment​(NonNegativePayment value)
      Sets the value of the payment property.
      Parameters:
      value - allowed object is NonNegativePayment

    • getClearingInstructions

      public ClearingInstructions getClearingInstructions()
      Gets the value of the clearingInstructions property.
      Returns:
      possible object is ClearingInstructions

    • setClearingInstructions

      public void setClearingInstructions​(ClearingInstructions value)
      Sets the value of the clearingInstructions property.
      Parameters:
      value - allowed object is ClearingInstructions