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

Class OrderDetailsPartsDef.LegFields.Builder

    • Method Detail

      • toString

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

      • setOrderStatus

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderStatus​(@NotNull
                                                                      @NotNull java.lang.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 java.time.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 java.lang.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 java.lang.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 java.time.Instant lastActionDateTime)
        Returns:
        The time and date of the last action on an order.

      • setLastActionDateTime

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

      • setAmount

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setAmount​(@NotNull
                                                                 @NotNull java.math.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 java.math.BigDecimal amount)
        Returns:
        The amount of a trade or order in the DealtCurrency.

      • setAmount

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setAmount​(@NotNull
                                                                 @NotNull java.lang.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 java.lang.String amount)
        Returns:
        The amount of a trade or order in the DealtCurrency.

      • setFilled

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

      • setRemaining

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

      • setRemaining

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

      • setMonitorSide

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setMonitorSide​(@NotNull
                                                                      @NotNull java.lang.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 java.lang.String monitorSide)
        Returns:
        The side that should be monitored for an order to be triggered.

      • setDealtCurrency

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setDealtCurrency​(@NotNull
                                                                        @NotNull java.lang.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 java.lang.String dealtCurrency)
        Parameters:
        dealtCurrency - e.g. GBP
        Returns:
        The currency of the Amount of a trade or order.

      • setBuySell

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setBuySell​(@NotNull
                                                                  @NotNull java.lang.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 java.lang.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.

      • setExecutionType

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setExecutionType​(@NotNull
                                                                        @NotNull java.lang.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 java.lang.String executionType)
        Returns:
        The order type. Caplin supported types are [BENCHMARK, CALL-ORDER, MARKET, PEGGED, STOP-LOSS, TAKE-PROFIT]

      • setBenchmarkType

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

      • setBenchmarkType

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

      • setLimitPrice

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

      • setLimitPrice

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

      • setLimitPrice

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

      • setLimitPrice

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

      • setRemarks

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setRemarks​(@NotNull
                                                                  @NotNull java.lang.String remarks,
                                                                  boolean isEditable)
        Returns:
        The text content of a comment left on a leg of a trade or order.

      • setRemarks

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setRemarks​(@NotNull
                                                                  @NotNull java.lang.String remarks)
        Returns:
        The text content of a comment left on a leg of a trade or order.

      • setChildRelationship

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildRelationship​(@NotNull
                                                                            @NotNull java.lang.String childRelationship,
                                                                            boolean isEditable)
        Returns:
        childRelationship

      • setChildRelationship

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setChildRelationship​(@NotNull
                                                                            @NotNull java.lang.String childRelationship)
        Returns:
        childRelationship

      • setPartnerLegId

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerLegId​(@NotNull
                                                                       @NotNull java.lang.String partnerLegId,
                                                                       boolean isEditable)
        Returns:
        partnerLegId

      • setPartnerRelationship

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerRelationship​(@NotNull
                                                                              @NotNull java.lang.String partnerRelationship,
                                                                              boolean isEditable)
        Returns:
        partnerRelationship

      • setPartnerRelationship

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setPartnerRelationship​(@NotNull
                                                                              @NotNull java.lang.String partnerRelationship)
        Returns:
        partnerRelationship

      • setFillRate

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

      • setOrderTenor

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderTenor​(@NotNull
                                                                     @NotNull java.lang.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 java.lang.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.

      • setOrderSettlementDate

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setOrderSettlementDate​(@NotNull
                                                                              @NotNull java.time.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 java.time.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 java.lang.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 java.lang.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.

      • setOrderFixingDate

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

      • setOrderFixingDate

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

      • setTemperature

        @NotNull
public @NotNull OrderDetailsPartsDef.LegFields.Builder setTemperature​(@NotNull
                                                                      @NotNull java.lang.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 java.math.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 java.lang.String filledRate)
        Parameters:
        filledRate - e.g. 123.012345
        Returns:
        The rate at which an order has been filled.