Interface OrderDetailsClientFieldSet

All Superinterfaces:
LeggedMessage, Message
All Known Implementing Classes:
OrderDetailsClientFieldSetChild, SaveTradeEvent, SubmitTradeEvent

public interface OrderDetailsClientFieldSet extends LeggedMessage
  • Method Details

    • getCurrencyPair

      default String getCurrencyPair()
      The currency pair this order is for.
    • getAccount

      default String getAccount()
      The account this order is for.
    • getActivationType

      default String getActivationType()
      The activation type. e.g. EXPLICIT or GFA
    • getActivationDateTime

      default String getActivationDateTime()
      Date and time for activation in ISO_INSTANT format e.g. 2011-12-03T10:15:30Z. Blank if GFA.
    • getActivationDisplayTimeZone

      default String getActivationDisplayTimeZone()
      The display time zone for the ActivationDateTime. Blank if GFA, else must be in TZ format, e.g. America/New_York or Europe/London.
    • getExpirationType

      default String getExpirationType()
      The expiration type. e.g. EXPLICIT, GTC or GFD
    • getExpirationDateTime

      default String getExpirationDateTime()
      Date and time for expiration in ISO_INSTANT format e.g. 2011-12-03T10:15:30Z. Blank if GTC or GFD.
    • getExpirationDisplayTimeZone

      default String getExpirationDisplayTimeZone()
      The display time zone for the ExpirationDateTime. Blank if GTC or GFD, else must be in TZ format, e.g. America/New_York or Europe/London.
    • getAlertType

      default String getAlertType()
      The types of alerts that should be sent for this order (comma separated list, zero or more values), e.g. SMS, EMAIL.
    • getEntityId

      default String getEntityId()
      The entity on whose behalf the trade is submitted.
    • getTOBOUser

      default String getTOBOUser()
      The user on whose behalf the trade is submitted. e.g. john.smith
    • getStrategyType

      default String getStrategyType()
      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 [SINGLE, IF-DONE-OCO, OCO, IF-DONE, IF-TIMEOUT, IF-DONE-LOOP, LOOP]. OTHER denotes a strategy type that is unsupported.
    • getAppID

      default String getAppID()
      A unique identifier for the client application
    • getAlertPhoneNumber1

      default String getAlertPhoneNumber1()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertPhoneNumber2

      default String getAlertPhoneNumber2()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertPhoneNumber3

      default String getAlertPhoneNumber3()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertPhoneNumber4

      default String getAlertPhoneNumber4()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertPhoneNumber5

      default String getAlertPhoneNumber5()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertPhoneNumber6

      default String getAlertPhoneNumber6()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertPhoneNumber7

      default String getAlertPhoneNumber7()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertPhoneNumber8

      default String getAlertPhoneNumber8()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertPhoneNumber9

      default String getAlertPhoneNumber9()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertPhoneNumber10

      default String getAlertPhoneNumber10()
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
    • getAlertEmailAddress1

      default String getAlertEmailAddress1()
      Optional email address for order status notifications. e.g. email@example.com
    • getAlertEmailAddress2

      default String getAlertEmailAddress2()
      Optional email address for order status notifications. e.g. email@example.com
    • getAlertEmailAddress3

      default String getAlertEmailAddress3()
      Optional email address for order status notifications. e.g. email@example.com
    • getAlertEmailAddress4

      default String getAlertEmailAddress4()
      Optional email address for order status notifications. e.g. email@example.com
    • getAlertEmailAddress5

      default String getAlertEmailAddress5()
      Optional email address for order status notifications. e.g. email@example.com
    • getAlertEmailAddress6

      default String getAlertEmailAddress6()
      Optional email address for order status notifications. e.g. email@example.com
    • getAlertEmailAddress7

      default String getAlertEmailAddress7()
      Optional email address for order status notifications. e.g. email@example.com
    • getAlertEmailAddress8

      default String getAlertEmailAddress8()
      Optional email address for order status notifications. e.g. email@example.com
    • getAlertEmailAddress9

      default String getAlertEmailAddress9()
      Optional email address for order status notifications. e.g. email@example.com
    • getAlertEmailAddress10

      default String getAlertEmailAddress10()
      Optional email address for order status notifications. e.g. email@example.com
    • getFixingSource

      default String getFixingSource()
      The fixing source of the NDF trade
    • getSettlementCurrency

      default String getSettlementCurrency()
      The settlement currency of the NDF trade
    • getActivationDate

      @Deprecated default String getActivationDate()
      Deprecated.
      The activation date for the order. This has been deprecated and you should prefer the ActivationType, ActivationDateTime and ActivationDisplayTimeZone fields.
    • getActivationTime

      @Deprecated default String getActivationTime()
      Deprecated.
      The activation time for the order. This has been deprecated and you should prefer the ActivationType, ActivationDateTime and ActivationDisplayTimeZone fields.
    • getActivationLocation

      @Deprecated default String getActivationLocation()
      Deprecated.
      The activation location for the order. This has been deprecated and you should prefer the ActivationType, ActivationDateTime and ActivationDisplayTimeZone fields.
    • getActivationUTCOffset

      @Deprecated default String getActivationUTCOffset()
      Deprecated.
      The activation UTC offset for the order. This has been deprecated and you should prefer the ActivationType, ActivationDateTime and ActivationDisplayTimeZone fields.
    • getExpirationDate

      @Deprecated default String getExpirationDate()
      Deprecated.
      The expiration date for the order. This has been deprecated and you should prefer the ExpirationType, ExpirationDateTime and ExpirationDisplayTimeZone fields.
    • getExpirationTime

      @Deprecated default String getExpirationTime()
      Deprecated.
      The expiration time for the order. This has been deprecated and you should prefer the ExpirationType, ExpirationDateTime and ExpirationDisplayTimeZone fields.
    • getExpirationLocation

      @Deprecated default String getExpirationLocation()
      Deprecated.
      The expiration location for the order. This has been deprecated and you should prefer the ExpirationType, ExpirationDateTime and ExpirationDisplayTimeZone fields.
    • getExpirationUTCOffset

      @Deprecated default String getExpirationUTCOffset()
      Deprecated.
      The expiration UTC offset for the order. This has been deprecated and you should prefer the ExpirationType, ExpirationDateTime and ExpirationDisplayTimeZone fields.
    • getLLegById

      default LegDetailsClientFieldSetChild getLLegById(int legId)
      Returns:
      Get the L leg for the given id
    • getLLegById

      default LegDetailsClientFieldSetChild getLLegById(String legId)
      Returns:
      Get the L leg for the given id
    • getLLegByIndex

      default LegDetailsClientFieldSetChild getLLegByIndex(int index)
      Returns:
      Get the L leg for the given index
    • getLLegs

      Returns:
      Get all the L legs for this trade
    • getNumLLegs

      default int getNumLLegs()
      Returns:
      Get the number of L legs for this trade