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

Class OrderDetailsPartsDef.LegFields.Builder

java.lang.Object
com.caplin.generated.motif.fx.orders.OrderDetailsPartsDef.LegFields.Builder
Enclosing class:
OrderDetailsPartsDef.LegFields
public static final class OrderDetailsPartsDef.LegFields.Builder extends Object

  • Method Details

    • addField

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value)

    • build

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields build()

    • toString

      @NotNull public @NotNull String toString()
      Overrides:
      toString in class Object

    • setEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setEditable(boolean editable)
      Returns:
      Whether a trade or order is editable.

    • setEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setEditable(@NotNull @NotNull String editable)
      Returns:
      Whether a trade or order is editable.

    • setOrderID

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderID(@NotNull @NotNull String orderID)
      Parameters:
      orderID - e.g. 000012345
      Returns:
      The id of the order.

    • setStatus

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setStatus(@NotNull @NotNull String status)
      Parameters:
      status - e.g. Completed
      Returns:
      Status of the trade. Frontends may use this value for display purpose, but no logic is associated with it. Use Can* flags to drive post-trade logic.

    • setStatusCategory

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setStatusCategory(@NotNull @NotNull String statusCategory)
      Parameters:
      statusCategory - e.g. SUCCESS
      Returns:
      StatusCategory can be NEUTRAL, SUCCESS, WARNING, ERROR. If missing, frontend treats it as NEUTRAL. Used in frontends to color code `Status` text e.g. whether to color a status badge green or red.

    • setStatusIsFinal

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setStatusIsFinal(boolean statusIsFinal)
      Parameters:
      statusIsFinal - e.g. true
      Returns:
      StatusIsFinal can be true or false. Assumed false if missing or empty string. Used in frontends to color code `Status` text e.g. whether to color a status badge background dark green or light green.

    • setStatusIsFinal

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setStatusIsFinal(@NotNull @NotNull String statusIsFinal)
      Parameters:
      statusIsFinal - e.g. true
      Returns:
      StatusIsFinal can be true or false. Assumed false if missing or empty string. Used in frontends to color code `Status` text e.g. whether to color a status badge background dark green or light green.

    • setOrderStatus

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderStatus(@NotNull @NotNull String orderStatus)
      Parameters:
      orderStatus - e.g. ACTIVE
      Returns:
      Caplin supported statuses are [PENDING-ACCEPT, PENDING-ACTIVATION, PENDING-CONFIRMATION, ACTIVE, PARENT-ACTIVE, PENDING-DEACTIVATION, DEACTIVATED, EXPIRED, COMPLETED, REJECTED, PENDING-CANCEL, CANCELLED, CANCELLED-BY-PARTNER]

    • setSubmittedDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setSubmittedDateTime(@NotNull @NotNull Instant submittedDateTime)
      Parameters:
      submittedDateTime - e.g. 2023-04-19T11:09:45.00Z
      Returns:
      The time and date a trade or order was submitted

    • setSubmittedDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setSubmittedDateTime(@NotNull @NotNull String submittedDateTime)
      Parameters:
      submittedDateTime - e.g. 2023-04-19T11:09:45.00Z
      Returns:
      The time and date a trade or order was submitted

    • setLastActionBy

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLastActionBy(@NotNull @NotNull String lastActionBy)
      Returns:
      The last person or system to perform an action on an order.

    • setLastActionDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLastActionDateTime(@NotNull @NotNull Instant lastActionDateTime)
      Returns:
      The time and date of the last action on an order.

    • setLastActionDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLastActionDateTime(@NotNull @NotNull String lastActionDateTime)
      Returns:
      The time and date of the last action on an order.

    • setAmount

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setAmount(@NotNull @NotNull BigDecimal amount, boolean isEditable)
      Returns:
      The amount of a trade or order in the DealtCurrency.

    • setAmount

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setAmount(@NotNull @NotNull BigDecimal amount)
      Returns:
      The amount of a trade or order in the DealtCurrency.

    • setAmount

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setAmount(@NotNull @NotNull String amount, boolean isEditable)
      Returns:
      The amount of a trade or order in the DealtCurrency.

    • setAmount

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setAmount(@NotNull @NotNull String amount)
      Returns:
      The amount of a trade or order in the DealtCurrency.

    • setAmountEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setAmountEditable()

    • setFilled

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setFilled(@NotNull @NotNull BigDecimal filled)
      Returns:
      The amount of an order that has been filled.

    • setFilled

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setFilled(@NotNull @NotNull String filled)
      Returns:
      The amount of an order that has been filled.

    • setRemaining

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setRemaining(@NotNull @NotNull BigDecimal remaining)
      Returns:
      The amount of an order that has not been filled.

    • setRemaining

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setRemaining(@NotNull @NotNull String remaining)
      Returns:
      The amount of an order that has not been filled.

    • setMonitorSide

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setMonitorSide(@NotNull @NotNull String monitorSide, boolean isEditable)
      Returns:
      The side that should be monitored for an order to be triggered.

    • setMonitorSide

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setMonitorSide(@NotNull @NotNull String monitorSide)
      Returns:
      The side that should be monitored for an order to be triggered.

    • setMonitorSideEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setMonitorSideEditable()

    • setDealtCurrency

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setDealtCurrency(@NotNull @NotNull String dealtCurrency, boolean isEditable)
      Parameters:
      dealtCurrency - e.g. GBP
      Returns:
      The currency of the Amount of a trade or order.

    • setDealtCurrency

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setDealtCurrency(@NotNull @NotNull String dealtCurrency)
      Parameters:
      dealtCurrency - e.g. GBP
      Returns:
      The currency of the Amount of a trade or order.

    • setDealtCurrencyEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setDealtCurrencyEditable()

    • setBuySell

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBuySell(@NotNull @NotNull String buySell, boolean isEditable)
      Returns:
      The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.

    • setBuySell

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBuySell(@NotNull @NotNull String buySell)
      Returns:
      The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.

    • setBuySellEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBuySellEditable()

    • setExecutionType

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setExecutionType(@NotNull @NotNull String executionType, boolean isEditable)
      Returns:
      The order type. Caplin supported types are [BENCHMARK, CALL-ORDER, MARKET, PEGGED, STOP-LOSS, TAKE-PROFIT]

    • setExecutionType

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setExecutionType(@NotNull @NotNull String executionType)
      Returns:
      The order type. Caplin supported types are [BENCHMARK, CALL-ORDER, MARKET, PEGGED, STOP-LOSS, TAKE-PROFIT]

    • setExecutionTypeEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setExecutionTypeEditable()

    • setBenchmarkType

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkType(@NotNull @NotNull String benchmarkType, boolean isEditable)
      Returns:
      The benchmark order name. For example, ECB.

    • setBenchmarkType

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkType(@NotNull @NotNull String benchmarkType)
      Returns:
      The benchmark order name. For example, ECB.

    • setBenchmarkTypeEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTypeEditable()

    • setBenchmarkTime

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTime(@NotNull @NotNull LocalTime benchmarkTime, boolean isEditable)
      Parameters:
      benchmarkTime - e.g. 18:00
      Returns:
      The fixing time of the benchmark in ISO-8601 format

    • setBenchmarkTime

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTime(@NotNull @NotNull LocalTime benchmarkTime)
      Parameters:
      benchmarkTime - e.g. 18:00
      Returns:
      The fixing time of the benchmark in ISO-8601 format

    • setBenchmarkTime

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTime(@NotNull @NotNull String benchmarkTime, boolean isEditable)
      Parameters:
      benchmarkTime - e.g. 18:00
      Returns:
      The fixing time of the benchmark in ISO-8601 format

    • setBenchmarkTime

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTime(@NotNull @NotNull String benchmarkTime)
      Parameters:
      benchmarkTime - e.g. 18:00
      Returns:
      The fixing time of the benchmark in ISO-8601 format

    • setBenchmarkTimeEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTimeEditable()

    • setBenchmarkDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkDate(@NotNull @NotNull LocalDate benchmarkDate, boolean isEditable)
      Parameters:
      benchmarkDate - e.g. YYYY-MM-DD
      Returns:
      The fixing date of the benchmark in ISO-8601 format

    • setBenchmarkDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkDate(@NotNull @NotNull LocalDate benchmarkDate)
      Parameters:
      benchmarkDate - e.g. YYYY-MM-DD
      Returns:
      The fixing date of the benchmark in ISO-8601 format

    • setBenchmarkDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkDate(@NotNull @NotNull String benchmarkDate, boolean isEditable)
      Parameters:
      benchmarkDate - e.g. YYYY-MM-DD
      Returns:
      The fixing date of the benchmark in ISO-8601 format

    • setBenchmarkDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkDate(@NotNull @NotNull String benchmarkDate)
      Parameters:
      benchmarkDate - e.g. YYYY-MM-DD
      Returns:
      The fixing date of the benchmark in ISO-8601 format

    • setBenchmarkDateEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkDateEditable()

    • setBenchmarkTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTimeZone(@NotNull @NotNull ZoneId benchmarkTimeZone, boolean isEditable)
      Parameters:
      benchmarkTimeZone - e.g. Europe/London
      Returns:
      The TZ format timezone for the provided time and date

    • setBenchmarkTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTimeZone(@NotNull @NotNull ZoneId benchmarkTimeZone)
      Parameters:
      benchmarkTimeZone - e.g. Europe/London
      Returns:
      The TZ format timezone for the provided time and date

    • setBenchmarkTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTimeZone(@NotNull @NotNull String benchmarkTimeZone, boolean isEditable)
      Parameters:
      benchmarkTimeZone - e.g. Europe/London
      Returns:
      The TZ format timezone for the provided time and date

    • setBenchmarkTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTimeZone(@NotNull @NotNull String benchmarkTimeZone)
      Parameters:
      benchmarkTimeZone - e.g. Europe/London
      Returns:
      The TZ format timezone for the provided time and date

    • setBenchmarkTimeZoneEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkTimeZoneEditable()

    • setLimitPrice

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLimitPrice(@NotNull @NotNull BigDecimal limitPrice, boolean isEditable)
      Returns:
      The price at which a leg should fill.

    • setLimitPrice

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLimitPrice(@NotNull @NotNull BigDecimal limitPrice)
      Returns:
      The price at which a leg should fill.

    • setLimitPrice

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLimitPrice(@NotNull @NotNull String limitPrice, boolean isEditable)
      Returns:
      The price at which a leg should fill.

    • setLimitPrice

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLimitPrice(@NotNull @NotNull String limitPrice)
      Returns:
      The price at which a leg should fill.

    • setLimitPriceEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLimitPriceEditable()

    • setRemarks

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setRemarks(@NotNull @NotNull String remarks, boolean isEditable)
      Returns:
      The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales

    • setRemarks

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setRemarks(@NotNull @NotNull String remarks)
      Returns:
      The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales

    • setRemarksEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setRemarksEditable()

    • setChildLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegId(int childLegId, boolean isEditable)
      Parameters:
      childLegId - e.g. 1
      Returns:
      The id of the child leg, if the order has a child leg

    • setChildLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegId(int childLegId)
      Parameters:
      childLegId - e.g. 1
      Returns:
      The id of the child leg, if the order has a child leg

    • setChildLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegId(@NotNull @NotNull String childLegId, boolean isEditable)
      Parameters:
      childLegId - e.g. 1
      Returns:
      The id of the child leg, if the order has a child leg

    • setChildLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegId(@NotNull @NotNull String childLegId)
      Parameters:
      childLegId - e.g. 1
      Returns:
      The id of the child leg, if the order has a child leg

    • setChildLegIdEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegIdEditable()

    • setChildRelationship

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildRelationship(@NotNull @NotNull String childRelationship, boolean isEditable)
      Parameters:
      childRelationship - e.g. IF-DONE
      Returns:
      Describes the relationship with the child if it exists.

    • setChildRelationship

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildRelationship(@NotNull @NotNull String childRelationship)
      Parameters:
      childRelationship - e.g. IF-DONE
      Returns:
      Describes the relationship with the child if it exists.

    • setChildRelationshipEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildRelationshipEditable()

    • setPartnerLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId(int partnerLegId, boolean isEditable)
      Parameters:
      partnerLegId - e.g. 1
      Returns:
      The id of the partner leg, if the order has a partner leg

    • setPartnerLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId(int partnerLegId)
      Parameters:
      partnerLegId - e.g. 1
      Returns:
      The id of the partner leg, if the order has a partner leg

    • setPartnerLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId(@NotNull @NotNull String partnerLegId, boolean isEditable)
      Parameters:
      partnerLegId - e.g. 1
      Returns:
      The id of the partner leg, if the order has a partner leg

    • setPartnerLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId(@NotNull @NotNull String partnerLegId)
      Parameters:
      partnerLegId - e.g. 1
      Returns:
      The id of the partner leg, if the order has a partner leg

    • setPartnerLegIdEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegIdEditable()

    • setPartnerRelationship

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerRelationship(@NotNull @NotNull String partnerRelationship, boolean isEditable)
      Parameters:
      partnerRelationship - e.g. OCO
      Returns:
      Describes the relationship with the partner leg if it exists.

    • setPartnerRelationship

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerRelationship(@NotNull @NotNull String partnerRelationship)
      Parameters:
      partnerRelationship - e.g. OCO
      Returns:
      Describes the relationship with the partner leg if it exists.

    • setPartnerRelationshipEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerRelationshipEditable()

    • setLoopLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegId(int loopLegId, boolean isEditable)
      Parameters:
      loopLegId - e.g. 1
      Returns:
      The leg to loop back to upon completion.

    • setLoopLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegId(int loopLegId)
      Parameters:
      loopLegId - e.g. 1
      Returns:
      The leg to loop back to upon completion.

    • setLoopLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegId(@NotNull @NotNull String loopLegId, boolean isEditable)
      Parameters:
      loopLegId - e.g. 1
      Returns:
      The leg to loop back to upon completion.

    • setLoopLegId

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegId(@NotNull @NotNull String loopLegId)
      Parameters:
      loopLegId - e.g. 1
      Returns:
      The leg to loop back to upon completion.

    • setLoopLegIdEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegIdEditable()

    • setFillRate

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setFillRate(@NotNull @NotNull String fillRate, boolean isEditable)
      Deprecated.
      Returns:
      fillRate

    • setFillRate

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setFillRate(@NotNull @NotNull String fillRate)
      Deprecated.
      Returns:
      fillRate

    • setFillRateEditable

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setFillRateEditable()
      Deprecated.

    • setOrderTenor

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderTenor(@NotNull @NotNull String orderTenor, boolean isEditable)
      Returns:
      The tenor the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.

    • setOrderTenor

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderTenor(@NotNull @NotNull String orderTenor)
      Returns:
      The tenor the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.

    • setOrderTenorEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderTenorEditable()

    • setOrderSettlementDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderSettlementDate(@NotNull @NotNull LocalDate orderSettlementDate, boolean isEditable)
      Returns:
      The settlement date the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.

    • setOrderSettlementDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderSettlementDate(@NotNull @NotNull LocalDate orderSettlementDate)
      Returns:
      The settlement date the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.

    • setOrderSettlementDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderSettlementDate(@NotNull @NotNull String orderSettlementDate, boolean isEditable)
      Returns:
      The settlement date the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.

    • setOrderSettlementDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderSettlementDate(@NotNull @NotNull String orderSettlementDate)
      Returns:
      The settlement date the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.

    • setOrderSettlementDateEditable

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderSettlementDateEditable()

    • setOrderFixingDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderFixingDate(@NotNull @NotNull LocalDate orderFixingDate)
      Returns:
      The date an NDF order will fix on if filled.

    • setOrderFixingDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderFixingDate(@NotNull @NotNull String orderFixingDate)
      Returns:
      The date an NDF order will fix on if filled.

    • setTemperature

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setTemperature(@NotNull @NotNull String temperature)
      Parameters:
      temperature - e.g. 2
      Returns:
      Shows how close an Order is to its trigger point at the leg level. Shows the maximum of the leg temperatures at the common level [1=cold,2=warm,3=hot,4=very hot,5=target rate reached].

    • setFilledRate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setFilledRate(@NotNull @NotNull BigDecimal filledRate)
      Parameters:
      filledRate - e.g. 123.012345
      Returns:
      The rate at which an order has been filled.

    • setFilledRate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setFilledRate(@NotNull @NotNull String filledRate)
      Parameters:
      filledRate - e.g. 123.012345
      Returns:
      The rate at which an order has been filled.

    • setOrderType

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderType(@NotNull @NotNull String orderType)
      Parameters:
      orderType - e.g. TAKE-PROFIT, STOP-LOSS
      Returns:
      The order execution type. Caplin supported types are TAKE-PROFIT, STOP-LOSS, CALL-ORDER, MARKET, BENCHMARK, MARKET, PEGGED.

    • setFillID

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setFillID(@NotNull @NotNull String fillID)
      Parameters:
      fillID - e.g. 00001561
      Returns:
      The Trade ID of the trade created when an order is fully filled by a single fill.

    • setTrigger

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setTrigger(@NotNull @NotNull String trigger)
      Returns:
      The trigger type for the order

    • setSettlementDate

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setSettlementDate(@NotNull @NotNull String settlementDate)
      Parameters:
      settlementDate - e.g. 20160314
      Returns:
      The date on which the two currencies in the FX trade are exchanged. Can be a tenor or a broken date, i.e. SPOT or 20160314.

    • setAllowPartialFill

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setAllowPartialFill(boolean allowPartialFill)
      Returns:
      Indicates whether the order leg can be partially filled

    • setAllowPartialFill

      @NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setAllowPartialFill(@NotNull @NotNull String allowPartialFill)
      Returns:
      Indicates whether the order leg can be partially filled