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

Class TradeDetailsPartsDef.CommonTradeDetailsFields.Builder

java.lang.Object

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

Enclosing class:

TradeDetailsPartsDef.CommonTradeDetailsFields

public static final class TradeDetailsPartsDef.CommonTradeDetailsFields.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields	build()
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setAccount(@NotNull String account)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setEntityDescription(@NotNull String entityDescription)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setEntityId(@NotNull String entityId)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setLastActionDateTime(@NotNull String lastActionDateTime)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setLastActionDateTime(@NotNull Instant lastActionDateTime)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setOneWayDirection(@NotNull String oneWayDirection)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setRequestedDateTime(@NotNull String requestedDateTime)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setRequestedDateTime(@NotNull Instant requestedDateTime)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setTOBOUser(@NotNull String tOBOUser)
@NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder	setTraderUsername(@NotNull String traderUsername)
@NotNull 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 TradeDetailsPartsDef.CommonTradeDetailsFields.Builder addField(@NotNull
                                                                               @NotNull String key,
                                                                               @NotNull
                                                                               @NotNull String value)

build

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setAccount

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.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>

setTOBOUser

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.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.CommonTradeDetailsFields.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.

setEntityDescription

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder setEntityDescription(@NotNull
                                                                                           @NotNull String entityDescription)

Parameters:

entityDescription - e.g. Customer 1

Returns:

The description of a trade on behalf of entity.

setOneWayDirection

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder setOneWayDirection(@NotNull
                                                                                         @NotNull String oneWayDirection)

Returns:

The trade direction of the base currency in a one-way quote. When this field is absent or has no value, a two-way quote/stream is requested. When this field is set to BUY or SELL, a one-way quote/stream is requested, with BUY or SELL indicating the trade direction of the base currency.

setLastActionDateTime

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder setLastActionDateTime(@NotNull
                                                                                            @NotNull Instant lastActionDateTime)

Returns:

The time and date of the last action on an order.

setLastActionDateTime

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder setLastActionDateTime(@NotNull
                                                                                            @NotNull String lastActionDateTime)

Returns:

The time and date of the last action on an order.

setRequestedDateTime

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder setRequestedDateTime(@NotNull
                                                                                           @NotNull Instant requestedDateTime)

Returns:

requestedDateTime

setRequestedDateTime

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder setRequestedDateTime(@NotNull
                                                                                           @NotNull String requestedDateTime)

Returns:

requestedDateTime

setTraderUsername

@NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder setTraderUsername(@NotNull
                                                                                        @NotNull String traderUsername)

Parameters:

traderUsername - e.g. sales_trader@novobank.co.za

Returns:

The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. 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 dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.