Interface OrderDetailsServerFieldSet


public interface OrderDetailsServerFieldSet
  • Method Details

    • addField

      void addField(String fieldName, Object value)
      Adds a field to this event
      Parameters:
      fieldName - The name of the field to add.
      value - The value of the field to add. If the value is a BigDecimal then it will be converted to a String using BigDecimal.toPlainString()
    • setCurrencyPair

      default void setCurrencyPair(Object value)
      The currency pair this order is for.
      Parameters:
      value - The value to be set passed by i18n
    • setAccount

      default void setAccount(Object value)
      The account this order is for.
      Parameters:
      value - The value to be set passed by i18n
    • setActivationType

      default void setActivationType(Object value)
      The activation type. e.g. EXPLICIT or GFA
      Parameters:
      value - The value to be set passed by i18n
    • setActivationDateTime

      default void setActivationDateTime(Object value)
      Date and time for activation in ISO_INSTANT format e.g. 2011-12-03T10:15:30Z. Blank if GFA.
      Parameters:
      value - The value to be set passed by i18n
    • setActivationDisplayTimeZone

      default void setActivationDisplayTimeZone(Object value)
      The display time zone for the ActivationDateTime. Blank if GFA, else must be in TZ format, e.g. America/New_York or Europe/London.
      Parameters:
      value - The value to be set passed by i18n
    • setExpirationType

      default void setExpirationType(Object value)
      The expiration type. e.g. EXPLICIT, GTC or GFD
      Parameters:
      value - The value to be set passed by i18n
    • setExpirationDateTime

      default void setExpirationDateTime(Object value)
      Date and time for expiration in ISO_INSTANT format e.g. 2011-12-03T10:15:30Z. Blank if GTC or GFD.
      Parameters:
      value - The value to be set passed by i18n
    • setExpirationDisplayTimeZone

      default void setExpirationDisplayTimeZone(Object value)
      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.
      Parameters:
      value - The value to be set passed by i18n
    • setAlertType

      default void setAlertType(Object value)
      The types of alerts that should be sent for this order (comma separated list, zero or more values), e.g. SMS, EMAIL.
      Parameters:
      value - The value to be set passed by i18n
    • setEntityId

      default void setEntityId(Object value)
      The entity on whose behalf the trade is submitted.
      Parameters:
      value - The value to be set passed by i18n
    • setTOBOUser

      default void setTOBOUser(Object value)
      The user on whose behalf the trade is submitted. e.g. john.smith
      Parameters:
      value - The value to be set passed by i18n
    • setStrategyType

      default void setStrategyType(Object value)
      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.
      Parameters:
      value - The value to be set passed by i18n
    • setAppID

      default void setAppID(Object value)
      A unique identifier for the client application
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber1

      default void setAlertPhoneNumber1(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber2

      default void setAlertPhoneNumber2(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber3

      default void setAlertPhoneNumber3(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber4

      default void setAlertPhoneNumber4(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber5

      default void setAlertPhoneNumber5(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber6

      default void setAlertPhoneNumber6(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber7

      default void setAlertPhoneNumber7(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber8

      default void setAlertPhoneNumber8(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber9

      default void setAlertPhoneNumber9(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertPhoneNumber10

      default void setAlertPhoneNumber10(Object value)
      Optional phone number for order status notifications. e.g. +44 20 7946 0159
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress1

      default void setAlertEmailAddress1(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress2

      default void setAlertEmailAddress2(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress3

      default void setAlertEmailAddress3(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress4

      default void setAlertEmailAddress4(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress5

      default void setAlertEmailAddress5(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress6

      default void setAlertEmailAddress6(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress7

      default void setAlertEmailAddress7(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress8

      default void setAlertEmailAddress8(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress9

      default void setAlertEmailAddress9(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setAlertEmailAddress10

      default void setAlertEmailAddress10(Object value)
      Optional email address for order status notifications. e.g. email@example.com
      Parameters:
      value - The value to be set passed by i18n
    • setFixingSource

      default void setFixingSource(Object value)
      The fixing source of the NDF trade
      Parameters:
      value - The value to be set passed by i18n
    • setSettlementCurrency

      default void setSettlementCurrency(Object value)
      The settlement currency of the NDF trade
      Parameters:
      value - The value to be set passed by i18n
    • setActivationDate

      @Deprecated default void setActivationDate(Object value)
      Deprecated.
      The activation date for the order. This has been deprecated and you should prefer the ActivationType, ActivationDateTime and ActivationDisplayTimeZone fields.
      Parameters:
      value - The value to be set passed by i18n
    • setActivationTime

      @Deprecated default void setActivationTime(Object value)
      Deprecated.
      The activation time for the order. This has been deprecated and you should prefer the ActivationType, ActivationDateTime and ActivationDisplayTimeZone fields.
      Parameters:
      value - The value to be set passed by i18n
    • setActivationLocation

      @Deprecated default void setActivationLocation(Object value)
      Deprecated.
      The activation location for the order. This has been deprecated and you should prefer the ActivationType, ActivationDateTime and ActivationDisplayTimeZone fields.
      Parameters:
      value - The value to be set passed by i18n
    • setActivationUTCOffset

      @Deprecated default void setActivationUTCOffset(Object value)
      Deprecated.
      The activation UTC offset for the order. This has been deprecated and you should prefer the ActivationType, ActivationDateTime and ActivationDisplayTimeZone fields.
      Parameters:
      value - The value to be set passed by i18n
    • setExpirationDate

      @Deprecated default void setExpirationDate(Object value)
      Deprecated.
      The expiration date for the order. This has been deprecated and you should prefer the ExpirationType, ExpirationDateTime and ExpirationDisplayTimeZone fields.
      Parameters:
      value - The value to be set passed by i18n
    • setExpirationTime

      @Deprecated default void setExpirationTime(Object value)
      Deprecated.
      The expiration time for the order. This has been deprecated and you should prefer the ExpirationType, ExpirationDateTime and ExpirationDisplayTimeZone fields.
      Parameters:
      value - The value to be set passed by i18n
    • setExpirationLocation

      @Deprecated default void setExpirationLocation(Object value)
      Deprecated.
      The expiration location for the order. This has been deprecated and you should prefer the ExpirationType, ExpirationDateTime and ExpirationDisplayTimeZone fields.
      Parameters:
      value - The value to be set passed by i18n
    • setExpirationUTCOffset

      @Deprecated default void setExpirationUTCOffset(Object value)
      Deprecated.
      The expiration UTC offset for the order. This has been deprecated and you should prefer the ExpirationType, ExpirationDateTime and ExpirationDisplayTimeZone fields.
      Parameters:
      value - The value to be set passed by i18n