Package com.caplin.generated.motif.fx.tradedetails

Class TradeDetailsPartsDef.LegTradeDetailsFields.Builder

java.lang.Object

com.caplin.generated.motif.fx.tradedetails.TradeDetailsPartsDef.LegTradeDetailsFields.Builder

Enclosing class:

TradeDetailsPartsDef.LegTradeDetailsFields

public static final class TradeDetailsPartsDef.LegTradeDetailsFields.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields	build()
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setAccount(@NotNull String account)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setAmount(@NotNull String amount)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setAmount(@NotNull BigDecimal amount)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setBuySell(@NotNull String buySell)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setEntityId(@NotNull String entityId)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setFixingDate(@NotNull String fixingDate)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setIsTimeOption(boolean isTimeOption)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setIsTimeOption(@NotNull String isTimeOption)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setSettlementDate(@NotNull String settlementDate)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setStartDate(@NotNull String startDate)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setStartTenor(@NotNull String startTenor)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setTenor(@NotNull String tenor)
@NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder	setTOBOUser(@NotNull String tOBOUser)
@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 TradeDetailsPartsDef.LegTradeDetailsFields.Builder addField(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

build

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setTOBOUser

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setTOBOUser(@NotNull
 @NotNull String tOBOUser)

Parameters:

tOBOUser - e.g. client@customer.co.za

Returns:

The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.

setEntityId

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setEntityId(@NotNull
 @NotNull String entityId)

Parameters:

entityId - e.g. CUSTONE

Returns:

The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.

setAmount

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setAmount(@NotNull
 @NotNull BigDecimal amount)

Returns:

The amount of a trade or order in the DealtCurrency.

setAmount

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setAmount(@NotNull
 @NotNull String amount)

Returns:

The amount of a trade or order in the DealtCurrency.

setSettlementDate

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setSettlementDate(@NotNull
 @NotNull String settlementDate)

Returns:

settlementDate

setTenor

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setTenor(@NotNull
 @NotNull String tenor)

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 the settlement date does not fall onto a tenor.

setBuySell

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setBuySell(@NotNull
 @NotNull String buySell)

Returns:

The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.

setAccount

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setAccount(@NotNull
 @NotNull 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>

setIsTimeOption

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setIsTimeOption(boolean isTimeOption)

Parameters:

isTimeOption - e.g. true

Returns:

true if a leg is time-option

setIsTimeOption

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setIsTimeOption(@NotNull
 @NotNull String isTimeOption)

Parameters:

isTimeOption - e.g. true

Returns:

true if a leg is time-option

setStartDate

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setStartDate(@NotNull
 @NotNull String startDate)

Parameters:

startDate - e.g. 20150620

Returns:

startDate

setStartTenor

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setStartTenor(@NotNull
 @NotNull String startTenor)

Parameters:

startTenor - e.g. 1W

Returns:

startTenor

setFixingDate

@NotNull
public @NotNull TradeDetailsPartsDef.LegTradeDetailsFields.Builder setFixingDate(@NotNull
 @NotNull String fixingDate)

Parameters:

fixingDate - e.g. 20150620

Returns:

This is the day and time whereby the comparison between the NDF rate and the prevailing spot rate is made.