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	setAmount(@NotNull String amount, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setAmount(@NotNull BigDecimal amount, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setAmountEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkType(@NotNull String benchmarkType, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBenchmarkTypeEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBuySell(@NotNull String buySell, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setBuySellEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildLegId(int childLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildLegId(@NotNull String childLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildLegIdEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildRelationship(@NotNull String childRelationship, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setChildRelationshipEditable()
@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, 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	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, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLimitPrice(@NotNull BigDecimal limitPrice, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLimitPriceEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLoopLegId(int loopLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLoopLegId(@NotNull String loopLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setLoopLegIdEditable()
@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, boolean isEditable)
@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, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setOrderTenorEditable()
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerLegId(int partnerLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerLegId(@NotNull String partnerLegId, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setPartnerLegIdEditable()
@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, boolean isEditable)
@NotNull OrderDetailsPartsDef.LegFields.Builder	setRemarksEditable()
@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 String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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)

Returns:

The id of the order.

setStatus

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setStatus(@NotNull
                                                                 @NotNull String status)

Returns:

Use OrderStatus instead.

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)

Returns:

The time and date a trade was submitted

setSubmittedDateTime

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setSubmittedDateTime(@NotNull
                                                                            @NotNull String submittedDateTime)

Returns:

The time and date a trade 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 String amount,
                                                                 boolean isEditable)

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.

setMonitorSideEditable

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

setDealtCurrency

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setDealtCurrency(@NotNull
                                                                        @NotNull String dealtCurrency,
                                                                        boolean isEditable)

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

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.

setBenchmarkTypeEditable

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder 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 String limitPrice,
                                                                     boolean isEditable)

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.

setRemarksEditable

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

setChildLegId

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegId(int childLegId,
                                                                     boolean isEditable)

Returns:

childLegId

setChildLegId

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildLegId(@NotNull
                                                                     @NotNull String childLegId,
                                                                     boolean isEditable)

Returns:

childLegId

setChildLegIdEditable

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

setChildRelationship

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildRelationship(@NotNull
                                                                            @NotNull String childRelationship,
                                                                            boolean isEditable)

Returns:

childRelationship

setChildRelationshipEditable

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

setPartnerLegId

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId(int partnerLegId,
                                                                       boolean isEditable)

Returns:

partnerLegId

setPartnerLegId

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId(@NotNull
                                                                       @NotNull String partnerLegId,
                                                                       boolean isEditable)

Returns:

partnerLegId

setPartnerLegIdEditable

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

setPartnerRelationship

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerRelationship(@NotNull
                                                                              @NotNull String partnerRelationship,
                                                                              boolean isEditable)

Returns:

partnerRelationship

setPartnerRelationshipEditable

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

setLoopLegId

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegId(int loopLegId,
                                                                    boolean isEditable)

Returns:

loopLegId

setLoopLegId

@NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setLoopLegId(@NotNull
                                                                    @NotNull String loopLegId,
                                                                    boolean isEditable)

Returns:

loopLegId

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

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.

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

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.