Interface OrderDetailsServerFieldSet
public interface OrderDetailsServerFieldSet
-
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a field to this eventdefault voidsetAccount(Object value) The account this order is for.default voidsetActivationDate(Object value) Deprecated.default voidsetActivationDateTime(Object value) Date and time for activation in ISO_INSTANT format e.g.default voidThe display time zone for the ActivationDateTime.default voidsetActivationLocation(Object value) Deprecated.default voidsetActivationTime(Object value) Deprecated.default voidsetActivationType(Object value) The activation type.default voidsetActivationUTCOffset(Object value) Deprecated.default voidsetAlertEmailAddress1(Object value) Optional email address for order status notifications.default voidsetAlertEmailAddress10(Object value) Optional email address for order status notifications.default voidsetAlertEmailAddress2(Object value) Optional email address for order status notifications.default voidsetAlertEmailAddress3(Object value) Optional email address for order status notifications.default voidsetAlertEmailAddress4(Object value) Optional email address for order status notifications.default voidsetAlertEmailAddress5(Object value) Optional email address for order status notifications.default voidsetAlertEmailAddress6(Object value) Optional email address for order status notifications.default voidsetAlertEmailAddress7(Object value) Optional email address for order status notifications.default voidsetAlertEmailAddress8(Object value) Optional email address for order status notifications.default voidsetAlertEmailAddress9(Object value) Optional email address for order status notifications.default voidsetAlertPhoneNumber1(Object value) Optional phone number for order status notifications.default voidsetAlertPhoneNumber10(Object value) Optional phone number for order status notifications.default voidsetAlertPhoneNumber2(Object value) Optional phone number for order status notifications.default voidsetAlertPhoneNumber3(Object value) Optional phone number for order status notifications.default voidsetAlertPhoneNumber4(Object value) Optional phone number for order status notifications.default voidsetAlertPhoneNumber5(Object value) Optional phone number for order status notifications.default voidsetAlertPhoneNumber6(Object value) Optional phone number for order status notifications.default voidsetAlertPhoneNumber7(Object value) Optional phone number for order status notifications.default voidsetAlertPhoneNumber8(Object value) Optional phone number for order status notifications.default voidsetAlertPhoneNumber9(Object value) Optional phone number for order status notifications.default voidsetAlertType(Object value) The types of alerts that should be sent for this order (comma separated list, zero or more values), e.g.default voidA unique identifier for the client applicationdefault voidsetCurrencyPair(Object value) The currency pair this order is for.default voidsetDuration(Object value) The duration of the TWAP strategy in ISO-8601 format, e.g.default voidsetEntityId(Object value) The entity on whose behalf the trade is submitted.default voidsetExpirationDate(Object value) Deprecated.default voidsetExpirationDateTime(Object value) Date and time for expiration in ISO_INSTANT format e.g.default voidThe display time zone for the ExpirationDateTime.default voidsetExpirationLocation(Object value) Deprecated.default voidsetExpirationTime(Object value) Deprecated.default voidsetExpirationType(Object value) The expiration type.default voidsetExpirationUTCOffset(Object value) Deprecated.default voidsetFixingSource(Object value) The fixing source of the NDF tradedefault voidsetNumberOfSlices(Object value) The number of slices the strategy should release over its lifetimedefault voidsetSettlementCurrency(Object value) The settlement currency of the NDF tradedefault voidsetSliceAmountVariance(Object value) The allowed variance of each slice.default voidsetStrategyType(Object value) The strategy the order was submitted with.default voidsetTOBOUser(Object value) The user on whose behalf the trade is submitted.
-
Method Details
-
addField
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 aStringusingBigDecimal.toPlainString()
-
setCurrencyPair
The currency pair this order is for.- Parameters:
value- The value to be set passed by i18n
-
setAccount
The account this order is for.- Parameters:
value- The value to be set passed by i18n
-
setActivationType
The activation type. e.g. EXPLICIT or GFA- Parameters:
value- The value to be set passed by i18n
-
setActivationDateTime
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
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
The expiration type. e.g. EXPLICIT, GTC or GFD- Parameters:
value- The value to be set passed by i18n
-
setExpirationDateTime
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
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
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
The entity on whose behalf the trade is submitted.- Parameters:
value- The value to be set passed by i18n
-
setTOBOUser
The user on whose behalf the trade is submitted. e.g. john.smith- Parameters:
value- The value to be set passed by i18n
-
setStrategyType
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, TWAP]. OTHER denotes a strategy type that is unsupported.- Parameters:
value- The value to be set passed by i18n
-
setAppID
A unique identifier for the client application- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber1
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber2
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber3
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber4
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber5
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber6
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber7
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber8
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber9
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertPhoneNumber10
Optional phone number for order status notifications. e.g. +44 20 7946 0159- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress1
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress2
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress3
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress4
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress5
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress6
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress7
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress8
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress9
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setAlertEmailAddress10
Optional email address for order status notifications. e.g. email@example.com- Parameters:
value- The value to be set passed by i18n
-
setFixingSource
The fixing source of the NDF trade- Parameters:
value- The value to be set passed by i18n
-
setSettlementCurrency
The settlement currency of the NDF trade- Parameters:
value- The value to be set passed by i18n
-
setDuration
The duration of the TWAP strategy in ISO-8601 format, e.g. PT5M- Parameters:
value- The value to be set passed by i18n
-
setNumberOfSlices
The number of slices the strategy should release over its lifetime- Parameters:
value- The value to be set passed by i18n
-
setSliceAmountVariance
The allowed variance of each slice. For example, an amount of 10,000 over 2 slices with a variance of 0.5 (50%) means the slice sizes will be in the range 2,500 to 7,500 (10,000/2 * (1 ± 0.5))- Parameters:
value- The value to be set passed by i18n
-
setActivationDate
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.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.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.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.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.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.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.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
-