Package com.caplin.generated.motif.fx.blotter

Class BlotterPartsDef.OutrightQuoteBlotterFields.Builder

java.lang.Object
com.caplin.generated.motif.fx.blotter.BlotterPartsDef.OutrightQuoteBlotterFields.Builder
Enclosing class:
BlotterPartsDef.OutrightQuoteBlotterFields
public static final class BlotterPartsDef.OutrightQuoteBlotterFields.Builder extends Object

  • Method Details

    • addField

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value)

    • build

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields build()

    • toString

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

    • setRequestID

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setRequestID(@NotNull @NotNull String requestID)
      Parameters:
      requestID - e.g. 1234567890
      Returns:
      The ID of the request.

    • setTradeID

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setTradeID(@NotNull @NotNull String tradeID)
      Parameters:
      tradeID - e.g. 00001561
      Returns:
      A unique identifier for this trade

    • setAccount

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.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>

    • setEntityDescription

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setEntityDescription(@NotNull @NotNull String entityDescription)
      Parameters:
      entityDescription - e.g. Customer 1
      Returns:
      The description of a trade on behalf of entity.

    • setTraderUsername

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.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.

    • setRequestDateTime

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setRequestDateTime(@NotNull @NotNull Instant requestDateTime)
      Parameters:
      requestDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date of when the request was sent.

    • setRequestDateTime

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setRequestDateTime(@NotNull @NotNull String requestDateTime)
      Parameters:
      requestDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date of when the request was sent.

    • setStatus

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setStatus(@NotNull @NotNull String status)
      Parameters:
      status - e.g. Completed
      Returns:
      Status of the trade. Frontends may use this value for display purpose, but no logic is associated with it. Use Can* flags to drive post-trade logic.

    • setStatusCategory

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setStatusCategory(@NotNull @NotNull String statusCategory)
      Parameters:
      statusCategory - e.g. SUCCESS
      Returns:
      StatusCategory can be NEUTRAL, SUCCESS, WARNING, ERROR. If missing, frontend treats it as NEUTRAL. Used in frontends to color code `Status` text e.g. whether to color a status badge green or red.

    • setStatusIsFinal

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setStatusIsFinal(boolean statusIsFinal)
      Parameters:
      statusIsFinal - e.g. true
      Returns:
      StatusIsFinal can be true or false. Assumed false if missing or empty string. Used in frontends to color code `Status` text e.g. whether to color a status badge background dark green or light green.

    • setStatusIsFinal

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setStatusIsFinal(@NotNull @NotNull String statusIsFinal)
      Parameters:
      statusIsFinal - e.g. true
      Returns:
      StatusIsFinal can be true or false. Assumed false if missing or empty string. Used in frontends to color code `Status` text e.g. whether to color a status badge background dark green or light green.

    • setTradingType

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setTradingType(@NotNull @NotNull String tradingType)
      Parameters:
      tradingType - e.g. SPOT
      Returns:
      Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.

    • setCurrencyPair

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setCurrencyPair(@NotNull @NotNull String currencyPair)
      Returns:
      The currency pair for the trade. For example, EURUSD

    • setDealtCurrency

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setDealtCurrency(@NotNull @NotNull String dealtCurrency)
      Parameters:
      dealtCurrency - e.g. GBP
      Returns:
      The currency of the Amount of a trade or order.

    • setSpotRate

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setSpotRate(@NotNull @NotNull BigDecimal spotRate)
      Parameters:
      spotRate - e.g. 1.08341
      Returns:
      The rate for trading two currencies on the spot settlement date.

    • setSpotRate

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setSpotRate(@NotNull @NotNull String spotRate)
      Parameters:
      spotRate - e.g. 1.08341
      Returns:
      The rate for trading two currencies on the spot settlement date.

    • setRemarks

      @NotNull public @NotNull BlotterPartsDef.OutrightQuoteBlotterFields.Builder setRemarks(@NotNull @NotNull String remarks)
      Returns:
      The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales