Package com.caplin.generated.motif.fx.notifications

Class NotificationsTypesDef.ExecutionNotification.Builder

java.lang.Object

com.caplin.generated.motif.fx.notifications.NotificationsTypesDef.ExecutionNotification.Builder

Enclosing class:

NotificationsTypesDef.ExecutionNotification

public static final class NotificationsTypesDef.ExecutionNotification.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	addField(@NotNull java.lang.String key, @NotNull java.lang.String value)
@NotNull NotificationsTypesDef.ExecutionNotification	build()
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setAllInRate(@NotNull java.lang.String allInRate)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setAllInRate(@NotNull java.math.BigDecimal allInRate)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setAllInRateDPS(int allInRateDPS)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setAllInRateDPS(@NotNull java.lang.String allInRateDPS)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setAmount(@NotNull java.lang.String amount)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setAmount(@NotNull java.math.BigDecimal amount)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setBuySell(@NotNull java.lang.String buySell)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setContraAmount(@NotNull java.lang.String contraAmount)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setContraAmount(@NotNull java.math.BigDecimal contraAmount)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setCurrencyPair(@NotNull java.lang.String currencyPair)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setDealtCurrency(@NotNull java.lang.String dealtCurrency)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setExecutionDateTime(@NotNull java.lang.String executionDateTime)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setForwardPointsDecimalOffset(int forwardPointsDecimalOffset)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setForwardPointsDecimalOffset(@NotNull java.lang.String forwardPointsDecimalOffset)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setFwdPoints(@NotNull java.lang.String fwdPoints)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setFwdPoints(@NotNull java.math.BigDecimal fwdPoints)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setOrderID(@NotNull java.lang.String orderID)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setSpotRate(@NotNull java.lang.String spotRate)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setSpotRate(@NotNull java.math.BigDecimal spotRate)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setSpotRateDPS(int spotRateDPS)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setSpotRateDPS(@NotNull java.lang.String spotRateDPS)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setTenor(@NotNull java.lang.String tenor)
@NotNull NotificationsTypesDef.ExecutionNotification.Builder	setTradeID(@NotNull java.lang.String tradeID)
@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 NotificationsTypesDef.ExecutionNotification.Builder addField(@NotNull
                                                                             @NotNull java.lang.String key,
                                                                             @NotNull
                                                                             @NotNull java.lang.String value)

build

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification build()

toString

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

Overrides:

toString in class java.lang.Object

setOrderID

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setOrderID(@NotNull
                                                                               @NotNull java.lang.String orderID)

Returns:

The id of the order.

setTradeID

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setTradeID(@NotNull
                                                                               @NotNull java.lang.String tradeID)

Parameters:

tradeID - e.g. 00001561

Returns:

A unique identifier for this trade

setExecutionDateTime

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setExecutionDateTime(@NotNull
                                                                                         @NotNull java.lang.String executionDateTime)

Parameters:

executionDateTime - e.g. 20160322123621

Returns:

executionDateTime

setBuySell

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setBuySell(@NotNull
                                                                               @NotNull java.lang.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.

setTenor

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setTenor(@NotNull
                                                                             @NotNull java.lang.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.

setCurrencyPair

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setCurrencyPair(@NotNull
                                                                                    @NotNull java.lang.String currencyPair)

Returns:

The currency pair for the trade. For example, EURUSD

setDealtCurrency

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setDealtCurrency(@NotNull
                                                                                     @NotNull java.lang.String dealtCurrency)

Parameters:

dealtCurrency - e.g. GBP

Returns:

The currency of the Amount of a trade or order.

setAmount

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setAmount(@NotNull
                                                                              @NotNull java.math.BigDecimal amount)

Returns:

The amount of a trade or order in the DealtCurrency.

setAmount

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setAmount(@NotNull
                                                                              @NotNull java.lang.String amount)

Returns:

The amount of a trade or order in the DealtCurrency.

setContraAmount

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.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 NotificationsTypesDef.ExecutionNotification.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.

setSpotRate

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setSpotRate(@NotNull
                                                                                @NotNull java.math.BigDecimal spotRate)

Parameters:

spotRate - e.g. 1.08341

Returns:

spotRate

setSpotRate

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setSpotRate(@NotNull
                                                                                @NotNull java.lang.String spotRate)

Parameters:

spotRate - e.g. 1.08341

Returns:

spotRate

setSpotRateDPS

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setSpotRateDPS(int spotRateDPS)

Parameters:

spotRateDPS - e.g. 5

Returns:

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

setSpotRateDPS

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setSpotRateDPS(@NotNull
                                                                                   @NotNull java.lang.String spotRateDPS)

Parameters:

spotRateDPS - e.g. 5

Returns:

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

setFwdPoints

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setFwdPoints(@NotNull
                                                                                 @NotNull java.math.BigDecimal fwdPoints)

Parameters:

fwdPoints - e.g. 0.001198

Returns:

fwdPoints

setFwdPoints

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setFwdPoints(@NotNull
                                                                                 @NotNull java.lang.String fwdPoints)

Parameters:

fwdPoints - e.g. 0.001198

Returns:

fwdPoints

setAllInRate

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setAllInRate(@NotNull
                                                                                 @NotNull java.math.BigDecimal allInRate)

Parameters:

allInRate - e.g. 1.091790

Returns:

allInRate

setAllInRate

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setAllInRate(@NotNull
                                                                                 @NotNull java.lang.String allInRate)

Parameters:

allInRate - e.g. 1.091790

Returns:

allInRate

setAllInRateDPS

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.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 NotificationsTypesDef.ExecutionNotification.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.

setForwardPointsDecimalOffset

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setForwardPointsDecimalOffset(int forwardPointsDecimalOffset)

Parameters:

forwardPointsDecimalOffset - e.g. 4

Returns:

Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.

setForwardPointsDecimalOffset

@NotNull
public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setForwardPointsDecimalOffset(@NotNull
                                                                                                  @NotNull java.lang.String forwardPointsDecimalOffset)

Parameters:

forwardPointsDecimalOffset - e.g. 4

Returns:

Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.