Package com.caplin.generated.motif.fx.drawdown

Class DrawdownPartsDef.DrawdownDetailsLegFields.Builder

java.lang.Object

com.caplin.generated.motif.fx.drawdown.DrawdownPartsDef.DrawdownDetailsLegFields.Builder

Enclosing class:

DrawdownPartsDef.DrawdownDetailsLegFields

public static final class DrawdownPartsDef.DrawdownDetailsLegFields.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields	build()
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setAllInRate(@NotNull String allInRate)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setAllInRate(@NotNull BigDecimal allInRate)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setAmount(@NotNull String amount)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setAmount(@NotNull BigDecimal amount)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setBuySell(@NotNull String buySell)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setRemainingAmount(@NotNull String remainingAmount)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setRemainingAmount(@NotNull BigDecimal remainingAmount)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setSettlementDate(@NotNull String settlementDate)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setStartDate(@NotNull String startDate)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setStartTenor(@NotNull String startTenor)
@NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder	setTenor(@NotNull String tenor)
@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 DrawdownPartsDef.DrawdownDetailsLegFields.Builder addField(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

build

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setAllInRate

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder setAllInRate(@NotNull
 @NotNull BigDecimal allInRate)

Parameters:

allInRate - e.g. 1.091790

Returns:

The final client rate that is made up of the spot rate + any additional costs or adjustments such as swap points or margin.

setAllInRate

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder setAllInRate(@NotNull
 @NotNull String allInRate)

Parameters:

allInRate - e.g. 1.091790

Returns:

The final client rate that is made up of the spot rate + any additional costs or adjustments such as swap points or margin.

setAmount

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder setAmount(@NotNull
 @NotNull BigDecimal amount)

Returns:

The amount of a trade or order in the DealtCurrency.

setAmount

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder setAmount(@NotNull
 @NotNull String amount)

Returns:

The amount of a trade or order in the DealtCurrency.

setBuySell

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.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.

setRemainingAmount

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder setRemainingAmount(@NotNull
 @NotNull BigDecimal remainingAmount)

Parameters:

remainingAmount - e.g. 500

Returns:

The amount remaining on a trade or order which can reduce after performing a post trade action/an order is filled.

setRemainingAmount

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder setRemainingAmount(@NotNull
 @NotNull String remainingAmount)

Parameters:

remainingAmount - e.g. 500

Returns:

The amount remaining on a trade or order which can reduce after performing a post trade action/an order is filled.

setStartDate

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder setStartDate(@NotNull
 @NotNull String startDate)

Parameters:

startDate - e.g. 20150620

Returns:

The date of which the time option becomes active from.

setStartTenor

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder setStartTenor(@NotNull
 @NotNull String startTenor)

Parameters:

startTenor - e.g. 1W

Returns:

The tenor of which the time option becomes active from.

setSettlementDate

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.Builder setSettlementDate(@NotNull
 @NotNull String settlementDate)

Parameters:

settlementDate - e.g. 20160314

Returns:

The date on which the two currencies in the FX trade are exchanged. Can be a tenor or a broken date, i.e. SPOT or 20160314.

setTenor

@NotNull
public @NotNull DrawdownPartsDef.DrawdownDetailsLegFields.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.