Package com.caplin.generated.motif.fx.rates

Class QuotePartsDef.LegFields

java.lang.Object
com.caplin.generated.motif.fx.rates.QuotePartsDef.LegFields
All Implemented Interfaces:
BuilderMessage, Message
Enclosing class:
QuotePartsDef
public static final class QuotePartsDef.LegFields extends Object implements BuilderMessage

  • Method Details

    • getTenor

      @Nullable public @Nullable String getTenor()
      Returns:
      Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. 'broken' indicates that the settlement date does not fall onto a tenor.

    • getRiskDate

      @Nullable public @Nullable String getRiskDate()
      Returns:
      The date in the settlement window which yields the lowest client sell price, or the highest client buy price.

    • getRiskTenor

      @Nullable public @Nullable String getRiskTenor()
      Returns:
      The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.

    • getSettlementDate

      @Nullable public @Nullable String getSettlementDate()
      Returns:
      settlementDate

    • getIsTimeOption

      @Nullable public @Nullable Boolean getIsTimeOption()
      Returns:
      true if a leg is time-option

    • getStartTenor

      @Nullable public @Nullable String getStartTenor()
      Returns:
      startTenor e.g. 1W

    • getStartDate

      @Nullable public @Nullable String getStartDate()
      Returns:
      startDate e.g. 20150620

    • getAllInRateDPS

      @Nullable public @Nullable Integer getAllInRateDPS()
      Returns:
      The number of decimal places to display after the decimal point.

    • getAllInBidRate

      @Nullable public @Nullable BigDecimal getAllInBidRate()
      Returns:
      The bid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

    • getFwdBidPoints

      @Nullable public @Nullable BigDecimal getFwdBidPoints()
      Returns:
      The number of basis points added to or subtracted from the bid rate to determine the forward rate for delivery on a specific value date.

    • getAllInAskRate

      @Nullable public @Nullable BigDecimal getAllInAskRate()
      Returns:
      The ask rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

    • getFwdAskPoints

      @Nullable public @Nullable BigDecimal getFwdAskPoints()
      Returns:
      The number of basis points added to or subtracted from the ask rate to determine the forward rate for delivery on a specific value date.

    • getFwdMidPoints

      @Nullable public @Nullable BigDecimal getFwdMidPoints()
      Returns:
      The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.

    • getFwdBidPips

      @Deprecated @Nullable public @Nullable String getFwdBidPips()
      Deprecated.
      Returns:
      fwdBidPips e.g. 53.90

    • getFwdAskPips

      @Deprecated @Nullable public @Nullable String getFwdAskPips()
      Deprecated.
      Returns:
      fwdAskPips e.g. 53.90

    • getAllInMidRate

      @Nullable public @Nullable BigDecimal getAllInMidRate()
      Returns:
      The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

    • getAmount

      @Nullable public @Nullable BigDecimal getAmount()
      Returns:
      The amount of a trade or order in the DealtCurrency.

    • getBuySell

      @Nullable public @Nullable String getBuySell()
      Returns:
      The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.

    • getCostCurrency

      @Nullable public @Nullable String getCostCurrency()
      Returns:
      The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency

    • getBidCostAmount

      @Nullable public @Nullable BigDecimal getBidCostAmount()
      Returns:
      The total amount on the bid side of the trade when requesting a quote

    • getBidCostPercentage

      @Nullable public @Nullable BigDecimal getBidCostPercentage()
      Returns:
      Percentage of the overall price which is the transactional cost to the client of performing the trade, displayed on the bid side. This number should be out of 100, where 100.0 represents 100%.

    • getBidCostRate

      @Nullable public @Nullable BigDecimal getBidCostRate()
      Returns:
      The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

    • getAskCostAmount

      @Nullable public @Nullable BigDecimal getAskCostAmount()
      Returns:
      The total amount on the ask side of the trade when requesting a quote

    • getAskCostPercentage

      @Nullable public @Nullable BigDecimal getAskCostPercentage()
      Returns:
      Percentage of the overall price which is the transactional cost to the client of performing the trade, displayed on the ask side. This number should be out of 100, where 100.0 represents 100%.

    • getAskCostRate

      @Nullable public @Nullable BigDecimal getAskCostRate()
      Returns:
      The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

    • getAskContraCostAmount

      @Nullable public @Nullable BigDecimal getAskContraCostAmount()
      Returns:
      The total amount on the ask side of the trade when requesting a quote seen in contra currency

    • getAskContraCostPercentage

      @Nullable public @Nullable BigDecimal getAskContraCostPercentage()
      Returns:
      Percentage of the overall price which is the transactional cost to the client of performing the trade, displayed on the ask side in contra currency. This number should be out of 100, where 100.0 represents 100%.

    • getAskContraCostRate

      @Nullable public @Nullable BigDecimal getAskContraCostRate()
      Returns:
      The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

    • getBidContraCostAmount

      @Nullable public @Nullable BigDecimal getBidContraCostAmount()
      Returns:
      The total amount on the bid side of the trade when requesting a quote seen in contra currency

    • getBidContraCostPercentage

      @Nullable public @Nullable BigDecimal getBidContraCostPercentage()
      Returns:
      Percentage of the overall price which is the transactional cost to the client of performing the trade, displayed on the bid side in cost currency. This number should be out of 100, where 100.0 represents 100%.

    • getBidContraCostRate

      @Nullable public @Nullable BigDecimal getBidContraCostRate()
      Returns:
      The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

    • getContraCostAmount

      @Nullable public @Nullable BigDecimal getContraCostAmount()
      Returns:
      The actual transactional cost of performing the trade to the client on the contra currency

    • getContraCostPercentage

      @Nullable public @Nullable BigDecimal getContraCostPercentage()
      Returns:
      Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.

    • getContraCostCurrency

      @Nullable public @Nullable String getContraCostCurrency()
      Returns:
      The contra currency that the cost is displayed in

    • getForwardPointsDecimalOffset

      @Nullable public @Nullable Integer getForwardPointsDecimalOffset()
      Returns:
      Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.

    • getFields

      @NotNull public @NotNull Map<String,String> getFields()
      Specified by:
      getFields in interface Message

    • getFieldFlags

      @NotNull public @NotNull Map<String,Collection<String>> getFieldFlags()
      Specified by:
      getFieldFlags in interface BuilderMessage
      Returns:
      Get the flags for all fields.

    • getFlagFields

      @NotNull public @NotNull Map<String,Collection<String>> getFlagFields()
      Specified by:
      getFlagFields in interface BuilderMessage
      Returns:
      Get the fields for all flags.

    • toString

      @NotNull public @NotNull String toString()
      Overrides:
      toString in class Object

    • from

      @NotNull public static @NotNull QuotePartsDef.LegFields from(@NotNull @NotNull Map<String,String> fields)

    • from

      @NotNull public static @NotNull QuotePartsDef.LegFields from(@NotNull @NotNull Map<String,String> fields, @NotNull @NotNull String fieldPrefix)

    • newBuilder

      @NotNull public static @NotNull QuotePartsDef.LegFields.Builder newBuilder()