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 Object

Method Summary

Modifier and Type	Method	Description
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields	build()
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setAmendmentReasonDisplayFields(@NotNull DisplayFields amendmentReasonDisplayFields)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setAmendmentReasonDisplayFields(@NotNull String amendmentReasonDisplayFields)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setCompetition(boolean competition)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setCompetition(@NotNull String competition)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setComponent1(@NotNull TradeConfPartsDef.SalesSyntheticComponentTradeConfirmationFields component1)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setComponent2(@NotNull TradeConfPartsDef.SalesSyntheticComponentTradeConfirmationFields component2)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setExternalRemarks(@NotNull String externalRemarks)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setForwardPointsTrader(@NotNull String forwardPointsTrader)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setForwardPointsTrader(@NotNull String forwardPointsTrader, boolean isEditable)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setForwardPointsTraderEditable()
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setIsAdvised(boolean isAdvised)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setIsAdvised(@NotNull String isAdvised)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfit(@NotNull String profit)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfit(@NotNull BigDecimal profit)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitCurrency(@NotNull String profitCurrency)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitCurrencyDPS(int profitCurrencyDPS)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitCurrencyDPS(@NotNull String profitCurrencyDPS)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitIsHouse(boolean profitIsHouse)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitIsHouse(@NotNull String profitIsHouse)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitRate(@NotNull String profitRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setProfitRate(@NotNull BigDecimal profitRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setReasons(@NotNull DisplayFields reasons)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setReasons(@NotNull String reasons)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSource(@NotNull String source)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMargin(@NotNull String spotMargin)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMargin(@NotNull String spotMargin, boolean isEditable)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMargin(@NotNull BigDecimal spotMargin)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMargin(@NotNull BigDecimal spotMargin, boolean isEditable)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotMarginEditable()
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotTrader(@NotNull String spotTrader)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotTrader(@NotNull String spotTrader, boolean isEditable)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSpotTraderEditable()
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setStreamingMode(@NotNull String streamingMode)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setSyntheticCrossCurrency(@NotNull String syntheticCrossCurrency)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderRemarks(@NotNull String traderRemarks)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderSpotRate(@NotNull String traderSpotRate)
@NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder	setTraderSpotRate(@NotNull BigDecimal traderSpotRate)
@NotNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

addField

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

build

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setProfitCurrency

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.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 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 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 String profitIsHouse)

Returns:

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

setProfitRate

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

setTraderRemarks

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

Returns:

The sale's comments on an order leg - visible to only the Trader and sales, set/edited only by the sales

setExternalRemarks

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setExternalRemarks(@NotNull
 @NotNull String externalRemarks)

Returns:

The trader's comments on an order leg - visible to only the sales, set/edited only by 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 String isAdvised)

Returns:

Indicates whether the trader gave the client advice

setStreamingMode

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

Parameters:

streamingMode - e.g. MANUAL, STREAMING

Returns:

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

setSyntheticCrossCurrency

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setSyntheticCrossCurrency(@NotNull
 @NotNull String syntheticCrossCurrency)

Parameters:

syntheticCrossCurrency - e.g. GBP

Returns:

The common currency of each synthetic component.

setAmendmentReasonDisplayFields

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setAmendmentReasonDisplayFields(@NotNull
 @NotNull String amendmentReasonDisplayFields)

Parameters:

amendmentReasonDisplayFields - e.g. method={'import':'static com.caplin.motif.fx.config.DefaultDisplayFields.addDefaultSalesAmendmentReasonDisplayFields','name':'addDefaultSalesAmendmentReasonDisplayFields','comment':'See DefaultDisplayFields javadoc for parameters and available builder methods.'}

Returns:

Configuration for a frontend to display label-value pairs for the amendment type/reasons. Use DefaultDisplayFields builders to provide Caplin default fields.

setAmendmentReasonDisplayFields

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setAmendmentReasonDisplayFields(@NotNull
 @NotNull DisplayFields amendmentReasonDisplayFields)

Parameters:

amendmentReasonDisplayFields - e.g. method={'import':'static com.caplin.motif.fx.config.DefaultDisplayFields.addDefaultSalesAmendmentReasonDisplayFields','name':'addDefaultSalesAmendmentReasonDisplayFields','comment':'See DefaultDisplayFields javadoc for parameters and available builder methods.'}

Returns:

Configuration for a frontend to display label-value pairs for the amendment type/reasons. Use DefaultDisplayFields builders to provide Caplin default fields.

setSpotTrader

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setSpotTrader(@NotNull
 @NotNull String spotTrader,
 boolean isEditable)

Returns:

The Spot trader for a manual mode trade

setSpotTrader

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setSpotTrader(@NotNull
 @NotNull String spotTrader)

Returns:

The Spot trader for a manual mode trade

setSpotTraderEditable

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

setForwardPointsTrader

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setForwardPointsTrader(@NotNull
 @NotNull String forwardPointsTrader,
 boolean isEditable)

Returns:

The Forward points trader for a manual mode trade

setForwardPointsTrader

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setForwardPointsTrader(@NotNull
 @NotNull String forwardPointsTrader)

Returns:

The Forward points trader for a manual mode trade

setForwardPointsTraderEditable

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

setComponent1

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setComponent1(@NotNull
 @NotNull TradeConfPartsDef.SalesSyntheticComponentTradeConfirmationFields component1)

Returns:

component1

setComponent2

@NotNull
public @NotNull TradeConfPartsDef.SalesCommonTradeConfirmationFields.Builder setComponent2(@NotNull
 @NotNull TradeConfPartsDef.SalesSyntheticComponentTradeConfirmationFields component2)

Returns:

component2