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

Class NotificationsTypesDef.OrderEntryNotification.Builder

java.lang.Object

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

Enclosing class:

NotificationsTypesDef.OrderEntryNotification

public static final class NotificationsTypesDef.OrderEntryNotification.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull NotificationsTypesDef.OrderEntryNotification	build()
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	setAmount(@NotNull String amount)
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	setAmount(@NotNull BigDecimal amount)
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	setBuySell(@NotNull String buySell)
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	setCurrencyPair(@NotNull String currencyPair)
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	setDealtCurrency(@NotNull String dealtCurrency)
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	setLimitPrice(@NotNull String limitPrice)
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	setLimitPrice(@NotNull BigDecimal limitPrice)
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	setOrderID(@NotNull String orderID)
@NotNull NotificationsTypesDef.OrderEntryNotification.Builder	setOrderStatus(@NotNull String orderStatus)
@NotNull NotificationsTypesDef.OrderEntryNotification.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 NotificationsTypesDef.OrderEntryNotification.Builder addField(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

build

@NotNull
public @NotNull NotificationsTypesDef.OrderEntryNotification build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setOrderID

@NotNull
public @NotNull NotificationsTypesDef.OrderEntryNotification.Builder setOrderID(@NotNull
 @NotNull String orderID)

Returns:

The id of the order.

setOrderStatus

@NotNull
public @NotNull NotificationsTypesDef.OrderEntryNotification.Builder setOrderStatus(@NotNull
 @NotNull String orderStatus)

Returns:

Caplin supported statuses are [PENDING-ACCEPT, PENDING-ACTIVATION, ACTIVE, PARENT-ACTIVE, PENDING-DEACTIVATION, DEACTIVATED, EXPIRED, COMPLETED, REJECTED, PENDING-CANCEL, CANCELLED, CANCELLED-BY-PARTNER]

setCurrencyPair

@NotNull
public @NotNull NotificationsTypesDef.OrderEntryNotification.Builder setCurrencyPair(@NotNull
 @NotNull String currencyPair)

Returns:

The currency pair for the trade. For example, EURUSD

setBuySell

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

setLimitPrice

@NotNull
public @NotNull NotificationsTypesDef.OrderEntryNotification.Builder setLimitPrice(@NotNull
 @NotNull BigDecimal limitPrice)

Returns:

The price at which a leg should fill.

setLimitPrice

@NotNull
public @NotNull NotificationsTypesDef.OrderEntryNotification.Builder setLimitPrice(@NotNull
 @NotNull String limitPrice)

Returns:

The price at which a leg should fill.

setDealtCurrency

@NotNull
public @NotNull NotificationsTypesDef.OrderEntryNotification.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.OrderEntryNotification.Builder setAmount(@NotNull
 @NotNull BigDecimal amount)

Returns:

The amount of a trade or order in the DealtCurrency.

setAmount

@NotNull
public @NotNull NotificationsTypesDef.OrderEntryNotification.Builder setAmount(@NotNull
 @NotNull String amount)

Returns:

The amount of a trade or order in the DealtCurrency.

setTenor

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