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

Class OrderDetailsPartsDef.LegFields

    • Method Detail

      • getEditable

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

      • getOrderID

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

      • getStatus

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

      • getOrderStatus

        @Nullable
public @Nullable 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 Instant getSubmittedDateTime()
        Returns:
        The time and date a trade was submitted

      • getLastActionBy

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

      • getLastActionDateTime

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

      • getAmount

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

      • getFilled

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

      • getRemaining

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

      • getMonitorSide

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

      • getDealtCurrency

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

      • getBuySell

        @Nullable
public @Nullable 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 String getExecutionType()
        Returns:
        The order type. Caplin supported types are [BENCHMARK, CALL_ORDER, MARKET, PEGGED, STOP_LOSS, TAKE_PROFIT]

      • getBenchmarkType

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

      • getLimitPrice

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

      • getRemarks

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

      • getChildLegId

        @Nullable
public @Nullable Integer getChildLegId()
        Returns:
        childLegId

      • getChildRelationship

        @Nullable
public @Nullable String getChildRelationship()
        Returns:
        childRelationship

      • getPartnerLegId

        @Nullable
public @Nullable Integer getPartnerLegId()
        Returns:
        partnerLegId

      • getPartnerRelationship

        @Nullable
public @Nullable String getPartnerRelationship()
        Returns:
        partnerRelationship

      • getLoopLegId

        @Nullable
public @Nullable Integer getLoopLegId()
        Returns:
        loopLegId

      • getFillRate

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

      • getOrderTenor

        @Nullable
public @Nullable 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 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 LocalDate getOrderFixingDate()
        Returns:
        The date an NDF order will fix on if filled.