Package net.finmath.smartcontract.product.xml

Class TradeUnderlyer2

java.lang.Object
net.finmath.smartcontract.product.xml.TradeUnderlyer2
public class TradeUnderlyer2 extends Object
The underlying asset/index/reference price etc. whose rate/price may be observed to compute the value of the cashflow. It can be an index, fixed rate, listed security, quoted currency pair, or a reference entity (for credit derivatives). For use with Generic products in Transparency reporting. Generic products 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 TradeUnderlyer2 complex type.

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

 <complexType name="TradeUnderlyer2">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <element name="floatingRate" type="{http://www.fpml.org/FpML-5/confirmation}FloatingRate"/>
           <element name="fixedRate" type="{http://www.fpml.org/FpML-5/confirmation}Schedule"/>
           <element name="exchangeRate" type="{http://www.fpml.org/FpML-5/confirmation}GenericProductExchangeRate"/>
           <element ref="{http://www.fpml.org/FpML-5/confirmation}underlyingAsset"/>
           <element name="quotedCurrencyPair" type="{http://www.fpml.org/FpML-5/confirmation}QuotedCurrencyPair"/>
           <element name="referenceEntity" type="{http://www.fpml.org/FpML-5/confirmation}LegalEntity"/>
         </choice>
         <element name="averagingMethod" type="{http://www.fpml.org/FpML-5/confirmation}AveragingMethodEnum" minOccurs="0"/>
         <choice minOccurs="0">
           <group ref="{http://www.fpml.org/FpML-5/confirmation}PayerReceiver.model"/>
           <group ref="{http://www.fpml.org/FpML-5/confirmation}BuyerSeller.model"/>
         </choice>
         <element name="dayCountFraction" type="{http://www.fpml.org/FpML-5/confirmation}DayCountFraction" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • TradeUnderlyer2

      public TradeUnderlyer2()

  • Method Details

    • getFloatingRate

      public FloatingRate getFloatingRate()
      Gets the value of the floatingRate property.
      Returns:
      possible object is FloatingRate

    • setFloatingRate

      public void setFloatingRate​(FloatingRate value)
      Sets the value of the floatingRate property.
      Parameters:
      value - allowed object is FloatingRate

    • getFixedRate

      public Schedule getFixedRate()
      Gets the value of the fixedRate property.
      Returns:
      possible object is Schedule

    • setFixedRate

      public void setFixedRate​(Schedule value)
      Sets the value of the fixedRate property.
      Parameters:
      value - allowed object is Schedule

    • getExchangeRate

      public GenericProductExchangeRate getExchangeRate()
      Gets the value of the exchangeRate property.
      Returns:
      possible object is GenericProductExchangeRate

    • setExchangeRate

      public void setExchangeRate​(GenericProductExchangeRate value)
      Sets the value of the exchangeRate property.
      Parameters:
      value - allowed object is GenericProductExchangeRate

    • getUnderlyingAsset

      public jakarta.xml.bind.JAXBElement<? extends Asset> getUnderlyingAsset()
      Define the underlying asset, either a listed security or other instrument.
      Returns:
      possible object is JAXBElement<EquityAsset> JAXBElement<Future> JAXBElement<Cash> JAXBElement<Loan> JAXBElement<Bond> JAXBElement<ConvertibleBond> JAXBElement<Basket> JAXBElement<Commodity> JAXBElement<ExchangeTradedFund> JAXBElement<Index> JAXBElement<MutualFund> JAXBElement<Mortgage> JAXBElement<ExchangeTradedOption> JAXBElement<Asset>

    • setUnderlyingAsset

      public void setUnderlyingAsset​(jakarta.xml.bind.JAXBElement<? extends Asset> value)
      Sets the value of the underlyingAsset property.
      Parameters:
      value - allowed object is JAXBElement<EquityAsset> JAXBElement<Future> JAXBElement<Cash> JAXBElement<Loan> JAXBElement<Bond> JAXBElement<ConvertibleBond> JAXBElement<Basket> JAXBElement<Commodity> JAXBElement<ExchangeTradedFund> JAXBElement<Index> JAXBElement<MutualFund> JAXBElement<Mortgage> JAXBElement<ExchangeTradedOption> JAXBElement<Asset>

    • getQuotedCurrencyPair

      public QuotedCurrencyPair getQuotedCurrencyPair()
      Gets the value of the quotedCurrencyPair property.
      Returns:
      possible object is QuotedCurrencyPair

    • setQuotedCurrencyPair

      public void setQuotedCurrencyPair​(QuotedCurrencyPair value)
      Sets the value of the quotedCurrencyPair property.
      Parameters:
      value - allowed object is QuotedCurrencyPair

    • getReferenceEntity

      public LegalEntity getReferenceEntity()
      Gets the value of the referenceEntity property.
      Returns:
      possible object is LegalEntity

    • setReferenceEntity

      public void setReferenceEntity​(LegalEntity value)
      Sets the value of the referenceEntity property.
      Parameters:
      value - allowed object is LegalEntity

    • getAveragingMethod

      public AveragingMethodEnum getAveragingMethod()
      Gets the value of the averagingMethod property.
      Returns:
      possible object is AveragingMethodEnum

    • setAveragingMethod

      public void setAveragingMethod​(AveragingMethodEnum value)
      Sets the value of the averagingMethod property.
      Parameters:
      value - allowed object is AveragingMethodEnum

    • getPayerPartyReference

      public PartyReference getPayerPartyReference()
      Gets the value of the payerPartyReference property.
      Returns:
      possible object is PartyReference

    • setPayerPartyReference

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

    • getPayerAccountReference

      public AccountReference getPayerAccountReference()
      Gets the value of the payerAccountReference property.
      Returns:
      possible object is AccountReference

    • setPayerAccountReference

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

    • getReceiverPartyReference

      public PartyReference getReceiverPartyReference()
      Gets the value of the receiverPartyReference property.
      Returns:
      possible object is PartyReference

    • setReceiverPartyReference

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

    • getReceiverAccountReference

      public AccountReference getReceiverAccountReference()
      Gets the value of the receiverAccountReference property.
      Returns:
      possible object is AccountReference

    • setReceiverAccountReference

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

    • 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

    • getDayCountFraction

      public DayCountFraction getDayCountFraction()
      Gets the value of the dayCountFraction property.
      Returns:
      possible object is DayCountFraction

    • setDayCountFraction

      public void setDayCountFraction​(DayCountFraction value)
      Sets the value of the dayCountFraction property.
      Parameters:
      value - allowed object is DayCountFraction

    • getId

      public String getId()
      Gets the value of the id property.
      Returns:
      possible object is String

    • setId

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