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

Interface ExecutionLegClientFieldSet

All Superinterfaces:
LeggedMessage, Message
All Known Implementing Classes:
ExecutionLegClientFieldSetChild
public interface ExecutionLegClientFieldSet extends LeggedMessage

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getAllInAskMargin()
    This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
    default String
    getAllInAskRate()
    This field is included on the rate update that the client wants to trade on, and should be sent back unchanged on the Submit message
    default String
    getAllInBidMargin()
    This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
    default String
    getAllInBidRate()
    This field is included on the rate update that the client wants to trade on, and should be sent back unchanged on the Submit message
    default String
    getBuySell()
    Whether the client wants to buy or sell the base currency, NOT the dealt currency.
    default String
    getBuySideLocked()
    This represents whether the user locked the rates for the buy side.
    default String
    getFwdAskMargin()
    This field represents the Forward margin that the sales user has selected.
    default String
    getFwdAskPips()
    Deprecated.
    default String
    getFwdAskPoints()
    For forward trades this is the forward points that the client wants to trade on.
    default String
    getFwdBidMargin()
    This field represents the Forward margin that the sales user has selected.
    default String
    getFwdBidPips()
    Deprecated.
    default String
    getFwdBidPoints()
    For forward trades this is the forward points that the client wants to trade on.
    default String
    getFwdPips()
    Deprecated.
    default String
    getPrice()
    This is the all-in rate that the client wants to trade on.
    default String
    getRemarks()
    Overrides remarks on the SubmissionLeg.
    default String
    getSellSideLocked()
    This represents whether the user locked the rates for the sell side.
    default String
    getTraderRemarks()
    The trader's comments on a trade

    Methods inherited from interface com.caplin.motif.datasource.LeggedMessage

    getId, getIndex

    Methods inherited from interface com.caplin.motif.datasource.Message

    getField, getFields

  • Method Details

    • getBuySell

      default String getBuySell()
      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.

    • getPrice

      default String getPrice()
      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.

    • getFwdBidPoints

      default String getFwdBidPoints()
      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.

    • getFwdAskPoints

      default String getFwdAskPoints()
      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.

    • getAllInBidRate

      default String getAllInBidRate()
      This field is included on the rate update that the client wants to trade on, and should be sent back unchanged on the Submit message

    • getAllInAskRate

      default String getAllInAskRate()
      This field is included on the rate update that the client wants to trade on, and should be sent back unchanged on the Submit message

    • getAllInBidMargin

      default String getAllInBidMargin()
      This is the user’s selected SpotBidMargin added to the selected FwdBidMargin

    • getAllInAskMargin

      default String getAllInAskMargin()
      This is the user’s selected SpotBidMargin added to the selected FwdBidMargin

    • getFwdBidMargin

      default String getFwdBidMargin()
      This field represents the Forward margin that the sales user has selected. This field should be sent raw and unformatted.

    • getFwdAskMargin

      default String getFwdAskMargin()
      This field represents the Forward margin that the sales user has selected. This field should be sent raw and unformatted.

    • getBuySideLocked

      default String getBuySideLocked()
      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.

    • getSellSideLocked

      default String getSellSideLocked()
      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.

    • getRemarks

      default String getRemarks()
      Overrides remarks on the SubmissionLeg.

    • getTraderRemarks

      default String getTraderRemarks()
      The trader's comments on a trade

    • getFwdPips

      @Deprecated default String getFwdPips()
      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

    • getFwdBidPips

      @Deprecated default String getFwdBidPips()
      Deprecated.
      This field is included on the rate update that the client wants to trade on if it is a streaming Forward rate, and should be sent back unchanged on the Submit message. 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.

    • getFwdAskPips

      @Deprecated default String getFwdAskPips()
      Deprecated.
      This field is included on the rate update that the client wants to trade on if it is a streaming Forward rate, and should be sent back unchanged on the Submit message. 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.