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

Class OrderDetailsPartsDef.CommonFields

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

  • Method Details

    • getCurrencyPair

      @Nullable public @Nullable String getCurrencyPair()
      Returns:
      The currency pair for the trade. For example, EURUSD

    • getAccount

      @Nullable public @Nullable String getAccount()
      Returns:
      The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>

    • getAllowedActions

      @Nullable public @Nullable String getAllowedActions()
      Returns:
      Comma separated list of Caplin supported values. See the constants defined within com.caplin.motif.fx.orders.AllowedActions

    • getActivationType

      @Nullable public @Nullable String getActivationType()
      Returns:
      How the order should be activated. Caplin supported statuses are [GFA, EXPLICIT]

    • getActivationDateTime

      @Nullable public @Nullable Instant getActivationDateTime()
      Returns:
      The time and date the order will become active. This is in ISO-8601 format.

    • getActivationDisplayTimeZone

      @Nullable public @Nullable ZoneId getActivationDisplayTimeZone()
      Returns:
      The timezone that the activation time and date should be formatted to for display. This is in the TZ database format.

    • getExpirationType

      @Nullable public @Nullable String getExpirationType()
      Returns:
      How the order should be deactivated. Caplin supported statuses are [IOC, GTC, GFD, FOK, EXPLICIT]

    • getExpirationDateTime

      @Nullable public @Nullable Instant getExpirationDateTime()
      Returns:
      The time and date the order will be deactivated. This is in ISO-8601 format.

    • getExpirationDisplayTimeZone

      @Nullable public @Nullable ZoneId getExpirationDisplayTimeZone()
      Returns:
      The timezone that the expiration time and date should be formatted to for display. This is in the TZ database format.

    • getAlertType

      @Nullable public @Nullable String getAlertType()
      Returns:
      The type of alert that an order will send. Caplin supported statuses are [EMAIL, SMS].

    • getStrategyID

      @Nullable public @Nullable String getStrategyID()
      Returns:
      The strategy Id of the order.

    • getStrategyType

      @Nullable public @Nullable String getStrategyType()
      Returns:
      The strategy the order was submitted with. This field should not be used by the front end for structuring orders. Comma separated list of Caplin supported values are [SINGLE, IF-DONE-OCO, OCO, IF-DONE, IF-TIMEOUT, IF-DONE-LOOP, LOOP]. OTHER denotes a strategy type that is unsupported.

    • getTraderUsername

      @Nullable public @Nullable String getTraderUsername()
      Returns:
      The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.

    • getTOBOUser

      @Nullable public @Nullable String getTOBOUser()
      Returns:
      The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.

    • getFullName

      @Nullable public @Nullable String getFullName()
      Returns:
      The full name of the user the trade is on behalf of

    • getEntityId

      @Nullable public @Nullable String getEntityId()
      Returns:
      The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.

    • getEntityDescription

      @Nullable public @Nullable String getEntityDescription()
      Returns:
      The description of a trade on behalf of entity.

    • getOrderCount

      @Deprecated @Nullable public @Nullable Integer getOrderCount()
      Deprecated.
      Returns:
      orderCount

    • getOrderID

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

    • getActivationDate

      @Deprecated @Nullable public @Nullable String getActivationDate()
      Deprecated.
      Returns:
      What date the strategy should be activated.

    • getActivationTime

      @Deprecated @Nullable public @Nullable String getActivationTime()
      Deprecated.
      Returns:
      What time the strategy should be activated if the ActivationDate was in the format of yyyymmdd.

    • getActivationLocation

      @Deprecated @Nullable public @Nullable String getActivationLocation()
      Deprecated.
      Returns:
      When location should be used to evaluate the time to activate if the ActivationDate was in the format of yyyymmdd.

    • getActivationUTCOffset

      @Deprecated @Nullable public @Nullable String getActivationUTCOffset()
      Deprecated.
      Returns:
      activationUTCOffset

    • getExpirationDate

      @Deprecated @Nullable public @Nullable String getExpirationDate()
      Deprecated.
      Returns:
      What date the strategy should expire.

    • getExpirationTime

      @Deprecated @Nullable public @Nullable String getExpirationTime()
      Deprecated.
      Returns:
      What time the strategy should be activated if the ExpirationDate was in the format of yyyymmdd.

    • getExpirationLocation

      @Deprecated @Nullable public @Nullable String getExpirationLocation()
      Deprecated.
      Returns:
      When location should be used to evaluate the time to expire if the ExpirationDate was in the format of yyyymmdd.

    • getExpirationUTCOffset

      @Deprecated @Nullable public @Nullable String getExpirationUTCOffset()
      Deprecated.
      Returns:
      expirationUTCOffset

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

    • getSubmittedDateTime

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

    • getFixingSource

      @Nullable public @Nullable String getFixingSource()
      Returns:
      Specifies where the fixing rate comes from.

    • getSettlementCurrency

      @Nullable public @Nullable String getSettlementCurrency()
      Returns:
      A currency for of settlement instruction

    • getTags

      @Nullable public @Nullable String getTags()
      Returns:
      Tags for a trade (see also `com.caplin.motif.fx.config.DefaultTag`) or order (see also `com.caplin.motif.fx.orders.DefaultOrderTag`).

    • getOrderRateDPS

      @Nullable public @Nullable Integer getOrderRateDPS()
      Returns:
      The precision to use for order rate information.

    • 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.CommonFields from(@NotNull @NotNull Map<String,String> fields)

    • from

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

    • newBuilder

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