Package net.finmath.smartcontract.product.xml

Class MultipleExercise

java.lang.Object
net.finmath.smartcontract.product.xml.MultipleExercise
public class MultipleExercise extends Object
A type defining multiple exercises. As defining in the 2000 ISDA Definitions, Section 12.4. Multiple Exercise, the buyer of the option has the right to exercise all or less than all the unexercised notional amount of the underlying swap on one or more days in the exercise period, but on any such day may not exercise less than the minimum notional amount or more than the maximum notional amount, and if an integral multiple amount is specified, the notional exercised must be equal to or, be an integral multiple of, the integral multiple amount.

Java class for MultipleExercise complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="MultipleExercise">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}PartialExercise.model"/>
         <choice minOccurs="0">
           <element name="maximumNotionalAmount" type="{http://www.w3.org/2001/XMLSchema}decimal"/>
           <element name="maximumNumberOfOptions" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeDecimal"/>
         </choice>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • notionalReference

      protected List<NotionalReference> notionalReference

    • integralMultipleAmount

      protected BigDecimal integralMultipleAmount

    • minimumNotionalAmount

      protected BigDecimal minimumNotionalAmount

    • minimumNumberOfOptions

      protected BigInteger minimumNumberOfOptions

    • maximumNotionalAmount

      protected BigDecimal maximumNotionalAmount

    • maximumNumberOfOptions

      protected BigDecimal maximumNumberOfOptions

  • Constructor Details

    • MultipleExercise

      public MultipleExercise()

  • Method Details

    • getNotionalReference

      public List<NotionalReference> getNotionalReference()
      Gets the value of the notionalReference 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 notionalReference property.

      For example, to add a new item, do as follows: 

          getNotionalReference().add(newItem);

      Objects of the following type(s) are allowed in the list NotionalReference

    • getIntegralMultipleAmount

      public BigDecimal getIntegralMultipleAmount()
      Gets the value of the integralMultipleAmount property.
      Returns:
      possible object is BigDecimal

    • setIntegralMultipleAmount

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

    • getMinimumNotionalAmount

      public BigDecimal getMinimumNotionalAmount()
      Gets the value of the minimumNotionalAmount property.
      Returns:
      possible object is BigDecimal

    • setMinimumNotionalAmount

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

    • getMinimumNumberOfOptions

      public BigInteger getMinimumNumberOfOptions()
      Gets the value of the minimumNumberOfOptions property.
      Returns:
      possible object is BigInteger

    • setMinimumNumberOfOptions

      public void setMinimumNumberOfOptions​(BigInteger value)
      Sets the value of the minimumNumberOfOptions property.
      Parameters:
      value - allowed object is BigInteger

    • getMaximumNotionalAmount

      public BigDecimal getMaximumNotionalAmount()
      Gets the value of the maximumNotionalAmount property.
      Returns:
      possible object is BigDecimal

    • setMaximumNotionalAmount

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

    • getMaximumNumberOfOptions

      public BigDecimal getMaximumNumberOfOptions()
      Gets the value of the maximumNumberOfOptions property.
      Returns:
      possible object is BigDecimal

    • setMaximumNumberOfOptions

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