Package com.caplin.generated.motif.fx.tradeconfirmation

Class TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder

java.lang.Object

com.caplin.generated.motif.fx.tradeconfirmation.TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder

Enclosing class:

TradeConfPartsDef.SalesCommonTradeConfirmationFields

public static final class TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	addField(@NotNull java.lang.String key, @NotNull java.lang.String value)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields	build()
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setCompetition(boolean competition)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setCompetition(@NotNull java.lang.String competition)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setIsAdvised(boolean isAdvised)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setIsAdvised(@NotNull java.lang.String isAdvised)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfit(@NotNull java.lang.String profit)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfit(@NotNull java.math.BigDecimal profit)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitCurrency(@NotNull java.lang.String profitCurrency)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitCurrencyDPS(int profitCurrencyDPS)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitCurrencyDPS(@NotNull java.lang.String profitCurrencyDPS)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitIsHouse(boolean profitIsHouse)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitIsHouse(@NotNull java.lang.String profitIsHouse)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitRate(@NotNull java.lang.String profitRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitRate(@NotNull java.math.BigDecimal profitRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setReasons(@NotNull java.lang.String reasons)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSource(@NotNull java.lang.String source)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMargin(@NotNull java.lang.String spotMargin)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMargin(@NotNull java.lang.String spotMargin, boolean isEditable)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMargin(@NotNull java.math.BigDecimal spotMargin)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMargin(@NotNull java.math.BigDecimal spotMargin, boolean isEditable)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMarginEditable()
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setStreamingMode(@NotNull java.lang.String streamingMode)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderRemarks(@NotNull java.lang.String traderRemarks)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderSpotAskRate(@NotNull java.lang.String traderSpotAskRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderSpotAskRate(@NotNull java.math.BigDecimal traderSpotAskRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderSpotBidRate(@NotNull java.lang.String traderSpotBidRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderSpotBidRate(@NotNull java.math.BigDecimal traderSpotBidRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderSpotRate(@NotNull java.lang.String traderSpotRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderSpotRate(@NotNull java.math.BigDecimal traderSpotRate)
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addField

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder addField(@NotNull
                                                                                      @NotNull java.lang.String key,
                                                                                      @NotNull
                                                                                      @NotNull java.lang.String value)

build

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields build()

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

setProfitCurrency

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setProfitCurrency(@NotNull
                                                                                               @NotNull java.lang.String profitCurrency)

Parameters:

profitCurrency - e.g. USD

Returns:

The profit currency that the ProfitBidRate is being provided for.

setProfitCurrencyDPS

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.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 TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setProfitCurrencyDPS(@NotNull
                                                                                                  @NotNull java.lang.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 TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setProfitIsHouse(boolean profitIsHouse)

Returns:

Whether the field ProfitCurrency is the system/house currency or not.

setProfitIsHouse

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setProfitIsHouse(@NotNull
                                                                                              @NotNull java.lang.String profitIsHouse)

Returns:

Whether the field ProfitCurrency is the system/house currency or not.

setProfitRate

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setProfitRate(@NotNull
                                                                                           @NotNull java.math.BigDecimal profitRate)

Parameters:

profitRate - e.g. 1.091790

Returns:

The conversion rate from the contra currency into the profit currency.

setProfitRate

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setProfitRate(@NotNull
                                                                                           @NotNull java.lang.String profitRate)

Parameters:

profitRate - e.g. 1.091790

Returns:

The conversion rate from the contra currency into the profit currency.

setTraderSpotRate

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setTraderSpotRate(@NotNull
                                                                                               @NotNull java.math.BigDecimal traderSpotRate)

Parameters:

traderSpotRate - e.g. 1.09174

Returns:

Can be formatted using DigitsBeforePips, NumberOfPips and SpotRateDPS

setTraderSpotRate

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setTraderSpotRate(@NotNull
                                                                                               @NotNull java.lang.String traderSpotRate)

Parameters:

traderSpotRate - e.g. 1.09174

Returns:

Can be formatted using DigitsBeforePips, NumberOfPips and SpotRateDPS

setSpotMargin

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setSpotMargin(@NotNull
                                                                                           @NotNull java.math.BigDecimal spotMargin,
                                                                                           boolean isEditable)

Parameters:

spotMargin - e.g. 0.00054

Returns:

Can be formatted using DigitsBeforePips, NumberOfPips and SpotRateDPS

setSpotMargin

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setSpotMargin(@NotNull
                                                                                           @NotNull java.math.BigDecimal spotMargin)

Parameters:

spotMargin - e.g. 0.00054

Returns:

Can be formatted using DigitsBeforePips, NumberOfPips and SpotRateDPS

setSpotMargin

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setSpotMargin(@NotNull
                                                                                           @NotNull java.lang.String spotMargin,
                                                                                           boolean isEditable)

Parameters:

spotMargin - e.g. 0.00054

Returns:

Can be formatted using DigitsBeforePips, NumberOfPips and SpotRateDPS

setSpotMargin

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setSpotMargin(@NotNull
                                                                                           @NotNull java.lang.String spotMargin)

Parameters:

spotMargin - e.g. 0.00054

Returns:

Can be formatted using DigitsBeforePips, NumberOfPips and SpotRateDPS

setSpotMarginEditable

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setSpotMarginEditable()

setProfit

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setProfit(@NotNull
                                                                                       @NotNull java.math.BigDecimal profit)

Parameters:

profit - e.g. 1000

Returns:

The sales profit in the specified currency.

setProfit

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setProfit(@NotNull
                                                                                       @NotNull java.lang.String profit)

Parameters:

profit - e.g. 1000

Returns:

The sales profit in the specified currency.

setCompetition

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setCompetition(boolean competition)

Returns:

Whether a quote request is in competition. For example, true for quotes from an ECN and false for quotes from an SDP

setCompetition

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setCompetition(@NotNull
                                                                                            @NotNull java.lang.String competition)

Returns:

Whether a quote request is in competition. For example, true for quotes from an ECN and false for quotes from an SDP

setSource

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setSource(@NotNull
                                                                                       @NotNull java.lang.String source)

Returns:

The source of a quote request. The name or ID of an ECN, SDP or other channel

setReasons

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setReasons(@NotNull
                                                                                        @NotNull java.lang.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.

setTraderRemarks

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setTraderRemarks(@NotNull
                                                                                              @NotNull java.lang.String traderRemarks)

Returns:

The trader's comments on an order leg - visible to only the Trader

setIsAdvised

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setIsAdvised(boolean isAdvised)

Returns:

Indicates whether the trader gave the client advice

setIsAdvised

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setIsAdvised(@NotNull
                                                                                          @NotNull java.lang.String isAdvised)

Returns:

Indicates whether the trader gave the client advice

setStreamingMode

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setStreamingMode(@NotNull
                                                                                              @NotNull java.lang.String streamingMode)

Parameters:

streamingMode - e.g. MANUAL, STREAMING

Returns:

Indicates whether the rates/margins of this trade have been manually set

setTraderSpotAskRate

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setTraderSpotAskRate(@NotNull
                                                                                                  @NotNull java.math.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 TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setTraderSpotAskRate(@NotNull
                                                                                                  @NotNull java.lang.String traderSpotAskRate)

Parameters:

traderSpotAskRate - e.g. 1.08575

Returns:

This field represents the spot ask rate with no client margin applied to it.

setTraderSpotBidRate

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setTraderSpotBidRate(@NotNull
                                                                                                  @NotNull java.math.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 TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setTraderSpotBidRate(@NotNull
                                                                                                  @NotNull java.lang.String traderSpotBidRate)

Parameters:

traderSpotBidRate - e.g. 1.08575

Returns:

This field represents the spot bid rate with no client margin applied to it.