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

Interface ExecutionServerFieldSet

  • public interface ExecutionServerFieldSet

    • 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 setAppID​(java.lang.Object value)
      A unique identifier for the client application
      default void setAskPips​(java.lang.Object value)
      Deprecated.
      default void setAssetClass​(java.lang.Object value)
      The asset class for the trade; used by permissioning and licensing.
      default void setBidPips​(java.lang.Object value)
      Deprecated.
      default void setClientAgreementDateTime​(java.lang.Object value)
      Optional field that can be used to display the client agreement date time in a trade amend.
      default void setIsAdvised​(java.lang.Object value)
      true or false to indicate whether the trader gave the client advice
      default void setPurpose​(java.lang.Object value)
      The purpose of the trade.
      default void setQuoteID​(java.lang.Object value)
      The unique ID of the quote the client wants to trade on.
      default void setRemarks​(java.lang.Object value)
      The clients or trader's comments on a trade - visible to both the Client and the Trader.
      default void setSpotAskMargin​(java.lang.Object value)
      This field represents the spot margin that the sales user has selected.
      default void setSpotAskRate​(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 setSpotBidMargin​(java.lang.Object value)
      This field represents the spot margin that the sales user has selected.
      default void setSpotBidRate​(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 setStreamingMode​(java.lang.Object value)
      Indicates whether the rates/margins of this trade were manually provided, 'Manual Mode', 'Streaming Mode'
      default void setSwapAskMargin​(java.lang.Object value)
      This field represents the swap margin to be applied to the bid side: L*_FwdAskMargin + L2_FwdBidMargin.
      default void setSwapAskPoints​(java.lang.Object value)
      This is the swap ask points that the client wants to trade on.
      default void setSwapBidMargin​(java.lang.Object value)
      This field represents the swap margin to be applied to the bid side: L*_FwdAskMargin + L2_FwdBidMargin.
      default void setSwapBidPoints​(java.lang.Object value)
      This is the swap bid points that the client wants to trade on.
      default void setTraderRemarks​(java.lang.Object value)
      The trader's comments on an trade - visible to only the Trader
      default void setTraderSpotAskRate​(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 setTraderSpotBidRate​(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 setTradingAssetClass​(java.lang.Object value)
      The trading asset class for the trade; used by permissioning and licensing.
      default void setTradingProtocol​(java.lang.Object value)
      The trade protocol, e.g, ESP or RFS.

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

      • setQuoteID

        default void setQuoteID​(java.lang.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​(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

      • setSpotAskRate

        default void setSpotAskRate​(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

      • setAssetClass

        default void setAssetClass​(java.lang.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​(java.lang.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​(java.lang.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

      • setSpotBidMargin

        default void setSpotBidMargin​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(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

      • setTraderSpotAskRate

        default void setTraderSpotAskRate​(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

      • setBidPips

        @Deprecated
default void setBidPips​(java.lang.Object value)
        Deprecated.
        For swap trades 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. 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​(java.lang.Object value)
        Deprecated.
        For swap trades 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. For non-swap trades this field should be not sent.
        Parameters:
        value - The value to be set passed by i18n

      • setPurpose

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

      • setClientAgreementDateTime

        default void setClientAgreementDateTime​(java.lang.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​(java.lang.Object value)
        A unique identifier for the client application
        Parameters:
        value - The value to be set passed by i18n