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

Class QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder

java.lang.Object
com.caplin.generated.motif.fx.rates.QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder
Enclosing class:
QuoteUnavailablePartsDef.QuoteUnavailableCommonFields
public static final class QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder extends Object

  • Method Details

    • addField

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value)

    • build

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields build()

    • toString

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

    • setDigitsBeforePips

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.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 QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setDigitsBeforePips(@NotNull @NotNull 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 QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.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 QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setNumberOfPips(@NotNull @NotNull 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.

    • setSpotRateDPS

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.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 QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setSpotRateDPS(@NotNull @NotNull String spotRateDPS)
      Parameters:
      spotRateDPS - e.g. 5
      Returns:
      The number of decimal places to display after the decimal point.

    • setCurrencyPair

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setCurrencyPair(@NotNull @NotNull String currencyPair)
      Returns:
      The currency pair for the trade. For example, EURUSD

    • setProfitCurrency

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setProfitCurrency(@NotNull @NotNull String profitCurrency)
      Parameters:
      profitCurrency - e.g. USD
      Returns:
      The profit currency that the ProfitBidRate is being provided for.

    • setProfitCurrencyDPS

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setProfitCurrencyDPS(int profitCurrencyDPS)
      Parameters:
      profitCurrencyDPS - e.g. 5
      Returns:
      The number of decimal places that should be used for formatting the amount in profit currency field.

    • setProfitCurrencyDPS

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setProfitCurrencyDPS(@NotNull @NotNull String profitCurrencyDPS)
      Parameters:
      profitCurrencyDPS - e.g. 5
      Returns:
      The number of decimal places that should be used for formatting the amount in profit currency field.

    • setProfitIsHouse

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setProfitIsHouse(boolean profitIsHouse)
      Returns:
      Whether the field ProfitCurrency is the system/house currency or not.

    • setProfitIsHouse

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setProfitIsHouse(@NotNull @NotNull String profitIsHouse)
      Returns:
      Whether the field ProfitCurrency is the system/house currency or not.

    • setProfitBidRate

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setProfitBidRate(@NotNull @NotNull BigDecimal profitBidRate)
      Parameters:
      profitBidRate - e.g. 1.091790
      Returns:
      The conversion rate between the contra currency and the profit currency. This can be used for entering profit in an amount of settlement currency.

    • setProfitBidRate

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setProfitBidRate(@NotNull @NotNull String profitBidRate)
      Parameters:
      profitBidRate - e.g. 1.091790
      Returns:
      The conversion rate between the contra currency and the profit currency. This can be used for entering profit in an amount of settlement currency.

    • setProfitAskRate

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setProfitAskRate(@NotNull @NotNull BigDecimal profitAskRate)
      Parameters:
      profitAskRate - e.g. 1.090098
      Returns:
      The conversion rate between the contra currency and the profit currency. This can be used for entering profit in an amount of settlement currency.

    • setProfitAskRate

      @NotNull public @NotNull QuoteUnavailablePartsDef.QuoteUnavailableCommonFields.Builder setProfitAskRate(@NotNull @NotNull String profitAskRate)
      Parameters:
      profitAskRate - e.g. 1.090098
      Returns:
      The conversion rate between the contra currency and the profit currency. This can be used for entering profit in an amount of settlement currency.