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

Interface LegDetailsClientFieldSet

    • Method Summary

      All Methods Instance Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      default java.lang.String getAmount()
      The amount to trade in the dealt currency.
      default java.lang.String getBenchmarkType()
      If this leg is a benchmark order, what type of benchmark is it.
      default java.lang.String getBuySell()
      The direction of this leg from the clients perspective.
      default java.lang.String getChildLegId()
      If this leg has a child, what is the ID of it, e.g.
      default java.lang.String getChildRelationship()
      If this leg has a child, what is the relationship, e.g.
      default java.lang.String getDealtCurrency()
      The currency to define the amount in.
      default java.lang.String getDiscretion()
      Number of points the trader has discretion to fill the order
      default java.lang.String getExecutionType()
      How this leg should be executed.
      default java.lang.String getFillRate()
      Deprecated.
      default java.lang.String getLimitPrice()
      The price at which this leg should fill.
      default java.lang.String getLoopLegId()
      The leg to loop back to upon completion, e.g.
      default java.lang.String getMargin()
      The sales margin to be applied to the limit price in order to find the tracking rate.
      default java.lang.String getMonitorSide()
      The side of the market this leg should monitor.
      default java.lang.String getOrderID()
      The order id, should only be sent on and an Edit Order
      default java.lang.String getOrderSettlementDate()
      For Forward and NDF orders only.
      default java.lang.String getOrderTenor()
      For Forward and NDF orders only.
      default java.lang.String getPartnerLegId()
      If this leg has a partner, what is the ID of it, e.g.
      default java.lang.String getPartnerRelationship()
      If this leg has a partner, what is the relationship, e.g.
      default java.lang.String getRemarks()
      The clients or trader's comments on an order leg - visible to both the Client and the Trader.
      default java.lang.String getTraderRemarks()
      The trader's comments on an order leg - visible to only the Trader

    • Method Detail

      • getOrderID

        default java.lang.String getOrderID()
        The order id, should only be sent on and an Edit Order

      • getAmount

        default java.lang.String getAmount()
        The amount to trade in the dealt currency.

      • getMonitorSide

        default java.lang.String getMonitorSide()
        The side of the market this leg should monitor. e.g. BID or ASK.

      • getDealtCurrency

        default java.lang.String getDealtCurrency()
        The currency to define the amount in.

      • getBuySell

        default java.lang.String getBuySell()
        The direction of this leg from the clients perspective. e.g. BUY or SELL.

      • getExecutionType

        default java.lang.String getExecutionType()
        How this leg should be executed. e.g. CALL-ORDER, TAKE-PROFIT, STOP-LOSS or MARKET.

      • getBenchmarkType

        default java.lang.String getBenchmarkType()
        If this leg is a benchmark order, what type of benchmark is it.

      • getLimitPrice

        default java.lang.String getLimitPrice()
        The price at which this leg should fill.

      • getMargin

        default java.lang.String getMargin()
        The sales margin to be applied to the limit price in order to find the tracking rate.

      • getRemarks

        default java.lang.String getRemarks()
        The clients or trader's comments on an order leg - visible to both the Client and the Trader.

      • getTraderRemarks

        default java.lang.String getTraderRemarks()
        The trader's comments on an order leg - visible to only the Trader

      • getChildLegId

        default java.lang.String getChildLegId()
        If this leg has a child, what is the ID of it, e.g. 2

      • getChildRelationship

        default java.lang.String getChildRelationship()
        If this leg has a child, what is the relationship, e.g. IF-DONE or IF-TIMEOUT

      • getPartnerLegId

        default java.lang.String getPartnerLegId()
        If this leg has a partner, what is the ID of it, e.g. 2

      • getPartnerRelationship

        default java.lang.String getPartnerRelationship()
        If this leg has a partner, what is the relationship, e.g. OCO

      • getLoopLegId

        default java.lang.String getLoopLegId()
        The leg to loop back to upon completion, e.g. 1

      • getFillRate

        @Deprecated
default java.lang.String getFillRate()
        Deprecated.
        The limit price for the order. This has been deprecated and you should prefer the LimitPrice field.

      • getDiscretion

        default java.lang.String getDiscretion()
        Number of points the trader has discretion to fill the order

      • getOrderTenor

        default java.lang.String getOrderTenor()
        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.

      • getOrderSettlementDate

        default java.lang.String getOrderSettlementDate()
        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.