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

Interface LegDetailsClientFieldSet

All Superinterfaces:
LeggedMessage, Message
All Known Implementing Classes:
LegDetailsClientFieldSetChild
public interface LegDetailsClientFieldSet extends LeggedMessage

  • Method Details

    • getOrderID

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

    • getAmount

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

    • getMonitorSide

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

    • getDealtCurrency

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

    • getBuySell

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

    • getExecutionType

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

    • getBenchmarkType

      default String getBenchmarkType()
      The type of benchmark, or benchmark provider, e.g. 'WM'.

    • getBenchmarkDate

      default String getBenchmarkDate()
      The fixing date of the benchmark in ISO-8601 format, e.g. 'YYYY-MM-DD'

    • getBenchmarkTime

      default String getBenchmarkTime()
      The fixing time of the benchmark in ISO-8601 format, e.g. '18:00'.

    • getBenchmarkTimeZone

      default String getBenchmarkTimeZone()
      The timezone of the benchmark fixing date and time - must be in TZ format, e.g. America/New_York or Europe/London..

    • getLimitPrice

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

    • getMargin

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

    • getRemarks

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

    • getTraderRemarks

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

    • getChildLegId

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

    • getChildRelationship

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

    • getPartnerLegId

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

    • getPartnerRelationship

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

    • getLoopLegId

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

    • getAllowPartialFill

      default String getAllowPartialFill()
      Indicates whether the order leg can be partially filled

    • getFillMode

      default String getFillMode()
      The permitted fill types for this leg, e.g. ANY, MANUAL or AUTO

    • getTrigger

      default String getTrigger()
      The trigger type for the order, e.g. GIVEN, ASK, AT-RATE

    • getFillRate

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

    • getDiscretion

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

    • getOrderTenor

      default 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 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.

    • getOrderFixingDate

      default String getOrderFixingDate()
      The date an NDF order will fix on if filled.