Class OrderDetailsPartsDef.LegFields.Builder
java.lang.Object
com.caplin.generated.motif.fx.orders.OrderDetailsPartsDef.LegFields.Builder
- Enclosing class:
- OrderDetailsPartsDef.LegFields
-
Method Summary
Modifier and TypeMethodDescription@NotNull OrderDetailsPartsDef.LegFieldsbuild()setAmount(@NotNull BigDecimal amount) setAmount(@NotNull BigDecimal amount, boolean isEditable) setBenchmarkType(@NotNull String benchmarkType) setBenchmarkType(@NotNull String benchmarkType, boolean isEditable) setBuySell(@NotNull String buySell) setBuySell(@NotNull String buySell, boolean isEditable) setChildLegId(int childLegId) setChildLegId(int childLegId, boolean isEditable) setChildLegId(@NotNull String childLegId) setChildLegId(@NotNull String childLegId, boolean isEditable) setChildRelationship(@NotNull String childRelationship) setChildRelationship(@NotNull String childRelationship, boolean isEditable) setDealtCurrency(@NotNull String dealtCurrency) setDealtCurrency(@NotNull String dealtCurrency, boolean isEditable) setEditable(boolean editable) setEditable(@NotNull String editable) setExecutionType(@NotNull String executionType) setExecutionType(@NotNull String executionType, boolean isEditable) setFilled(@NotNull BigDecimal filled) setFilledRate(@NotNull String filledRate) setFilledRate(@NotNull BigDecimal filledRate) setFillRate(@NotNull String fillRate) Deprecated.setFillRate(@NotNull String fillRate, boolean isEditable) Deprecated.Deprecated.setLastActionBy(@NotNull String lastActionBy) setLastActionDateTime(@NotNull String lastActionDateTime) setLastActionDateTime(@NotNull Instant lastActionDateTime) setLimitPrice(@NotNull String limitPrice) setLimitPrice(@NotNull String limitPrice, boolean isEditable) setLimitPrice(@NotNull BigDecimal limitPrice) setLimitPrice(@NotNull BigDecimal limitPrice, boolean isEditable) setLoopLegId(int loopLegId) setLoopLegId(int loopLegId, boolean isEditable) setLoopLegId(@NotNull String loopLegId) setLoopLegId(@NotNull String loopLegId, boolean isEditable) setMonitorSide(@NotNull String monitorSide) setMonitorSide(@NotNull String monitorSide, boolean isEditable) setOrderFixingDate(@NotNull String orderFixingDate) setOrderFixingDate(@NotNull LocalDate orderFixingDate) setOrderID(@NotNull String orderID) setOrderSettlementDate(@NotNull String orderSettlementDate) setOrderSettlementDate(@NotNull String orderSettlementDate, boolean isEditable) setOrderSettlementDate(@NotNull LocalDate orderSettlementDate) setOrderSettlementDate(@NotNull LocalDate orderSettlementDate, boolean isEditable) setOrderStatus(@NotNull String orderStatus) setOrderTenor(@NotNull String orderTenor) setOrderTenor(@NotNull String orderTenor, boolean isEditable) setOrderType(@NotNull String orderType) setPartnerLegId(int partnerLegId) setPartnerLegId(int partnerLegId, boolean isEditable) setPartnerLegId(@NotNull String partnerLegId) setPartnerLegId(@NotNull String partnerLegId, boolean isEditable) setPartnerRelationship(@NotNull String partnerRelationship) setPartnerRelationship(@NotNull String partnerRelationship, boolean isEditable) setRemaining(@NotNull String remaining) setRemaining(@NotNull BigDecimal remaining) setRemarks(@NotNull String remarks) setRemarks(@NotNull String remarks, boolean isEditable) setSubmittedDateTime(@NotNull String submittedDateTime) setSubmittedDateTime(@NotNull Instant submittedDateTime) setTemperature(@NotNull String temperature) @NotNull StringtoString()
-
Method Details
-
addField
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value) -
build
-
toString
-
setEditable
- 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) - Returns:
- The id of the order.
-
setStatus
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setStatus(@NotNull @NotNull String status) - 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.
-
setOrderStatus
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderStatus(@NotNull @NotNull String orderStatus) - Returns:
- Caplin supported statuses are [PENDING-ACCEPT, PENDING-ACTIVATION, 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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
setChildLegId
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegId(int childLegId, boolean isEditable) - Returns:
- childLegId
-
setChildLegId
- Returns:
- childLegId
-
setChildLegId
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegId(@NotNull @NotNull String childLegId, boolean isEditable) - Returns:
- childLegId
-
setChildLegId
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegId(@NotNull @NotNull String childLegId) - Returns:
- childLegId
-
setChildLegIdEditable
-
setChildRelationship
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildRelationship(@NotNull @NotNull String childRelationship, boolean isEditable) - Returns:
- childRelationship
-
setChildRelationship
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildRelationship(@NotNull @NotNull String childRelationship) - Returns:
- childRelationship
-
setChildRelationshipEditable
-
setPartnerLegId
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId(int partnerLegId, boolean isEditable) - Returns:
- partnerLegId
-
setPartnerLegId
- Returns:
- partnerLegId
-
setPartnerLegId
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId(@NotNull @NotNull String partnerLegId, boolean isEditable) - Returns:
- partnerLegId
-
setPartnerLegId
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId(@NotNull @NotNull String partnerLegId) - Returns:
- partnerLegId
-
setPartnerLegIdEditable
-
setPartnerRelationship
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerRelationship(@NotNull @NotNull String partnerRelationship, boolean isEditable) - Returns:
- partnerRelationship
-
setPartnerRelationship
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerRelationship(@NotNull @NotNull String partnerRelationship) - Returns:
- partnerRelationship
-
setPartnerRelationshipEditable
-
setLoopLegId
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegId(int loopLegId, boolean isEditable) - Returns:
- loopLegId
-
setLoopLegId
- Returns:
- loopLegId
-
setLoopLegId
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegId(@NotNull @NotNull String loopLegId, boolean isEditable) - Returns:
- loopLegId
-
setLoopLegId
@NotNull public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegId(@NotNull @NotNull String loopLegId) - Returns:
- loopLegId
-
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. -
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
-
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
-
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.
-