Class NotificationsTypesDef.ExecutionNotification.Builder
java.lang.Object
com.caplin.generated.motif.fx.notifications.NotificationsTypesDef.ExecutionNotification.Builder
- Enclosing class:
- NotificationsTypesDef.ExecutionNotification
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
setAllInRate
(@NotNull String allInRate) setAllInRate
(@NotNull BigDecimal allInRate) setAllInRateDPS
(int allInRateDPS) setAllInRateDPS
(@NotNull String allInRateDPS) setAmount
(@NotNull BigDecimal amount) setBuySell
(@NotNull String buySell) setContraAmount
(@NotNull String contraAmount) setContraAmount
(@NotNull BigDecimal contraAmount) setCurrencyPair
(@NotNull String currencyPair) setDealtCurrency
(@NotNull String dealtCurrency) setExecutionDateTime
(@NotNull String executionDateTime) setForwardPointsDecimalOffset
(int forwardPointsDecimalOffset) setForwardPointsDecimalOffset
(@NotNull String forwardPointsDecimalOffset) setFwdPoints
(@NotNull String fwdPoints) setFwdPoints
(@NotNull BigDecimal fwdPoints) setOrderID
(@NotNull String orderID) setSpotRate
(@NotNull String spotRate) setSpotRate
(@NotNull BigDecimal spotRate) setSpotRateDPS
(int spotRateDPS) setSpotRateDPS
(@NotNull String spotRateDPS) setTradeID
(@NotNull String tradeID) @NotNull String
toString()
-
Method Details
-
addField
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value) -
build
-
toString
-
setOrderID
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setOrderID(@NotNull @NotNull String orderID) - Returns:
- The id of the order.
-
setTradeID
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setTradeID(@NotNull @NotNull String tradeID) - Parameters:
tradeID
- e.g. 00001561- Returns:
- A unique identifier for this trade
-
setExecutionDateTime
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setExecutionDateTime(@NotNull @NotNull String executionDateTime) - Parameters:
executionDateTime
- e.g. 20160322123621- Returns:
- executionDateTime
-
setBuySell
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.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.
-
setTenor
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.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.
-
setCurrencyPair
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setCurrencyPair(@NotNull @NotNull String currencyPair) - Returns:
- The currency pair for the trade. For example, EURUSD
-
setDealtCurrency
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setDealtCurrency(@NotNull @NotNull 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 BigDecimal amount) - Returns:
- The amount of a trade or order in the DealtCurrency.
-
setAmount
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setAmount(@NotNull @NotNull String amount) - Returns:
- The amount of a trade or order in the DealtCurrency.
-
setContraAmount
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setContraAmount(@NotNull @NotNull 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 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 BigDecimal spotRate) - Parameters:
spotRate
- e.g. 1.08341- Returns:
- spotRate
-
setSpotRate
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setSpotRate(@NotNull @NotNull 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 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 BigDecimal fwdPoints) - Parameters:
fwdPoints
- e.g. 0.001198- Returns:
- fwdPoints
-
setFwdPoints
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setFwdPoints(@NotNull @NotNull String fwdPoints) - Parameters:
fwdPoints
- e.g. 0.001198- Returns:
- fwdPoints
-
setAllInRate
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setAllInRate(@NotNull @NotNull BigDecimal allInRate) - Parameters:
allInRate
- e.g. 1.091790- Returns:
- allInRate
-
setAllInRate
@NotNull public @NotNull NotificationsTypesDef.ExecutionNotification.Builder setAllInRate(@NotNull @NotNull 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 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 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.
-