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

Class QuotePartsDef.SalesCommonFields.Builder

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

  • Method Details

    • addField

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value)

    • build

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields build()

    • toString

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

    • setTraderSpotBidRate

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setTraderSpotBidRate(@NotNull @NotNull BigDecimal traderSpotBidRate)
      Parameters:
      traderSpotBidRate - e.g. 1.08575
      Returns:
      This field represents the spot bid rate with no client margin applied to it.

    • setTraderSpotBidRate

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setTraderSpotBidRate(@NotNull @NotNull String traderSpotBidRate)
      Parameters:
      traderSpotBidRate - e.g. 1.08575
      Returns:
      This field represents the spot bid rate with no client margin applied to it.

    • setTraderSpotAskRate

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setTraderSpotAskRate(@NotNull @NotNull BigDecimal traderSpotAskRate)
      Parameters:
      traderSpotAskRate - e.g. 1.08575
      Returns:
      This field represents the spot ask rate with no client margin applied to it.

    • setTraderSpotAskRate

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setTraderSpotAskRate(@NotNull @NotNull String traderSpotAskRate)
      Parameters:
      traderSpotAskRate - e.g. 1.08575
      Returns:
      This field represents the spot ask rate with no client margin applied to it.

    • setDefaultSpotBidMargin

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setDefaultSpotBidMargin(@NotNull @NotNull BigDecimal defaultSpotBidMargin)
      Parameters:
      defaultSpotBidMargin - e.g. 0.00054
      Returns:
      This field represents the default margin to be applied to the SpotBidRate. It should be sent as an unformatted, raw value.

    • setDefaultSpotBidMargin

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setDefaultSpotBidMargin(@NotNull @NotNull String defaultSpotBidMargin)
      Parameters:
      defaultSpotBidMargin - e.g. 0.00054
      Returns:
      This field represents the default margin to be applied to the SpotBidRate. It should be sent as an unformatted, raw value.

    • setDefaultSpotAskMargin

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setDefaultSpotAskMargin(@NotNull @NotNull BigDecimal defaultSpotAskMargin)
      Parameters:
      defaultSpotAskMargin - e.g. 0.00054
      Returns:
      This field represents the default margin to be applied to the SpotAskRate. It should be sent as an unformatted, raw value.

    • setDefaultSpotAskMargin

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setDefaultSpotAskMargin(@NotNull @NotNull String defaultSpotAskMargin)
      Parameters:
      defaultSpotAskMargin - e.g. 0.00054
      Returns:
      This field represents the default margin to be applied to the SpotAskRate. It should be sent as an unformatted, raw value.

    • setProfitCurrency

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.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 QuotePartsDef.SalesCommonFields.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 QuotePartsDef.SalesCommonFields.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 QuotePartsDef.SalesCommonFields.Builder setProfitIsHouse(boolean profitIsHouse)
      Returns:
      Whether the field ProfitCurrency is the system/house currency or not.

    • setProfitIsHouse

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

    • setProfitBidRate

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.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 QuotePartsDef.SalesCommonFields.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 QuotePartsDef.SalesCommonFields.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 QuotePartsDef.SalesCommonFields.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.

    • setReasons

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setReasons(@NotNull @NotNull String reasons)
      Returns:
      A JSON structure containing all the reasons and information about why the trade requires intervention. Please see the Sales Intervention Reasons documentation on the website for more information.

    • setReasons

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setReasons(@NotNull @NotNull DisplayFields reasons)
      Returns:
      A JSON structure containing all the reasons and information about why the trade requires intervention. Please see the Sales Intervention Reasons documentation on the website for more information.

    • setSyntheticCrossCurrency

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setSyntheticCrossCurrency(@NotNull @NotNull String syntheticCrossCurrency)
      Parameters:
      syntheticCrossCurrency - e.g. GBP
      Returns:
      The common currency of each synthetic component.

    • setForceManual

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setForceManual(boolean forceManual)
      Returns:
      If this field is set to true then the Sales RFS ticket should be forced into manual pricing mode. If not specified, the default is false.

    • setForceManual

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setForceManual(@NotNull @NotNull String forceManual)
      Returns:
      If this field is set to true then the Sales RFS ticket should be forced into manual pricing mode. If not specified, the default is false.

    • setSpotPriceMode

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setSpotPriceMode(@NotNull @NotNull String spotPriceMode)
      Returns:
      Indicates whether the Spot values provided by the pricing engine have been automatically or manually priced. Enum of: MANUAL, AUTO

    • setSpotMarginAgreed

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setSpotMarginAgreed(boolean spotMarginAgreed)
      Returns:
      This flag shows if the user can(false)/cannot(true) exceed the agreed margin or not

    • setSpotMarginAgreed

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setSpotMarginAgreed(@NotNull @NotNull String spotMarginAgreed)
      Returns:
      This flag shows if the user can(false)/cannot(true) exceed the agreed margin or not

    • setReferenceSpotBidRate

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setReferenceSpotBidRate(@NotNull @NotNull BigDecimal referenceSpotBidRate)
      Parameters:
      referenceSpotBidRate - e.g. 1.08575
      Returns:
      This field represents the reference spot bid rate with no client margin applied to it.

    • setReferenceSpotBidRate

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setReferenceSpotBidRate(@NotNull @NotNull String referenceSpotBidRate)
      Parameters:
      referenceSpotBidRate - e.g. 1.08575
      Returns:
      This field represents the reference spot bid rate with no client margin applied to it.

    • setReferenceSpotAskRate

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setReferenceSpotAskRate(@NotNull @NotNull BigDecimal referenceSpotAskRate)
      Parameters:
      referenceSpotAskRate - e.g. 1.08575
      Returns:
      This field represents the reference spot ask rate with no client margin applied to it.

    • setReferenceSpotAskRate

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setReferenceSpotAskRate(@NotNull @NotNull String referenceSpotAskRate)
      Parameters:
      referenceSpotAskRate - e.g. 1.08575
      Returns:
      This field represents the reference spot ask rate with no client margin applied to it.

    • setComponent1

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setComponent1(@NotNull @NotNull QuotePartsDef.SalesSyntheticComponentFields component1)
      Returns:
      component1

    • setComponent2

      @NotNull public @NotNull QuotePartsDef.SalesCommonFields.Builder setComponent2(@NotNull @NotNull QuotePartsDef.SalesSyntheticComponentFields component2)
      Returns:
      component2