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

Class OrderDetailsPartsDef.LegFields

java.lang.Object
com.caplin.generated.motif.fx.orders.OrderDetailsPartsDef.LegFields
All Implemented Interfaces:
BuilderMessage, Message
Enclosing class:
OrderDetailsPartsDef
public static final class OrderDetailsPartsDef.LegFields extends Object implements BuilderMessage

  • Method Details

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

    • getOrderStatus

      @Nullable public @Nullable String getOrderStatus()
      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]

    • getSubmittedDateTime

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

    • getBenchmarkTime

      @Nullable public @Nullable LocalTime getBenchmarkTime()
      Returns:
      The fixing time of the benchmark in ISO-8601 format

    • getBenchmarkDate

      @Nullable public @Nullable LocalDate getBenchmarkDate()
      Returns:
      The fixing date of the benchmark in ISO-8601 format

    • getBenchmarkTimeZone

      @Nullable public @Nullable ZoneId getBenchmarkTimeZone()
      Returns:
      The TZ format timezone for the provided time and date

    • 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, visible to Client and sales and possibly the trader, set/edited by Client or sales

    • getChildLegId

      @Nullable public @Nullable Integer getChildLegId()
      Returns:
      The id of the child leg, if the order has a child leg

    • getChildRelationship

      @Nullable public @Nullable String getChildRelationship()
      Returns:
      Describes the relationship with the child if it exists.

    • getPartnerLegId

      @Nullable public @Nullable Integer getPartnerLegId()
      Returns:
      The id of the partner leg, if the order has a partner leg

    • getPartnerRelationship

      @Nullable public @Nullable String getPartnerRelationship()
      Returns:
      Describes the relationship with the partner leg if it exists.

    • getLoopLegId

      @Nullable public @Nullable Integer getLoopLegId()
      Returns:
      The leg to loop back to upon completion.

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

    • getTemperature

      @Nullable public @Nullable 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 BigDecimal getFilledRate()
      Returns:
      The rate at which an order has been filled.

    • getOrderType

      @Nullable public @Nullable String getOrderType()
      Returns:
      The order execution type. Caplin supported types are TAKE-PROFIT, STOP-LOSS, CALL-ORDER, MARKET, BENCHMARK, MARKET, PEGGED.

    • getFillID

      @Nullable public @Nullable String getFillID()
      Returns:
      The Trade ID of the trade created when an order is fully filled by a single fill.

    • getTrigger

      @Nullable public @Nullable String getTrigger()
      Returns:
      The trigger type for the order

    • getSettlementDate

      @Nullable public @Nullable String getSettlementDate()
      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.

    • getAllowPartialFill

      @Nullable public @Nullable Boolean getAllowPartialFill()
      Returns:
      Indicates whether the order leg can be partially filled

    • getFields

      @NotNull public @NotNull Map<String,String> getFields()
      Specified by:
      getFields in interface Message

    • getFieldFlags

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

    • getFlagFields

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

    • toString

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

    • from

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

    • from

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

    • newBuilder

      @NotNull public static @NotNull OrderDetailsPartsDef.LegFields.Builder newBuilder()