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

Class QuotePartsDef.CommonFields.Builder

  • Enclosing class:
    QuotePartsDef.CommonFields
    public static final class QuotePartsDef.CommonFields.Builder
extends java.lang.Object

    • Method Detail

      • toString

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

      • setBidQuoteID

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidQuoteID​(@NotNull
                                                                 @NotNull java.lang.String bidQuoteID)
        Returns:
        A unique ID that identifies the bid side of this quote.

      • setAskQuoteID

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskQuoteID​(@NotNull
                                                                 @NotNull java.lang.String askQuoteID)
        Returns:
        A unique ID that identifies the ask side of this quote.

      • setBidIndicative

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidIndicative​(boolean bidIndicative)
        Returns:
        Determines whether the Bid price is indicative. Indicative prices cannot be executed upon

      • setBidIndicative

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidIndicative​(@NotNull
                                                                    @NotNull java.lang.String bidIndicative)
        Returns:
        Determines whether the Bid price is indicative. Indicative prices cannot be executed upon

      • setAskIndicative

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskIndicative​(boolean askIndicative)
        Returns:
        Determines whether the Ask price is indicative. Indicative prices cannot be executed upon

      • setAskIndicative

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskIndicative​(@NotNull
                                                                    @NotNull java.lang.String askIndicative)
        Returns:
        Determines whether the Ask price is indicative. Indicative prices cannot be executed upon

      • setGFA

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setGFA​(@NotNull
                                                          @NotNull java.lang.String gFA)
        Parameters:
        gFA - e.g. 1000000
        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

      • setTimePriceReceived

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setTimePriceReceived​(@NotNull
                                                                        @NotNull java.lang.String timePriceReceived)
        Returns:
        The time a price was received from the liquidity provider

      • setDigitsBeforePips

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setDigitsBeforePips​(int digitsBeforePips)
        Parameters:
        digitsBeforePips - e.g. 2
        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.

      • setDigitsBeforePips

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setDigitsBeforePips​(@NotNull
                                                                       @NotNull java.lang.String digitsBeforePips)
        Parameters:
        digitsBeforePips - e.g. 2
        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.

      • setNumberOfPips

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setNumberOfPips​(int numberOfPips)
        Parameters:
        numberOfPips - e.g. 2
        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.

      • setNumberOfPips

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setNumberOfPips​(@NotNull
                                                                   @NotNull java.lang.String numberOfPips)
        Parameters:
        numberOfPips - e.g. 2
        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.

      • setSpotBidRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setSpotBidRate​(@NotNull
                                                                  @NotNull java.math.BigDecimal spotBidRate)
        Parameters:
        spotBidRate - e.g. 1.08341
        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.

      • setSpotBidRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setSpotBidRate​(@NotNull
                                                                  @NotNull java.lang.String spotBidRate)
        Parameters:
        spotBidRate - e.g. 1.08341
        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.

      • setSpotMidRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setSpotMidRate​(@NotNull
                                                                  @NotNull java.math.BigDecimal spotMidRate)
        Parameters:
        spotMidRate - e.g. 1.08345
        Returns:
        The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.

      • setSpotMidRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setSpotMidRate​(@NotNull
                                                                  @NotNull java.lang.String spotMidRate)
        Parameters:
        spotMidRate - e.g. 1.08345
        Returns:
        The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.

      • setSpotAskRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setSpotAskRate​(@NotNull
                                                                  @NotNull java.math.BigDecimal spotAskRate)
        Parameters:
        spotAskRate - e.g. 1.08349
        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.

      • setSpotAskRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setSpotAskRate​(@NotNull
                                                                  @NotNull java.lang.String spotAskRate)
        Parameters:
        spotAskRate - e.g. 1.08349
        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.

      • setSpotRateDPS

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setSpotRateDPS​(int spotRateDPS)
        Parameters:
        spotRateDPS - e.g. 5
        Returns:
        The number of decimal places to display after the decimal point.

      • setSpotRateDPS

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setSpotRateDPS​(@NotNull
                                                                  @NotNull java.lang.String spotRateDPS)
        Parameters:
        spotRateDPS - e.g. 5
        Returns:
        The number of decimal places to display after the decimal point.

      • setOverallTimeOut

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setOverallTimeOut​(int overallTimeOut)
        Returns:
        The number of seconds remaining before this stream (not this individual quote) is timed out. This is not present for standard price updates.

      • setOverallTimeOut

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setOverallTimeOut​(@NotNull
                                                                     @NotNull java.lang.String overallTimeOut)
        Returns:
        The number of seconds remaining before this stream (not this individual quote) is timed out. This is not present for standard price updates.

      • setRemainingTimeOutMillis

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setRemainingTimeOutMillis​(int remainingTimeOutMillis)
        Returns:
        The number of seconds remaining of the OverallTimeOut before this stream is timed out. This is not present for standard price updates.

      • setRemainingTimeOutMillis

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setRemainingTimeOutMillis​(@NotNull
                                                                             @NotNull java.lang.String remainingTimeOutMillis)
        Returns:
        The number of seconds remaining of the OverallTimeOut before this stream is timed out. This is not present for standard price updates.

      • setWarningCode

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setWarningCode​(@NotNull
                                                                  @NotNull java.lang.String warningCode)
        Parameters:
        warningCode - e.g. 001
        Returns:
        The code for the warning regarding a quote request.

      • setWarningMessage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setWarningMessage​(@NotNull
                                                                     @NotNull java.lang.String warningMessage)
        Parameters:
        warningMessage - e.g. You do not have sufficient credit for EUR
        Returns:
        The message to display for any warnings regarding a quote request

      • setNumberOfFractionalPips

        @Deprecated
@NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setNumberOfFractionalPips​(@NotNull
                                                                             @NotNull java.lang.String numberOfFractionalPips)
        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.

      • setBidPips

        @Deprecated
@NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidPips​(@NotNull
                                                              @NotNull java.lang.String bidPips)
        Deprecated.
        Parameters:
        bidPips - e.g. 11.98
        Returns:
        bidPips

      • setAskPips

        @Deprecated
@NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskPips​(@NotNull
                                                              @NotNull java.lang.String askPips)
        Deprecated.
        Parameters:
        askPips - e.g. 11.98
        Returns:
        askPips

      • setSwapGFA

        @Deprecated
@NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setSwapGFA​(@NotNull
                                                              @NotNull java.lang.String swapGFA)
        Deprecated.
        Parameters:
        swapGFA - e.g. 1 000 000
        Returns:
        swapGFA

      • setCurrencyPair

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setCurrencyPair​(@NotNull
                                                                   @NotNull java.lang.String currencyPair)
        Returns:
        The currency pair for the trade. For example, EURUSD

      • setBidCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidCostAmount​(@NotNull
                                                                    @NotNull java.math.BigDecimal bidCostAmount)
        Parameters:
        bidCostAmount - e.g. 150000.00
        Returns:
        The total amount on the bid side of the trade when requesting a quote

      • setBidCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidCostAmount​(@NotNull
                                                                    @NotNull java.lang.String bidCostAmount)
        Parameters:
        bidCostAmount - e.g. 150000.00
        Returns:
        The total amount on the bid side of the trade when requesting a quote

      • setBidCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidCostPercentage​(@NotNull
                                                                        @NotNull java.math.BigDecimal bidCostPercentage)
        Parameters:
        bidCostPercentage - e.g. 1.5
        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%.

      • setBidCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidCostPercentage​(@NotNull
                                                                        @NotNull java.lang.String bidCostPercentage)
        Parameters:
        bidCostPercentage - e.g. 1.5
        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%.

      • setCostCurrency

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setCostCurrency​(@NotNull
                                                                   @NotNull java.lang.String costCurrency)
        Parameters:
        costCurrency - e.g. GBP
        Returns:
        The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency

      • setAskCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskCostAmount​(@NotNull
                                                                    @NotNull java.math.BigDecimal askCostAmount)
        Parameters:
        askCostAmount - e.g. 150000.00
        Returns:
        The total amount on the ask side of the trade when requesting a quote

      • setAskCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskCostAmount​(@NotNull
                                                                    @NotNull java.lang.String askCostAmount)
        Parameters:
        askCostAmount - e.g. 150000.00
        Returns:
        The total amount on the ask side of the trade when requesting a quote

      • setAskCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskCostPercentage​(@NotNull
                                                                        @NotNull java.math.BigDecimal askCostPercentage)
        Parameters:
        askCostPercentage - e.g. 1.5
        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%.

      • setAskCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskCostPercentage​(@NotNull
                                                                        @NotNull java.lang.String askCostPercentage)
        Parameters:
        askCostPercentage - e.g. 1.5
        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%.

      • setAskCostRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskCostRate​(@NotNull
                                                                  @NotNull java.math.BigDecimal askCostRate)
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • setAskCostRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskCostRate​(@NotNull
                                                                  @NotNull java.lang.String askCostRate)
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • setBidCostRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidCostRate​(@NotNull
                                                                  @NotNull java.math.BigDecimal bidCostRate)
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • setBidCostRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidCostRate​(@NotNull
                                                                  @NotNull java.lang.String bidCostRate)
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • setCostCurrencyDPS

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setCostCurrencyDPS​(int costCurrencyDPS)
        Parameters:
        costCurrencyDPS - e.g. 2
        Returns:
        The number of decimal places to display after the decimal point.

      • setCostCurrencyDPS

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setCostCurrencyDPS​(@NotNull
                                                                      @NotNull java.lang.String costCurrencyDPS)
        Parameters:
        costCurrencyDPS - e.g. 2
        Returns:
        The number of decimal places to display after the decimal point.

      • setPriceUpdateSource

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setPriceUpdateSource​(@NotNull
                                                                        @NotNull java.lang.String priceUpdateSource)
        Returns:
        The name of the adapter a particular price update originated from.

      • setAskContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskContraCostAmount​(@NotNull
                                                                          @NotNull java.math.BigDecimal askContraCostAmount)
        Returns:
        The total amount on the ask side of the trade when requesting a quote seen in contra currency

      • setAskContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskContraCostAmount​(@NotNull
                                                                          @NotNull java.lang.String askContraCostAmount)
        Returns:
        The total amount on the ask side of the trade when requesting a quote seen in contra currency

      • setAskContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskContraCostPercentage​(@NotNull
                                                                              @NotNull java.math.BigDecimal askContraCostPercentage)
        Parameters:
        askContraCostPercentage - e.g. 1.5
        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%.

      • setAskContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskContraCostPercentage​(@NotNull
                                                                              @NotNull java.lang.String askContraCostPercentage)
        Parameters:
        askContraCostPercentage - e.g. 1.5
        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%.

      • setAskContraCostRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskContraCostRate​(@NotNull
                                                                        @NotNull java.math.BigDecimal askContraCostRate)
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • setAskContraCostRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setAskContraCostRate​(@NotNull
                                                                        @NotNull java.lang.String askContraCostRate)
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • setBidContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidContraCostAmount​(@NotNull
                                                                          @NotNull java.math.BigDecimal bidContraCostAmount)
        Returns:
        The total amount on the bid side of the trade when requesting a quote seen in contra currency

      • setBidContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidContraCostAmount​(@NotNull
                                                                          @NotNull java.lang.String bidContraCostAmount)
        Returns:
        The total amount on the bid side of the trade when requesting a quote seen in contra currency

      • setBidContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidContraCostPercentage​(@NotNull
                                                                              @NotNull java.math.BigDecimal bidContraCostPercentage)
        Parameters:
        bidContraCostPercentage - e.g. 1.5
        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%.

      • setBidContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidContraCostPercentage​(@NotNull
                                                                              @NotNull java.lang.String bidContraCostPercentage)
        Parameters:
        bidContraCostPercentage - e.g. 1.5
        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%.

      • setBidContraCostRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidContraCostRate​(@NotNull
                                                                        @NotNull java.math.BigDecimal bidContraCostRate)
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • setBidContraCostRate

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setBidContraCostRate​(@NotNull
                                                                        @NotNull java.lang.String bidContraCostRate)
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • setContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setContraCostAmount​(@NotNull
                                                                       @NotNull java.math.BigDecimal contraCostAmount)
        Returns:
        The actual transactional cost of performing the trade to the client on the contra currency

      • setContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setContraCostAmount​(@NotNull
                                                                       @NotNull java.lang.String contraCostAmount)
        Returns:
        The actual transactional cost of performing the trade to the client on the contra currency

      • setContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setContraCostPercentage​(@NotNull
                                                                           @NotNull java.math.BigDecimal contraCostPercentage)
        Parameters:
        contraCostPercentage - e.g. 13.56
        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%.

      • setContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setContraCostPercentage​(@NotNull
                                                                           @NotNull java.lang.String contraCostPercentage)
        Parameters:
        contraCostPercentage - e.g. 13.56
        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%.

      • setContraCostCurrency

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setContraCostCurrency​(@NotNull
                                                                         @NotNull java.math.BigDecimal contraCostCurrency)
        Returns:
        The contra currency that the cost is displayed in

      • setContraCostCurrency

        @NotNull
public @NotNull QuotePartsDef.CommonFields.Builder setContraCostCurrency​(@NotNull
                                                                         @NotNull java.lang.String contraCostCurrency)
        Returns:
        The contra currency that the cost is displayed in