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 Summary

Modifier and Type	Method	Description
@NotNull OrderDetailsPartsDef.LegFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull OrderDetailsPartsDef.LegFields	build()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setAllowPartialFill(boolean allowPartialFill)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setAllowPartialFill(@NotNull String allowPartialFill)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setAmount(@NotNull String amount)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setAmount(@NotNull String amount, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setAmount(@NotNull BigDecimal amount)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setAmount(@NotNull BigDecimal amount, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setAmountEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkDate(@NotNull String benchmarkDate)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkDate(@NotNull String benchmarkDate, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkDate(@NotNull LocalDate benchmarkDate)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkDate(@NotNull LocalDate benchmarkDate, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkDateEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTime(@NotNull String benchmarkTime)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTime(@NotNull String benchmarkTime, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTime(@NotNull LocalTime benchmarkTime)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTime(@NotNull LocalTime benchmarkTime, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTimeEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTimeZone(@NotNull String benchmarkTimeZone)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTimeZone(@NotNull String benchmarkTimeZone, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTimeZone(@NotNull ZoneId benchmarkTimeZone)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTimeZone(@NotNull ZoneId benchmarkTimeZone, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTimeZoneEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkType(@NotNull String benchmarkType)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkType(@NotNull String benchmarkType, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTypeEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBuySell(@NotNull String buySell)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBuySell(@NotNull String buySell, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBuySellEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildLegId(int childLegId)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildLegId(int childLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildLegId(@NotNull String childLegId)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildLegId(@NotNull String childLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildLegIdEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildRelationship(@NotNull String childRelationship)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildRelationship(@NotNull String childRelationship, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildRelationshipEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setDealtCurrency(@NotNull String dealtCurrency)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setDealtCurrency(@NotNull String dealtCurrency, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setDealtCurrencyEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setEditable(boolean editable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setEditable(@NotNull String editable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setExecutionType(@NotNull String executionType)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setExecutionType(@NotNull String executionType, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setExecutionTypeEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setFilled(@NotNull String filled)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setFilled(@NotNull BigDecimal filled)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setFilledRate(@NotNull String filledRate)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setFilledRate(@NotNull BigDecimal filledRate)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setFillID(@NotNull String fillID)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setFillRate(@NotNull String fillRate)	Deprecated.
@NotNull OrderDetailsPartsDef.LegFields.Builder	setFillRate(@NotNull String fillRate, boolean isEditable)	Deprecated.
@NotNull OrderDetailsPartsDef.LegFields.Builder	setFillRateEditable()	Deprecated.
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLastActionBy(@NotNull String lastActionBy)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLastActionDateTime(@NotNull String lastActionDateTime)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLastActionDateTime(@NotNull Instant lastActionDateTime)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLimitPrice(@NotNull String limitPrice)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLimitPrice(@NotNull String limitPrice, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLimitPrice(@NotNull BigDecimal limitPrice)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLimitPrice(@NotNull BigDecimal limitPrice, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLimitPriceEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLoopLegId(int loopLegId)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLoopLegId(int loopLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLoopLegId(@NotNull String loopLegId)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLoopLegId(@NotNull String loopLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLoopLegIdEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setMonitorSide(@NotNull String monitorSide)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setMonitorSide(@NotNull String monitorSide, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setMonitorSideEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderFixingDate(@NotNull String orderFixingDate)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderFixingDate(@NotNull LocalDate orderFixingDate)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderID(@NotNull String orderID)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderSettlementDate(@NotNull String orderSettlementDate)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderSettlementDate(@NotNull String orderSettlementDate, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderSettlementDate(@NotNull LocalDate orderSettlementDate)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderSettlementDate(@NotNull LocalDate orderSettlementDate, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderSettlementDateEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderStatus(@NotNull String orderStatus)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderTenor(@NotNull String orderTenor)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderTenor(@NotNull String orderTenor, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderTenorEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderType(@NotNull String orderType)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerLegId(int partnerLegId)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerLegId(int partnerLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerLegId(@NotNull String partnerLegId)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerLegId(@NotNull String partnerLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerLegIdEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerRelationship(@NotNull String partnerRelationship)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerRelationship(@NotNull String partnerRelationship, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerRelationshipEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setRemaining(@NotNull String remaining)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setRemaining(@NotNull BigDecimal remaining)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setRemarks(@NotNull String remarks)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setRemarks(@NotNull String remarks, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setRemarksEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setSettlementDate(@NotNull String settlementDate)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setStatus(@NotNull String status)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setSubmittedDateTime(@NotNull String submittedDateTime)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setSubmittedDateTime(@NotNull Instant submittedDateTime)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setTemperature(@NotNull String temperature)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setTrigger(@NotNull String trigger)
@NotNull String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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.

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)

Returns:

The fixing date of the benchmark in ISO-8601 format

setBenchmarkDate

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkDate(@NotNull
 @NotNull LocalDate benchmarkDate)

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)

Returns:

The fixing date of the benchmark in ISO-8601 format

setBenchmarkDate

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setBenchmarkDate(@NotNull
 @NotNull String benchmarkDate)

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