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

Class QuotePartsDef.CommonFields

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

  • Method Details

    • getBidQuoteID

      @Nullable public @Nullable String getBidQuoteID()
      Returns:
      A unique ID that identifies the bid side of this quote.

    • getAskQuoteID

      @Nullable public @Nullable String getAskQuoteID()
      Returns:
      A unique ID that identifies the ask side of this quote.

    • getBidIndicative

      @Nullable public @Nullable Boolean getBidIndicative()
      Returns:
      Determines whether the Bid price is indicative. Indicative prices cannot be executed upon

    • getAskIndicative

      @Nullable public @Nullable Boolean getAskIndicative()
      Returns:
      Determines whether the Ask price is indicative. Indicative prices cannot be executed upon

    • getGFA

      @Nullable public @Nullable String getGFA()
      Returns:
      The maximum amount that a quote can be executed for. If the client wishes to quote for more than this, they must perform an RFS

    • getTimePriceReceived

      @Nullable public @Nullable String getTimePriceReceived()
      Returns:
      The time the price is received from the liquidity provider, in epoch milliseconds.

    • getDigitsBeforePips

      @Nullable public @Nullable Integer getDigitsBeforePips()
      Returns:
      Precision-related field that tells the client how to display rates. This is the number of digits between the decimal point and the pips (i.e the big digits that the client wants to look at). For most currency pairs the value of this field will be 2, i.e. for a USDGBP rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.

    • getNumberOfPips

      @Nullable public @Nullable Integer getNumberOfPips()
      Returns:
      Precision-related field that tells the client how to display rates. This is the number of pips the client wants to look at. Normally this value is 2.

    • getSpotBidRate

      @Nullable public @Nullable BigDecimal getSpotBidRate()
      Returns:
      For SPOT quotes this value will be identical to the L1_AllInBidRate. For forward quotes this will contain the SPOT rate that the forward all-in rate was derived from. For forward quotes the value in this field should always equal L1_AllInBidRate - L1_FwdBidPoints.

    • getSpotMidRate

      @Nullable public @Nullable BigDecimal getSpotMidRate()
      Returns:
      The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.

    • getSpotAskRate

      @Nullable public @Nullable BigDecimal getSpotAskRate()
      Returns:
      For SPOT quotes this value will be identical to the L1_AllInAskRate. For forward quotes this will contain the SPOT rate that the forward all-in rate was derived from. For forward quotes the value in this field should always equal L1_AllInAskRate - L1_FwdAskPoints.

    • getSpotRateDPS

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

    • getOverallTimeOut

      @Nullable public @Nullable Integer getOverallTimeOut()
      Returns:
      The number of seconds remaining before this stream (not this individual quote) is timed out. This is not present for standard price updates.

    • getRemainingTimeOutMillis

      @Nullable public @Nullable Integer getRemainingTimeOutMillis()
      Returns:
      The number of seconds remaining of the OverallTimeOut before this stream is timed out. This is not present for standard price updates.

    • getWarningCode

      @Nullable public @Nullable String getWarningCode()
      Returns:
      The code for the warning regarding a quote request.

    • getWarningMessage

      @Nullable public @Nullable String getWarningMessage()
      Returns:
      The message to display for any warnings regarding a quote request. Supports Markdown syntax for formatting.

    • getDetailedWarningMessage

      @Nullable public @Nullable String getDetailedWarningMessage()
      Returns:
      detailedWarningMessage e.g. color: {{theme:foreground.semantic.warning_inverse}}

    • getNumberOfFractionalPips

      @Deprecated @Nullable public @Nullable String getNumberOfFractionalPips()
      Deprecated.
      Returns:
      Precision-related field that tells the client how to display rates. This is the number of digits after the pips. For example, for a USDGBP rate of 1.23456 the pips are the 45 and there is one digit (the 6) after the pips, so the value of the NumberOfFractionalPips field should be 1. There are typically more fractional pips on forward rates than spot rates.

    • getBidPips

      @Deprecated @Nullable public @Nullable String getBidPips()
      Deprecated.
      Returns:
      bidPips e.g. 11.98

    • getAskPips

      @Deprecated @Nullable public @Nullable String getAskPips()
      Deprecated.
      Returns:
      askPips e.g. 11.98

    • getSwapGFA

      @Deprecated @Nullable public @Nullable String getSwapGFA()
      Deprecated.
      Returns:
      swapGFA e.g. 1 000 000

    • getCurrencyPair

      @Nullable public @Nullable String getCurrencyPair()
      Returns:
      The currency pair for the trade. For example, EURUSD

    • 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%.

    • 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

    • 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.

    • getBidCostRate

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

    • getCostCurrencyDPS

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

    • getPriceUpdateSource

      @Nullable public @Nullable String getPriceUpdateSource()
      Returns:
      The name of the adapter a particular price update originated from.

    • 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

    • 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.CommonFields from(@NotNull @NotNull Map<String,String> fields)

    • from

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

    • newBuilder

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