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

Class TradeConfPartsDef.LegTradeConfirmationFields.Builder

java.lang.Object

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

Enclosing class:

TradeConfPartsDef.LegTradeConfirmationFields

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

Method Summary

Modifier and Type	Method	Description
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	addAllRemarks(@NotNull java.util.Collection<TradeConfPartsDef.RemarksEntry> remarks)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	addField(@NotNull java.lang.String key, @NotNull java.lang.String value)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	addRemarks(@NotNull TradeConfPartsDef.RemarksEntry remarks)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields	build()
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAccount(@NotNull java.lang.String account)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAllInMidRate(@NotNull java.lang.String allInMidRate)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAllInMidRate(@NotNull java.math.BigDecimal allInMidRate)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAllInRate(@NotNull java.lang.String allInRate)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAllInRate(@NotNull java.math.BigDecimal allInRate)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAllInRateDPS(int allInRateDPS)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAllInRateDPS(@NotNull java.lang.String allInRateDPS)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAmount(@NotNull java.lang.String amount, boolean isEditable, boolean isRisk)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAmount(@NotNull java.math.BigDecimal amount, boolean isEditable, boolean isRisk)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAmountEditable()
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setAmountRisk()
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setBuySell(@NotNull java.lang.String buySell)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setContraAmount(@NotNull java.lang.String contraAmount)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setContraAmount(@NotNull java.math.BigDecimal contraAmount)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setContraCostAmount(@NotNull java.lang.String contraCostAmount)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setContraCostAmount(@NotNull java.math.BigDecimal contraCostAmount)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setContraCostCurrency(@NotNull java.lang.String contraCostCurrency)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setContraCostCurrency(@NotNull java.math.BigDecimal contraCostCurrency)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setContraCostPercentage(@NotNull java.lang.String contraCostPercentage)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setContraCostPercentage(@NotNull java.math.BigDecimal contraCostPercentage)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setCostAmount(@NotNull java.lang.String costAmount)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setCostAmount(@NotNull java.math.BigDecimal costAmount)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setCostCurrency(@NotNull java.lang.String costCurrency)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setCostPercentage(@NotNull java.lang.String costPercentage)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setCostPercentage(@NotNull java.math.BigDecimal costPercentage)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setFwdMidPoints(@NotNull java.lang.String fwdMidPoints)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setFwdMidPoints(@NotNull java.math.BigDecimal fwdMidPoints)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setFwdPips(@NotNull java.lang.String fwdPips)	Deprecated.
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setFwdPoints(@NotNull java.lang.String fwdPoints)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setFwdPoints(@NotNull java.math.BigDecimal fwdPoints)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setNostroAccountFields(SettlementInstructionsPartsDef.NostroAccount nostroAccountFields)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setProfit(@NotNull java.lang.String profit)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setProfit(@NotNull java.math.BigDecimal profit)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setRemarks(@NotNull TradeConfPartsDef.RemarksEntry remarks, int id)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setSettlementDate(@NotNull java.lang.String settlementDate, boolean isEditable, boolean isRisk)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setSettlementDateEditable()
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setSettlementDateRisk()
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setSettlementTradeFields(SettlementInstructionsPartsDef.SettlementTradeFields settlementTradeFields)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setTenor(@NotNull java.lang.String tenor, boolean isEditable, boolean isRisk)
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setTenorEditable()
@NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder	setTenorRisk()
@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.LegTradeConfirmationFields.Builder addField(@NotNull
                                                                              @NotNull java.lang.String key,
                                                                              @NotNull
                                                                              @NotNull java.lang.String value)

build

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields build()

toString

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

Overrides:

toString in class java.lang.Object

setAllInRate

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInRate(@NotNull
                                                                                  @NotNull java.math.BigDecimal allInRate)

Parameters:

allInRate - e.g. 1.091790

Returns:

allInRate

setAllInRate

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInRate(@NotNull
                                                                                  @NotNull java.lang.String allInRate)

Parameters:

allInRate - e.g. 1.091790

Returns:

allInRate

setAllInRateDPS

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInRateDPS(int allInRateDPS)

Parameters:

allInRateDPS - e.g. 5

Returns:

The number of decimal places to display after the decimal point.

setAllInRateDPS

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInRateDPS(@NotNull
                                                                                     @NotNull java.lang.String allInRateDPS)

Parameters:

allInRateDPS - e.g. 5

Returns:

The number of decimal places to display after the decimal point.

setAllInMidRate

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInMidRate(@NotNull
                                                                                     @NotNull java.math.BigDecimal allInMidRate)

Parameters:

allInMidRate - e.g. 1.091790

Returns:

The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

setAllInMidRate

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInMidRate(@NotNull
                                                                                     @NotNull java.lang.String allInMidRate)

Parameters:

allInMidRate - e.g. 1.091790

Returns:

The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

setFwdPoints

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdPoints(@NotNull
                                                                                  @NotNull java.math.BigDecimal fwdPoints)

Parameters:

fwdPoints - e.g. 0.001198

Returns:

fwdPoints

setFwdPoints

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdPoints(@NotNull
                                                                                  @NotNull java.lang.String fwdPoints)

Parameters:

fwdPoints - e.g. 0.001198

Returns:

fwdPoints

setFwdMidPoints

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdMidPoints(@NotNull
                                                                                     @NotNull java.math.BigDecimal fwdMidPoints)

Parameters:

fwdMidPoints - e.g. 0.005390

Returns:

The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.

setFwdMidPoints

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdMidPoints(@NotNull
                                                                                     @NotNull java.lang.String fwdMidPoints)

Parameters:

fwdMidPoints - e.g. 0.005390

Returns:

The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.

setFwdPips

@Deprecated
@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdPips(@NotNull
                                                                                @NotNull java.lang.String fwdPips)

Deprecated.

Parameters:

fwdPips - e.g. 11.98

Returns:

fwdPips

setBuySell

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setBuySell(@NotNull
                                                                                @NotNull java.lang.String buySell)

Returns:

The direction of the trade or trade leg. This always refers to the BaseCurrency, NOT the DealtCurrency.

setAmount

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmount(@NotNull
                                                                               @NotNull java.math.BigDecimal amount,
                                                                               boolean isEditable,
                                                                               boolean isRisk)

Returns:

The amount of a trade or order in the DealtCurrency.

setAmount

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmount(@NotNull
                                                                               @NotNull java.lang.String amount,
                                                                               boolean isEditable,
                                                                               boolean isRisk)

Returns:

The amount of a trade or order in the DealtCurrency.

setAmountEditable

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmountEditable()

setAmountRisk

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmountRisk()

setContraAmount

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraAmount(@NotNull
                                                                                     @NotNull java.math.BigDecimal contraAmount)

Parameters:

contraAmount - e.g. 350

Returns:

The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.

setContraAmount

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraAmount(@NotNull
                                                                                     @NotNull java.lang.String contraAmount)

Parameters:

contraAmount - e.g. 350

Returns:

The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.

setTenor

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setTenor(@NotNull
                                                                              @NotNull java.lang.String tenor,
                                                                              boolean isEditable,
                                                                              boolean isRisk)

Parameters:

tenor - e.g. 1M

Returns:

Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. broken indicates that a SettlementDate must be sent

setTenorEditable

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setTenorEditable()

setTenorRisk

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setTenorRisk()

setSettlementDate

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setSettlementDate(@NotNull
                                                                                       @NotNull java.lang.String settlementDate,
                                                                                       boolean isEditable,
                                                                                       boolean isRisk)

Returns:

settlementDate

setSettlementDateEditable

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setSettlementDateEditable()

setSettlementDateRisk

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setSettlementDateRisk()

setAccount

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAccount(@NotNull
                                                                                @NotNull java.lang.String account)

Parameters:

account - e.g. Garfields|GARF

Returns:

The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>

setProfit

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.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.LegTradeConfirmationFields.Builder setProfit(@NotNull
                                                                               @NotNull java.lang.String profit)

Parameters:

profit - e.g. 1000

Returns:

The sales profit in the specified currency.

setCostAmount

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setCostAmount(@NotNull
                                                                                   @NotNull java.math.BigDecimal costAmount)

Parameters:

costAmount - e.g. 12412891.31

Returns:

The actual transactional cost of performing the trade to the client in the home currency

setCostAmount

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setCostAmount(@NotNull
                                                                                   @NotNull java.lang.String costAmount)

Parameters:

costAmount - e.g. 12412891.31

Returns:

The actual transactional cost of performing the trade to the client in the home currency

setCostCurrency

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.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

setCostPercentage

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setCostPercentage(@NotNull
                                                                                       @NotNull java.math.BigDecimal costPercentage)

Parameters:

costPercentage - e.g. 13.56

Returns:

Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.

setCostPercentage

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setCostPercentage(@NotNull
                                                                                       @NotNull java.lang.String costPercentage)

Parameters:

costPercentage - e.g. 13.56

Returns:

Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.

setContraCostAmount

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.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 TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraCostAmount(@NotNull
                                                                                         @NotNull java.lang.String contraCostAmount)

Returns:

The actual transactional cost of performing the trade to the client on the contra currency

setContraCostCurrency

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraCostCurrency(@NotNull
                                                                                           @NotNull java.math.BigDecimal contraCostCurrency)

Returns:

The contra currency that the cost is displayed in

setContraCostCurrency

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraCostCurrency(@NotNull
                                                                                           @NotNull java.lang.String contraCostCurrency)

Returns:

The contra currency that the cost is displayed in

setContraCostPercentage

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.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 TradeConfPartsDef.LegTradeConfirmationFields.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%.

setSettlementTradeFields

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setSettlementTradeFields(@NotNull
                                                                                              SettlementInstructionsPartsDef.SettlementTradeFields settlementTradeFields)

Returns:

settlementTradeFields

setNostroAccountFields

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setNostroAccountFields(@NotNull
                                                                                            SettlementInstructionsPartsDef.NostroAccount nostroAccountFields)

Returns:

nostroAccountFields

addRemarks

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder addRemarks(@NotNull
                                                                                @NotNull TradeConfPartsDef.RemarksEntry remarks)

Returns:

remarks

setRemarks

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setRemarks(@NotNull
                                                                                @NotNull TradeConfPartsDef.RemarksEntry remarks,
                                                                                int id)

Returns:

remarks

addAllRemarks

@NotNull
public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder addAllRemarks(@NotNull
                                                                                   @NotNull java.util.Collection<TradeConfPartsDef.RemarksEntry> remarks)

Returns:

remarks