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

Class OrderDetailsPartsDef.LegFields

    • Method Detail

      • getEditable

        @Nullable
public @Nullable java.lang.Boolean getEditable()
        Returns:
        Whether a trade or order is editable.

      • getOrderID

        @Nullable
public @Nullable java.lang.String getOrderID()
        Returns:
        The id of the order.

      • getStatus

        @Nullable
public @Nullable java.lang.String getStatus()
        Returns:
        Use OrderStatus instead.

      • getOrderStatus

        @Nullable
public @Nullable java.lang.String getOrderStatus()
        Returns:
        Caplin supported statuses are [PENDING-ACCEPT, PENDING-ACTIVATION, ACTIVE, PARENT-ACTIVE, PENDING-DEACTIVATION, DEACTIVATED, EXPIRED, COMPLETED, REJECTED, PENDING-CANCEL, CANCELLED, CANCELLED-BY-PARTNER]

      • getSubmittedDateTime

        @Nullable
public @Nullable java.time.Instant getSubmittedDateTime()
        Returns:
        The time and date a trade or order was submitted

      • getLastActionBy

        @Nullable
public @Nullable java.lang.String getLastActionBy()
        Returns:
        The last person or system to perform an action on an order.

      • getLastActionDateTime

        @Nullable
public @Nullable java.time.Instant getLastActionDateTime()
        Returns:
        The time and date of the last action on an order.

      • getAmount

        @Nullable
public @Nullable java.math.BigDecimal getAmount()
        Returns:
        The amount of a trade or order in the DealtCurrency.

      • getFilled

        @Nullable
public @Nullable java.math.BigDecimal getFilled()
        Returns:
        The amount of an order that has been filled.

      • getRemaining

        @Nullable
public @Nullable java.math.BigDecimal getRemaining()
        Returns:
        The amount of an order that has not been filled.

      • getMonitorSide

        @Nullable
public @Nullable java.lang.String getMonitorSide()
        Returns:
        The side that should be monitored for an order to be triggered.

      • getDealtCurrency

        @Nullable
public @Nullable java.lang.String getDealtCurrency()
        Returns:
        The currency of the Amount of a trade or order.

      • getBuySell

        @Nullable
public @Nullable java.lang.String getBuySell()
        Returns:
        The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.

      • getExecutionType

        @Nullable
public @Nullable java.lang.String getExecutionType()
        Returns:
        The order type. Caplin supported types are [BENCHMARK, CALL-ORDER, MARKET, PEGGED, STOP-LOSS, TAKE-PROFIT]

      • getBenchmarkType

        @Nullable
public @Nullable java.lang.String getBenchmarkType()
        Returns:
        The benchmark order name. For example, ECB.

      • getLimitPrice

        @Nullable
public @Nullable java.math.BigDecimal getLimitPrice()
        Returns:
        The price at which a leg should fill.

      • getRemarks

        @Nullable
public @Nullable java.lang.String getRemarks()
        Returns:
        The text content of a comment left on a leg of a trade or order.

      • getChildLegId

        @Nullable
public @Nullable java.lang.Integer getChildLegId()
        Returns:
        childLegId

      • getChildRelationship

        @Nullable
public @Nullable java.lang.String getChildRelationship()
        Returns:
        childRelationship

      • getPartnerLegId

        @Nullable
public @Nullable java.lang.Integer getPartnerLegId()
        Returns:
        partnerLegId

      • getPartnerRelationship

        @Nullable
public @Nullable java.lang.String getPartnerRelationship()
        Returns:
        partnerRelationship

      • getLoopLegId

        @Nullable
public @Nullable java.lang.Integer getLoopLegId()
        Returns:
        loopLegId

      • getFillRate

        @Deprecated
@Nullable
public @Nullable java.lang.String getFillRate()
        Deprecated.
        Returns:
        fillRate

      • getOrderTenor

        @Nullable
public @Nullable java.lang.String getOrderTenor()
        Returns:
        The tenor the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.

      • getOrderSettlementDate

        @Nullable
public @Nullable java.time.LocalDate getOrderSettlementDate()
        Returns:
        The settlement date the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.

      • getOrderFixingDate

        @Nullable
public @Nullable java.time.LocalDate getOrderFixingDate()
        Returns:
        The date an NDF order will fix on if filled.

      • getTemperature

        @Nullable
public @Nullable java.lang.String getTemperature()
        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].

      • getFilledRate

        @Nullable
public @Nullable java.math.BigDecimal getFilledRate()
        Returns:
        The rate at which an order has been filled.

      • getFields

        @NotNull
public @NotNull java.util.Map<java.lang.String,​java.lang.String> getFields()
        Specified by:
        getFields in interface Message

      • getFieldFlags

        @NotNull
public @NotNull java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> getFieldFlags()
        Specified by:
        getFieldFlags in interface BuilderMessage
        Returns:
        Get the flags for all fields.

      • getFlagFields

        @NotNull
public @NotNull java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> getFlagFields()
        Specified by:
        getFlagFields in interface BuilderMessage
        Returns:
        Get the fields for all flags.

      • toString

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

      • from

        @NotNull
public static @NotNull OrderDetailsPartsDef.LegFields from​(@NotNull
                                                           @NotNull java.util.Map<java.lang.String,​java.lang.String> fields)

      • from

        @NotNull
public static @NotNull OrderDetailsPartsDef.LegFields from​(@NotNull
                                                           @NotNull java.util.Map<java.lang.String,​java.lang.String> fields,
                                                           @NotNull
                                                           @NotNull java.lang.String fieldPrefix)