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

Interface ExecutionLegServerFieldSet

public interface ExecutionLegServerFieldSet

  • 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)
    This field is included on the rate update that the client wants to trade on
    default void
    setAllInBidMargin(Object value)
    This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
    default void
    setAllInBidRate(Object value)
    This field is included on the rate update that the client wants to trade on
    default void
    setBuySell(Object value)
    Whether the client wants to buy or sell the base currency, NOT the dealt currency.
    default void
    setBuySideLocked(Object value)
    This represents whether the user locked the rates for the buy side.
    default void
    setFwdAskMargin(Object value)
    This field represents the Forward margin that the sales user has selected.
    default void
    setFwdAskPips(Object value)
    Deprecated.
    default void
    setFwdAskPoints(Object value)
    For forward trades this is the forward points that the client wants to trade on.
    default void
    setFwdBidMargin(Object value)
    This field represents the Forward margin that the sales user has selected.
    default void
    setFwdBidPips(Object value)
    Deprecated.
    default void
    setFwdBidPoints(Object value)
    For forward trades this is the forward points that the client wants to trade on.
    default void
    setFwdPips(Object value)
    Deprecated.
    default void
    setPrice(Object value)
    This is the all-in rate that the client wants to trade on.
    default void
    setRemarks(Object value)
    Overrides remarks on the SubmissionLeg.
    default void
    setSellSideLocked(Object value)
    This represents whether the user locked the rates for the sell side.
    default void
    setTraderFwdAskPoints(Object value)
    The trader forward ask points
    default void
    setTraderFwdBidPoints(Object value)
    The trader forward bid points
    default void
    setTraderRemarks(Object value)
    The trader's comments on a trade

  • 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()

    • setBuySell

      default void setBuySell(Object value)
      Whether the client wants to buy or sell the base currency, NOT the dealt currency. For example if the currency pair is EURGBP and this value is EUR then this field always tells you if the client wants to buy or sell EUR, even if the dealt currency is GBP. The dealt currency just tells you which currency the client has specified the amount in.
      Parameters:
      value - The value to be set passed by i18n

    • setPrice

      default void setPrice(Object value)
      This is the all-in rate that the client wants to trade on. The value of this field must equal the value of either the L*_AllInBidRate or L*_AllInAskRate field on the rate update that the client is executing. The front end typically populates this field by reading the currently rendered price on the buy or sell button at the time the user clicks.
      Parameters:
      value - The value to be set passed by i18n

    • setFwdBidPoints

      default void setFwdBidPoints(Object value)
      For forward trades this is the forward points that the client wants to trade on. The value of this field must equal the value of either the BidPoints or AskPoints field on the rate update that the client is executing. For SPOT trades this field should be not sent. If the trade is a forward but the back end did not send the BidPoints and AskPoints fields (because they are optional) then this field should be not sent.
      Parameters:
      value - The value to be set passed by i18n

    • setFwdAskPoints

      default void setFwdAskPoints(Object value)
      For forward trades this is the forward points that the client wants to trade on. The value of this field must equal the value of either the BidPoints or AskPoints field on the rate update that the client is executing. For SPOT trades this field should be not sent. If the trade is a forward but the back end did not send the BidPoints and AskPoints fields (because they are optional) then this field should be not sent.
      Parameters:
      value - The value to be set passed by i18n

    • setAllInBidRate

      default void setAllInBidRate(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

    • setAllInAskRate

      default void setAllInAskRate(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

    • 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

    • setFwdBidMargin

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

    • setFwdAskMargin

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

    • setBuySideLocked

      default void setBuySideLocked(Object value)
      This represents whether the user locked the rates for the buy side. Follows the same rules about base/dealt currency as the BuySell field. Only sent if the Missed Trades feature is enabled in the Frontend configuration.
      Parameters:
      value - The value to be set passed by i18n

    • setSellSideLocked

      default void setSellSideLocked(Object value)
      This represents whether the user locked the rates for the sell side. Follows the same rules about base/dealt currency as the BuySell field. Only sent if the Missed Trades feature is enabled in the Frontend configuration.
      Parameters:
      value - The value to be set passed by i18n

    • setRemarks

      default void setRemarks(Object value)
      Overrides remarks on the SubmissionLeg.
      Parameters:
      value - The value to be set passed by i18n

    • setTraderRemarks

      default void setTraderRemarks(Object value)
      The trader's comments on a trade
      Parameters:
      value - The value to be set passed by i18n

    • setFwdPips

      @Deprecated default void setFwdPips(Object value)
      Deprecated.
      For forward trades this is the forward pips that the client wants to trade on. The value of this field must equal the value of either the BidPips or AskPips field on the rate update that the client is executing. The front end typically populates this field by reading the currently rendered forward points on the buy or sell button at the time the user clicks. For SPOT trades this field should be not sent
      Parameters:
      value - The value to be set passed by i18n

    • setFwdBidPips

      @Deprecated default void setFwdBidPips(Object value)
      Deprecated.
      This field is included on the rate update that the client wants to trade on if it is a streaming Forward rate. If it is not present on the rate update (which will be the case for an RFS SPOT trade) then it should not be sent on the Submit message either.
      Parameters:
      value - The value to be set passed by i18n

    • setFwdAskPips

      @Deprecated default void setFwdAskPips(Object value)
      Deprecated.
      This field is included on the rate update that the client wants to trade on if it is a streaming Forward rate. If it is not present on the rate update (which will be the case for an RFS SPOT trade) then it should not be sent on the Submit message either.
      Parameters:
      value - The value to be set passed by i18n

    • setTraderFwdBidPoints

      default void setTraderFwdBidPoints(Object value)
      The trader forward bid points
      Parameters:
      value - The value to be set passed by i18n

    • setTraderFwdAskPoints

      default void setTraderFwdAskPoints(Object value)
      The trader forward ask points
      Parameters:
      value - The value to be set passed by i18n