Package com.caplin.generated.motif.fx.trading.fieldsets

Interface ExecutionServerFieldSet

public interface ExecutionServerFieldSet

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addField(String fieldName, Object value)
    Adds a field to this event
    default void
    setAllInAskMargin(Object value)
    This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
    default void
    setAllInAskRate(Object value)
    The ask rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
    default void
    setAllInBidMargin(Object value)
    This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
    default void
    setAllInBidRate(Object value)
    The bid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
    default void
    setAppID(Object value)
    A unique identifier for the client application
    default void
    setAskPips(Object value)
    Deprecated.
    default void
    setAssetClass(Object value)
    The asset class for the trade; used by permissioning and licensing.
    default void
    setBidPips(Object value)
    Deprecated.
    default void
    setClientAgreementDateTime(Object value)
    Optional field that can be used to display the client agreement date time in a trade amend.
    default void
    setCurrencyPair(Object value)
    The currency pair for the trade.
    default void
    setDealtCurrency(Object value)
    The currency of the Amount of a trade or order.
    default void
    setEndDate(Object value)
    The end date value for a time option trade.
    default void
    setForwardPointsTrader(Object value)
    The Forward points trader for a manual mode trade
    default void
    setIsAdvised(Object value)
    true or false to indicate whether the trader gave the client advice
    default void
    setIsCommercial(Object value)
    Indication whether something is commercial or not
    default void
    setPurpose(Object value)
    The purpose of the trade.
    default void
    setQuoteID(Object value)
    The unique ID of the quote the client wants to trade on.
    default void
    setRemarks(Object value)
    The clients or trader's comments on a trade - visible to both the Client and the Trader.
    default void
    setSpotAskMargin(Object value)
    This field represents the spot margin that the sales user has selected.
    default void
    setSpotAskRate(Object value)
    This field is included on the rate update that the client wants to trade on
    default void
    setSpotBidMargin(Object value)
    This field represents the spot margin that the sales user has selected.
    default void
    setSpotBidRate(Object value)
    This field is included on the rate update that the client wants to trade on
    default void
    setSpotTrader(Object value)
    The Spot trader for a manual mode trade
    default void
    setStartDate(Object value)
    The start date value for a time option trade.
    default void
    setStreamingMode(Object value)
    Indicates whether the rates/margins of this trade were manually provided, 'Manual Mode', 'Streaming Mode'
    default void
    setSwapAskMargin(Object value)
    This field represents the swap margin to be applied to the bid side: L*_FwdAskMargin + L2_FwdBidMargin.
    default void
    setSwapAskPoints(Object value)
    This is the swap ask points that the client wants to trade on.
    default void
    setSwapBidMargin(Object value)
    This field represents the swap margin to be applied to the bid side: L*_FwdAskMargin + L2_FwdBidMargin.
    default void
    setSwapBidPoints(Object value)
    This is the swap bid points that the client wants to trade on.
    default void
    setTOBOUser(Object value)
    The user the trade is on behalf of.
    default void
    setTraderRemarks(Object value)
    The trader's comments on an trade - visible to only the Trader
    default void
    setTraderSpotAskRate(Object value)
    This field is included on the rate update that the client wants to trade on
    default void
    setTraderSpotBidRate(Object value)
    This field is included on the rate update that the client wants to trade on
    default void
    setTradingAssetClass(Object value)
    The trading asset class for the trade; used by permissioning and licensing.
    default void
    setTradingProtocol(Object value)
    The trade protocol, e.g, ESP or RFS.
    default void
    setTradingType(Object value)
    Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD].

  • Method Details

    • addField

      void addField(String fieldName, Object value)
      Adds a field to this event
      Parameters:
      fieldName - The name of the field to add.
      value - The value of the field to add. If the value is a BigDecimal then it will be converted to a String using BigDecimal.toPlainString()

    • setQuoteID

      default void setQuoteID(Object value)
      The unique ID of the quote the client wants to trade on. This is generated by the OMS. Unlike ESP where you have a quote ID for the forward points and a quote ID for the related SPOT quote there is only one quote ID for an RFS quote, even if it's a forward or swap
      Parameters:
      value - The value to be set passed by i18n

    • setSpotBidRate

      default void setSpotBidRate(Object value)
      This field is included on the rate update that the client wants to trade on
      Parameters:
      value - The value to be set passed by i18n

    • setSpotAskRate

      default void setSpotAskRate(Object value)
      This field is included on the rate update that the client wants to trade on
      Parameters:
      value - The value to be set passed by i18n

    • setAssetClass

      default void setAssetClass(Object value)
      The asset class for the trade; used by permissioning and licensing.
      Parameters:
      value - The value to be set passed by i18n

    • setTradingAssetClass

      default void setTradingAssetClass(Object value)
      The trading asset class for the trade; used by permissioning and licensing.
      Parameters:
      value - The value to be set passed by i18n

    • setTradingProtocol

      default void setTradingProtocol(Object value)
      The trade protocol, e.g, ESP or RFS. The Trading DataSource library needs this so that it knows which state model to use for the trade. Also used for permissioning.
      Parameters:
      value - The value to be set passed by i18n

    • setTOBOUser

      default void setTOBOUser(Object value)
      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.
      Parameters:
      value - The value to be set passed by i18n

    • setCurrencyPair

      default void setCurrencyPair(Object value)
      The currency pair for the trade. For example, EURUSD
      Parameters:
      value - The value to be set passed by i18n

    • setDealtCurrency

      default void setDealtCurrency(Object value)
      The currency of the Amount of a trade or order. For example, GBP
      Parameters:
      value - The value to be set passed by i18n

    • setTradingType

      default void setTradingType(Object value)
      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.
      Parameters:
      value - The value to be set passed by i18n

    • setStartDate

      default void setStartDate(Object value)
      The start date value for a time option trade. example: 20150620
      Parameters:
      value - The value to be set passed by i18n

    • setEndDate

      default void setEndDate(Object value)
      The end date value for a time option trade. example: 20150620
      Parameters:
      value - The value to be set passed by i18n

    • setSpotBidMargin

      default void setSpotBidMargin(Object value)
      This field represents the spot margin that the sales user has selected. It should be sent as a raw value, and unformatted.
      Parameters:
      value - The value to be set passed by i18n

    • setSpotAskMargin

      default void setSpotAskMargin(Object value)
      This field represents the spot margin that the sales user has selected. It should be sent as a raw value, and unformatted.
      Parameters:
      value - The value to be set passed by i18n

    • setSwapBidPoints

      default void setSwapBidPoints(Object value)
      This is the swap bid points that the client wants to trade on.
      Parameters:
      value - The value to be set passed by i18n

    • setSwapAskPoints

      default void setSwapAskPoints(Object value)
      This is the swap ask points that the client wants to trade on.
      Parameters:
      value - The value to be set passed by i18n

    • setSwapBidMargin

      default void setSwapBidMargin(Object value)
      This field represents the swap margin to be applied to the bid side: L*_FwdAskMargin + L2_FwdBidMargin.
      Parameters:
      value - The value to be set passed by i18n

    • setSwapAskMargin

      default void setSwapAskMargin(Object value)
      This field represents the swap margin to be applied to the bid side: L*_FwdAskMargin + L2_FwdBidMargin.
      Parameters:
      value - The value to be set passed by i18n

    • setIsAdvised

      default void setIsAdvised(Object value)
      true or false to indicate whether the trader gave the client advice
      Parameters:
      value - The value to be set passed by i18n

    • setRemarks

      default void setRemarks(Object value)
      The clients or trader's comments on a trade - visible to both the Client and the Trader.
      Parameters:
      value - The value to be set passed by i18n

    • setTraderRemarks

      default void setTraderRemarks(Object value)
      The trader's comments on an trade - visible to only the Trader
      Parameters:
      value - The value to be set passed by i18n

    • setStreamingMode

      default void setStreamingMode(Object value)
      Indicates whether the rates/margins of this trade were manually provided, 'Manual Mode', 'Streaming Mode'
      Parameters:
      value - The value to be set passed by i18n

    • setTraderSpotBidRate

      default void setTraderSpotBidRate(Object value)
      This field is included on the rate update that the client wants to trade on
      Parameters:
      value - The value to be set passed by i18n

    • setTraderSpotAskRate

      default void setTraderSpotAskRate(Object value)
      This field is included on the rate update that the client wants to trade on
      Parameters:
      value - The value to be set passed by i18n

    • setAllInBidRate

      default void setAllInBidRate(Object value)
      The bid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
      Parameters:
      value - The value to be set passed by i18n

    • setAllInAskRate

      default void setAllInAskRate(Object value)
      The ask rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
      Parameters:
      value - The value to be set passed by i18n

    • setAllInBidMargin

      default void setAllInBidMargin(Object value)
      This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
      Parameters:
      value - The value to be set passed by i18n

    • setAllInAskMargin

      default void setAllInAskMargin(Object value)
      This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
      Parameters:
      value - The value to be set passed by i18n

    • setBidPips

      @Deprecated default void setBidPips(Object value)
      Deprecated.
      For swap trades this field is included on the rate update that the client wants to trade on. For non-swap trades this field should be not sent.
      Parameters:
      value - The value to be set passed by i18n

    • setAskPips

      @Deprecated default void setAskPips(Object value)
      Deprecated.
      For swap trades this field is included on the rate update that the client wants to trade on. For non-swap trades this field should be not sent.
      Parameters:
      value - The value to be set passed by i18n

    • setPurpose

      default void setPurpose(Object value)
      The purpose of the trade. Example: Commercial
      Parameters:
      value - The value to be set passed by i18n

    • setIsCommercial

      default void setIsCommercial(Object value)
      Indication whether something is commercial or not
      Parameters:
      value - The value to be set passed by i18n

    • setClientAgreementDateTime

      default void setClientAgreementDateTime(Object value)
      Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different.
      Parameters:
      value - The value to be set passed by i18n

    • setAppID

      default void setAppID(Object value)
      A unique identifier for the client application
      Parameters:
      value - The value to be set passed by i18n

    • setSpotTrader

      default void setSpotTrader(Object value)
      The Spot trader for a manual mode trade
      Parameters:
      value - The value to be set passed by i18n

    • setForwardPointsTrader

      default void setForwardPointsTrader(Object value)
      The Forward points trader for a manual mode trade
      Parameters:
      value - The value to be set passed by i18n