Package net.finmath.smartcontract.product.xml

Class GenericProduct

java.lang.Object
net.finmath.smartcontract.product.xml.Product
net.finmath.smartcontract.product.xml.GenericProduct
public class GenericProduct extends Product
Simple product representation providing key information about a variety of different products. Generic products - for use in Transparency reporting to define a product that represents an OTC derivative transaction whose economics are not fully described using an FpML schema. In other views, generic products are present for convenience to support internal messaging and workflows that are cross-product. Generic products are not full trade representations as such they are not intended to be used for confirming trades.

Java class for GenericProduct complex type.

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

 <complexType name="GenericProduct">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}Product">
       <sequence>
         <element name="multiLeg" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <choice minOccurs="0">
           <group ref="{http://www.fpml.org/FpML-5/confirmation}BuyerSeller.model"/>
           <element name="counterpartyReference" type="{http://www.fpml.org/FpML-5/confirmation}PartyReference" maxOccurs="2" minOccurs="0"/>
         </choice>
         <element name="premium" type="{http://www.fpml.org/FpML-5/confirmation}SimplePayment" minOccurs="0"/>
         <element name="effectiveDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableDate2"/>
         <element name="expirationDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableDate2" minOccurs="0"/>
         <element name="terminationDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableDate2"/>
         <element name="underlyer" type="{http://www.fpml.org/FpML-5/confirmation}TradeUnderlyer2" maxOccurs="unbounded" minOccurs="0"/>
         <element name="notional" type="{http://www.fpml.org/FpML-5/confirmation}CashflowNotional" maxOccurs="unbounded" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}GenericCommodityAttributes.model" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}GenericEquityAttributes.model" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}GenericOptionAttributes.model" minOccurs="0"/>
         <element name="paymentFrequency" type="{http://www.fpml.org/FpML-5/confirmation}GenericFrequency" maxOccurs="unbounded" minOccurs="0"/>
         <element name="resetFrequency" type="{http://www.fpml.org/FpML-5/confirmation}GenericResetFrequency" maxOccurs="unbounded" minOccurs="0"/>
         <element name="settlementCurrency" type="{http://www.fpml.org/FpML-5/confirmation}IdentifiedCurrency" maxOccurs="unbounded" minOccurs="0"/>
         <element name="settlementType" type="{http://www.fpml.org/FpML-5/confirmation}SettlementTypeEnum" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • GenericProduct

      public GenericProduct()

  • Method Details

    • isMultiLeg

      public Boolean isMultiLeg()
      Gets the value of the multiLeg property.
      Returns:
      possible object is Boolean

    • setMultiLeg

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

    • getBuyerPartyReference

      public PartyReference getBuyerPartyReference()
      Gets the value of the buyerPartyReference property.
      Returns:
      possible object is PartyReference

    • setBuyerPartyReference

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

    • getBuyerAccountReference

      public AccountReference getBuyerAccountReference()
      Gets the value of the buyerAccountReference property.
      Returns:
      possible object is AccountReference

    • setBuyerAccountReference

      public void setBuyerAccountReference​(AccountReference value)
      Sets the value of the buyerAccountReference property.
      Parameters:
      value - allowed object is AccountReference

    • getSellerPartyReference

      public PartyReference getSellerPartyReference()
      Gets the value of the sellerPartyReference property.
      Returns:
      possible object is PartyReference

    • setSellerPartyReference

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

    • getSellerAccountReference

      public AccountReference getSellerAccountReference()
      Gets the value of the sellerAccountReference property.
      Returns:
      possible object is AccountReference

    • setSellerAccountReference

      public void setSellerAccountReference​(AccountReference value)
      Sets the value of the sellerAccountReference property.
      Parameters:
      value - allowed object is AccountReference

    • getCounterpartyReference

      public List<PartyReference> getCounterpartyReference()
      Gets the value of the counterpartyReference 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 counterpartyReference property.

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

          getCounterpartyReference().add(newItem);

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

    • getPremium

      public SimplePayment getPremium()
      Gets the value of the premium property.
      Returns:
      possible object is SimplePayment

    • setPremium

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

    • getEffectiveDate

      public AdjustableDate2 getEffectiveDate()
      Gets the value of the effectiveDate property.
      Returns:
      possible object is AdjustableDate2

    • setEffectiveDate

      public void setEffectiveDate​(AdjustableDate2 value)
      Sets the value of the effectiveDate property.
      Parameters:
      value - allowed object is AdjustableDate2

    • getExpirationDate

      public AdjustableDate2 getExpirationDate()
      Gets the value of the expirationDate property.
      Returns:
      possible object is AdjustableDate2

    • setExpirationDate

      public void setExpirationDate​(AdjustableDate2 value)
      Sets the value of the expirationDate property.
      Parameters:
      value - allowed object is AdjustableDate2

    • getTerminationDate

      public AdjustableDate2 getTerminationDate()
      Gets the value of the terminationDate property.
      Returns:
      possible object is AdjustableDate2

    • setTerminationDate

      public void setTerminationDate​(AdjustableDate2 value)
      Sets the value of the terminationDate property.
      Parameters:
      value - allowed object is AdjustableDate2

    • getUnderlyer

      public List<TradeUnderlyer2> getUnderlyer()
      Gets the value of the underlyer 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 underlyer property.

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

          getUnderlyer().add(newItem);

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

    • getNotional

      public List<CashflowNotional> getNotional()
      Gets the value of the notional 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 notional property.

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

          getNotional().add(newItem);

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

    • getGrade

      public List<GenericCommodityGrade> getGrade()
      Gets the value of the grade 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 grade property.

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

          getGrade().add(newItem);

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

    • getSettlementPeriods

      public List<GenericCommodityDeliveryPeriod> getSettlementPeriods()
      Gets the value of the settlementPeriods 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 settlementPeriods property.

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

          getSettlementPeriods().add(newItem);

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

    • getLoadType

      public LoadTypeEnum getLoadType()
      Gets the value of the loadType property.
      Returns:
      possible object is LoadTypeEnum

    • setLoadType

      public void setLoadType​(LoadTypeEnum value)
      Sets the value of the loadType property.
      Parameters:
      value - allowed object is LoadTypeEnum

    • getQuantity

      public BigDecimal getQuantity()
      Gets the value of the quantity property.
      Returns:
      possible object is BigDecimal

    • setQuantity

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

    • getQuantityFrequency

      public CommodityQuantityFrequency getQuantityFrequency()
      Gets the value of the quantityFrequency property.
      Returns:
      possible object is CommodityQuantityFrequency

    • setQuantityFrequency

      public void setQuantityFrequency​(CommodityQuantityFrequency value)
      Sets the value of the quantityFrequency property.
      Parameters:
      value - allowed object is CommodityQuantityFrequency

    • getFixedPrice

      public FixedPrice getFixedPrice()
      Gets the value of the fixedPrice property.
      Returns:
      possible object is FixedPrice

    • setFixedPrice

      public void setFixedPrice​(FixedPrice value)
      Sets the value of the fixedPrice property.
      Parameters:
      value - allowed object is FixedPrice

    • getInterconnectionPoint

      public InterconnectionPoint getInterconnectionPoint()
      Gets the value of the interconnectionPoint property.
      Returns:
      possible object is InterconnectionPoint

    • setInterconnectionPoint

      public void setInterconnectionPoint​(InterconnectionPoint value)
      Sets the value of the interconnectionPoint property.
      Parameters:
      value - allowed object is InterconnectionPoint

    • getOptionEntitlement

      public BigDecimal getOptionEntitlement()
      Gets the value of the optionEntitlement property.
      Returns:
      possible object is BigDecimal

    • setOptionEntitlement

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

    • getNumberOfOptions

      public BigDecimal getNumberOfOptions()
      Gets the value of the numberOfOptions property.
      Returns:
      possible object is BigDecimal

    • setNumberOfOptions

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

    • getOptionType

      public OptionType getOptionType()
      Gets the value of the optionType property.
      Returns:
      possible object is OptionType

    • setOptionType

      public void setOptionType​(OptionType value)
      Sets the value of the optionType property.
      Parameters:
      value - allowed object is OptionType

    • getCommencementDate

      public AdjustableDate2 getCommencementDate()
      Gets the value of the commencementDate property.
      Returns:
      possible object is AdjustableDate2

    • setCommencementDate

      public void setCommencementDate​(AdjustableDate2 value)
      Sets the value of the commencementDate property.
      Parameters:
      value - allowed object is AdjustableDate2

    • getExerciseStyle

      public GenericExerciseStyle getExerciseStyle()
      Gets the value of the exerciseStyle property.
      Returns:
      possible object is GenericExerciseStyle

    • setExerciseStyle

      public void setExerciseStyle​(GenericExerciseStyle value)
      Sets the value of the exerciseStyle property.
      Parameters:
      value - allowed object is GenericExerciseStyle

    • getStrike

      public List<GenericOptionStrike> getStrike()
      Gets the value of the strike 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 strike property.

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

          getStrike().add(newItem);

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

    • getFeature

      public List<GenericProductFeature> getFeature()
      Gets the value of the feature 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 feature property.

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

          getFeature().add(newItem);

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

    • getPaymentFrequency

      public List<GenericFrequency> getPaymentFrequency()
      Gets the value of the paymentFrequency 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 paymentFrequency property.

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

          getPaymentFrequency().add(newItem);

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

    • getResetFrequency

      public List<GenericResetFrequency> getResetFrequency()
      Gets the value of the resetFrequency 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 resetFrequency property.

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

          getResetFrequency().add(newItem);

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

    • getSettlementCurrency

      public List<IdentifiedCurrency> getSettlementCurrency()
      Gets the value of the settlementCurrency 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 settlementCurrency property.

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

          getSettlementCurrency().add(newItem);

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

    • 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