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

Class TradeDetailsPartsDef.CommonTradeDetailsFields.Builder

    • Method Detail

      • toString

        @NotNull
public @NotNull java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • setAccount

        @NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder setAccount​(@NotNull
                                                                                 @NotNull java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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.

      • setTraderUsername

        @NotNull
public @NotNull TradeDetailsPartsDef.CommonTradeDetailsFields.Builder setTraderUsername​(@NotNull
                                                                                        @NotNull java.lang.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.