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

Interface LegDetailsServerFieldSet

  • public interface LegDetailsServerFieldSet

    • 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 setAllowPartialFill​(java.lang.Object value)
      Denotes if this leg may be partially filled
      default void setAmount​(java.lang.Object value)
      The amount to trade in the dealt currency.
      default void setBenchmarkType​(java.lang.Object value)
      If this leg is a benchmark order, what type of benchmark is it.
      default void setBuySell​(java.lang.Object value)
      The direction of this leg from the clients perspective.
      default void setChildLegId​(java.lang.Object value)
      If this leg has a child, what is the ID of it, e.g.
      default void setChildRelationship​(java.lang.Object value)
      If this leg has a child, what is the relationship, e.g.
      default void setDealtCurrency​(java.lang.Object value)
      The currency to define the amount in.
      default void setDiscretion​(java.lang.Object value)
      Number of points the trader has discretion to fill the order
      default void setExecutionType​(java.lang.Object value)
      How this leg should be executed.
      default void setFillMode​(java.lang.Object value)
      The permitted fill types for this leg, e.g.
      default void setFillRate​(java.lang.Object value)
      Deprecated.
      default void setLimitPrice​(java.lang.Object value)
      The price at which this leg should fill.
      default void setLoopLegId​(java.lang.Object value)
      The leg to loop back to upon completion, e.g.
      default void setMargin​(java.lang.Object value)
      The sales margin to be applied to the limit price in order to find the tracking rate.
      default void setMonitorSide​(java.lang.Object value)
      The side of the market this leg should monitor.
      default void setOrderFixingDate​(java.lang.Object value)
      The date an NDF order will fix on if filled.
      default void setOrderID​(java.lang.Object value)
      The order id, should only be sent on and an Edit Order
      default void setOrderSettlementDate​(java.lang.Object value)
      For Forward and NDF orders only.
      default void setOrderTenor​(java.lang.Object value)
      For Forward and NDF orders only.
      default void setPartnerLegId​(java.lang.Object value)
      If this leg has a partner, what is the ID of it, e.g.
      default void setPartnerRelationship​(java.lang.Object value)
      If this leg has a partner, what is the relationship, e.g.
      default void setRemarks​(java.lang.Object value)
      The clients or trader's comments on an order leg - visible to both the Client and the Trader.
      default void setTraderRemarks​(java.lang.Object value)
      The trader's comments on an order leg - visible to only the Trader

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

      • setOrderID

        default void setOrderID​(java.lang.Object value)
        The order id, should only be sent on and an Edit Order
        Parameters:
        value - The value to be set passed by i18n

      • setAmount

        default void setAmount​(java.lang.Object value)
        The amount to trade in the dealt currency.
        Parameters:
        value - The value to be set passed by i18n

      • setMonitorSide

        default void setMonitorSide​(java.lang.Object value)
        The side of the market this leg should monitor. e.g. BID or ASK.
        Parameters:
        value - The value to be set passed by i18n

      • setDealtCurrency

        default void setDealtCurrency​(java.lang.Object value)
        The currency to define the amount in.
        Parameters:
        value - The value to be set passed by i18n

      • setBuySell

        default void setBuySell​(java.lang.Object value)
        The direction of this leg from the clients perspective. e.g. BUY or SELL.
        Parameters:
        value - The value to be set passed by i18n

      • setExecutionType

        default void setExecutionType​(java.lang.Object value)
        How this leg should be executed. e.g. CALL-ORDER, TAKE-PROFIT, STOP-LOSS or MARKET.
        Parameters:
        value - The value to be set passed by i18n

      • setBenchmarkType

        default void setBenchmarkType​(java.lang.Object value)
        If this leg is a benchmark order, what type of benchmark is it.
        Parameters:
        value - The value to be set passed by i18n

      • setLimitPrice

        default void setLimitPrice​(java.lang.Object value)
        The price at which this leg should fill.
        Parameters:
        value - The value to be set passed by i18n

      • setMargin

        default void setMargin​(java.lang.Object value)
        The sales margin to be applied to the limit price in order to find the tracking rate.
        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 an order leg - 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 order leg - visible to only the Trader
        Parameters:
        value - The value to be set passed by i18n

      • setChildLegId

        default void setChildLegId​(java.lang.Object value)
        If this leg has a child, what is the ID of it, e.g. 2
        Parameters:
        value - The value to be set passed by i18n

      • setChildRelationship

        default void setChildRelationship​(java.lang.Object value)
        If this leg has a child, what is the relationship, e.g. IF-DONE or IF-TIMEOUT
        Parameters:
        value - The value to be set passed by i18n

      • setPartnerLegId

        default void setPartnerLegId​(java.lang.Object value)
        If this leg has a partner, what is the ID of it, e.g. 2
        Parameters:
        value - The value to be set passed by i18n

      • setPartnerRelationship

        default void setPartnerRelationship​(java.lang.Object value)
        If this leg has a partner, what is the relationship, e.g. OCO
        Parameters:
        value - The value to be set passed by i18n

      • setLoopLegId

        default void setLoopLegId​(java.lang.Object value)
        The leg to loop back to upon completion, e.g. 1
        Parameters:
        value - The value to be set passed by i18n

      • setAllowPartialFill

        default void setAllowPartialFill​(java.lang.Object value)
        Denotes if this leg may be partially filled
        Parameters:
        value - The value to be set passed by i18n

      • setFillMode

        default void setFillMode​(java.lang.Object value)
        The permitted fill types for this leg, e.g. ANY, MANUAL or AUTO
        Parameters:
        value - The value to be set passed by i18n

      • setFillRate

        @Deprecated
default void setFillRate​(java.lang.Object value)
        Deprecated.
        The limit price for the order. This has been deprecated and you should prefer the LimitPrice field.
        Parameters:
        value - The value to be set passed by i18n

      • setDiscretion

        default void setDiscretion​(java.lang.Object value)
        Number of points the trader has discretion to fill the order
        Parameters:
        value - The value to be set passed by i18n

      • setOrderTenor

        default void setOrderTenor​(java.lang.Object value)
        For Forward and NDF orders only. Either a tenor or settlement date should be provided, but not both. The order tenor is a rolling tenor calculated from today.
        Parameters:
        value - The value to be set passed by i18n

      • setOrderSettlementDate

        default void setOrderSettlementDate​(java.lang.Object value)
        For Forward and NDF orders only. Either a tenor or settlement Date should be provided, but not both. A settlement date In ISO-8601 format, i.e. YYYY-MM-DD for which the order will settle.
        Parameters:
        value - The value to be set passed by i18n

      • setOrderFixingDate

        default void setOrderFixingDate​(java.lang.Object value)
        The date an NDF order will fix on if filled.
        Parameters:
        value - The value to be set passed by i18n