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

Interface ExecutionLegServerFieldSet

  • public interface ExecutionLegServerFieldSet

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      void addField​(java.lang.String fieldName, java.lang.Object value)
      Adds a field to this event
      default void setAllInAskMargin​(java.lang.Object value)
      This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
      default void setAllInAskRate​(java.lang.Object value)
      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 void setAllInBidMargin​(java.lang.Object value)
      This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
      default void setAllInBidRate​(java.lang.Object value)
      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 void setBuySell​(java.lang.Object value)
      Whether the client wants to buy or sell the base currency, NOT the dealt currency.
      default void setBuySideLocked​(java.lang.Object value)
      This represents whether the user locked the rates for the buy side.
      default void setFwdAskMargin​(java.lang.Object value)
      This field represents the Forward margin that the sales user has selected.
      default void setFwdAskPips​(java.lang.Object value)
      Deprecated.
      default void setFwdAskPoints​(java.lang.Object value)
      For forward trades this is the forward points that the client wants to trade on.
      default void setFwdBidMargin​(java.lang.Object value)
      This field represents the Forward margin that the sales user has selected.
      default void setFwdBidPips​(java.lang.Object value)
      Deprecated.
      default void setFwdBidPoints​(java.lang.Object value)
      For forward trades this is the forward points that the client wants to trade on.
      default void setFwdPips​(java.lang.Object value)
      Deprecated.
      default void setPaySettlementID​(java.lang.Object value)
      Deprecated.
      default void setPaySettlementInstructionType​(java.lang.Object value)
      Deprecated.
      default void setPaySettlementRemarks​(java.lang.Object value)
      Deprecated.
      default void setPrice​(java.lang.Object value)
      This is the all-in rate that the client wants to trade on.
      default void setReceiveSettlementID​(java.lang.Object value)
      Deprecated.
      default void setReceiveSettlementInstructionType​(java.lang.Object value)
      Deprecated.
      default void setReceiveSettlementRemarks​(java.lang.Object value)
      Deprecated.
      default void setRemarks​(java.lang.Object value)
      Overrides remarks on the SubmissionLeg.
      default void setSellSideLocked​(java.lang.Object value)
      This represents whether the user locked the rates for the sell side.
      default void setTraderRemarks​(java.lang.Object value)
      The trader's comments on a trade

    • Method Detail

      • addField

        void addField​(java.lang.String fieldName,
              java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.Object value)
        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
        Parameters:
        value - The value to be set passed by i18n

      • setAllInAskRate

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

      • setAllInBidMargin

        default void setAllInBidMargin​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.Object value)
        Overrides remarks on the SubmissionLeg.
        Parameters:
        value - The value to be set passed by i18n

      • setTraderRemarks

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

      • setPaySettlementID

        @Deprecated
default void setPaySettlementID​(java.lang.Object value)
        Deprecated.
        The ID corresponding to the payee's settlement details
        Parameters:
        value - The value to be set passed by i18n

      • setPaySettlementRemarks

        @Deprecated
default void setPaySettlementRemarks​(java.lang.Object value)
        Deprecated.
        The remarks corresponding to the payee's settlement details
        Parameters:
        value - The value to be set passed by i18n

      • setPaySettlementInstructionType

        @Deprecated
default void setPaySettlementInstructionType​(java.lang.Object value)
        Deprecated.
        The type of settlement instruction on the pay side.
        Parameters:
        value - The value to be set passed by i18n

      • setReceiveSettlementID

        @Deprecated
default void setReceiveSettlementID​(java.lang.Object value)
        Deprecated.
        The ID corresponding to the recipient's settlement details
        Parameters:
        value - The value to be set passed by i18n

      • setReceiveSettlementRemarks

        @Deprecated
default void setReceiveSettlementRemarks​(java.lang.Object value)
        Deprecated.
        The remarks corresponding to the recipient's settlement details
        Parameters:
        value - The value to be set passed by i18n

      • setReceiveSettlementInstructionType

        @Deprecated
default void setReceiveSettlementInstructionType​(java.lang.Object value)
        Deprecated.
        The type of settlement instruction on the receive side.
        Parameters:
        value - The value to be set passed by i18n

      • setFwdPips

        @Deprecated
default void setFwdPips​(java.lang.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​(java.lang.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, 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.
        Parameters:
        value - The value to be set passed by i18n

      • setFwdAskPips

        @Deprecated
default void setFwdAskPips​(java.lang.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, 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.
        Parameters:
        value - The value to be set passed by i18n