Interface OrderDetailsClientFieldSet
-
- All Superinterfaces:
LeggedMessage
,Message
- All Known Implementing Classes:
OrderDetailsClientFieldSetChild
,SaveTradeEvent
,SubmitTradeEvent
public interface OrderDetailsClientFieldSet extends LeggedMessage
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default java.lang.String
getAccount()
The account this order is for.default java.lang.String
getActivationDate()
Deprecated.default java.lang.String
getActivationDateTime()
Date and time for activation in ISO_INSTANT format e.g.default java.lang.String
getActivationDisplayTimeZone()
The display time zone for the ActivationDateTime.default java.lang.String
getActivationLocation()
Deprecated.default java.lang.String
getActivationTime()
Deprecated.default java.lang.String
getActivationType()
The activation type.default java.lang.String
getActivationUTCOffset()
Deprecated.default java.lang.String
getAlertEmailAddress1()
Optional email address for order status notifications.default java.lang.String
getAlertEmailAddress10()
Optional email address for order status notifications.default java.lang.String
getAlertEmailAddress2()
Optional email address for order status notifications.default java.lang.String
getAlertEmailAddress3()
Optional email address for order status notifications.default java.lang.String
getAlertEmailAddress4()
Optional email address for order status notifications.default java.lang.String
getAlertEmailAddress5()
Optional email address for order status notifications.default java.lang.String
getAlertEmailAddress6()
Optional email address for order status notifications.default java.lang.String
getAlertEmailAddress7()
Optional email address for order status notifications.default java.lang.String
getAlertEmailAddress8()
Optional email address for order status notifications.default java.lang.String
getAlertEmailAddress9()
Optional email address for order status notifications.default java.lang.String
getAlertPhoneNumber1()
Optional phone number for order status notifications.default java.lang.String
getAlertPhoneNumber10()
Optional phone number for order status notifications.default java.lang.String
getAlertPhoneNumber2()
Optional phone number for order status notifications.default java.lang.String
getAlertPhoneNumber3()
Optional phone number for order status notifications.default java.lang.String
getAlertPhoneNumber4()
Optional phone number for order status notifications.default java.lang.String
getAlertPhoneNumber5()
Optional phone number for order status notifications.default java.lang.String
getAlertPhoneNumber6()
Optional phone number for order status notifications.default java.lang.String
getAlertPhoneNumber7()
Optional phone number for order status notifications.default java.lang.String
getAlertPhoneNumber8()
Optional phone number for order status notifications.default java.lang.String
getAlertPhoneNumber9()
Optional phone number for order status notifications.default java.lang.String
getAlertType()
The types of alerts that should be sent for this order (comma separated list, zero or more values), e.g.default java.lang.String
getCurrencyPair()
The currency pair this order is for.default java.lang.String
getExpirationDate()
Deprecated.default java.lang.String
getExpirationDateTime()
Date and time for expiration in ISO_INSTANT format e.g.default java.lang.String
getExpirationDisplayTimeZone()
The display time zone for the ExpirationDateTime.default java.lang.String
getExpirationLocation()
Deprecated.default java.lang.String
getExpirationTime()
Deprecated.default java.lang.String
getExpirationType()
The expiration type.default java.lang.String
getExpirationUTCOffset()
Deprecated.default LegDetailsClientFieldSetChild
getLLegById(int legId)
default LegDetailsClientFieldSetChild
getLLegById(java.lang.String legId)
default LegDetailsClientFieldSetChild
getLLegByIndex(int index)
java.util.List<LegDetailsClientFieldSetChild>
getLLegs()
default int
getNumLLegs()
default java.lang.String
getStrategyType()
The strategy the order was submitted with.default java.lang.String
getTOBOUser()
The user on whose behalf the trade is submitted.-
Methods inherited from interface com.caplin.motif.datasource.LeggedMessage
getId, getIndex
-
-
-
-
Method Detail
-
getCurrencyPair
default java.lang.String getCurrencyPair()
The currency pair this order is for.
-
getAccount
default java.lang.String getAccount()
The account this order is for.
-
getActivationType
default java.lang.String getActivationType()
The activation type. e.g. EXPLICIT or GFA
-
getActivationDateTime
default java.lang.String getActivationDateTime()
Date and time for activation in ISO_INSTANT format e.g. 2011-12-03T10:15:30Z. Blank if GFA.
-
getActivationDisplayTimeZone
default java.lang.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 java.lang.String getExpirationType()
The expiration type. e.g. EXPLICIT, GTC or GFD
-
getExpirationDateTime
default java.lang.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 java.lang.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 java.lang.String getAlertType()
The types of alerts that should be sent for this order (comma separated list, zero or more values), e.g. SMS, EMAIL.
-
getTOBOUser
default java.lang.String getTOBOUser()
The user on whose behalf the trade is submitted. e.g. john.smith
-
getStrategyType
default java.lang.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.
-
getAlertPhoneNumber1
default java.lang.String getAlertPhoneNumber1()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertPhoneNumber2
default java.lang.String getAlertPhoneNumber2()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertPhoneNumber3
default java.lang.String getAlertPhoneNumber3()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertPhoneNumber4
default java.lang.String getAlertPhoneNumber4()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertPhoneNumber5
default java.lang.String getAlertPhoneNumber5()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertPhoneNumber6
default java.lang.String getAlertPhoneNumber6()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertPhoneNumber7
default java.lang.String getAlertPhoneNumber7()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertPhoneNumber8
default java.lang.String getAlertPhoneNumber8()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertPhoneNumber9
default java.lang.String getAlertPhoneNumber9()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertPhoneNumber10
default java.lang.String getAlertPhoneNumber10()
Optional phone number for order status notifications. e.g. +44 20 7946 0159
-
getAlertEmailAddress1
default java.lang.String getAlertEmailAddress1()
Optional email address for order status notifications. e.g. email@example.com
-
getAlertEmailAddress2
default java.lang.String getAlertEmailAddress2()
Optional email address for order status notifications. e.g. email@example.com
-
getAlertEmailAddress3
default java.lang.String getAlertEmailAddress3()
Optional email address for order status notifications. e.g. email@example.com
-
getAlertEmailAddress4
default java.lang.String getAlertEmailAddress4()
Optional email address for order status notifications. e.g. email@example.com
-
getAlertEmailAddress5
default java.lang.String getAlertEmailAddress5()
Optional email address for order status notifications. e.g. email@example.com
-
getAlertEmailAddress6
default java.lang.String getAlertEmailAddress6()
Optional email address for order status notifications. e.g. email@example.com
-
getAlertEmailAddress7
default java.lang.String getAlertEmailAddress7()
Optional email address for order status notifications. e.g. email@example.com
-
getAlertEmailAddress8
default java.lang.String getAlertEmailAddress8()
Optional email address for order status notifications. e.g. email@example.com
-
getAlertEmailAddress9
default java.lang.String getAlertEmailAddress9()
Optional email address for order status notifications. e.g. email@example.com
-
getAlertEmailAddress10
default java.lang.String getAlertEmailAddress10()
Optional email address for order status notifications. e.g. email@example.com
-
getActivationDate
@Deprecated default java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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(java.lang.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
java.util.List<LegDetailsClientFieldSetChild> getLLegs()
- Returns:
- Get all the L legs for this trade
-
getNumLLegs
default int getNumLLegs()
- Returns:
- Get the number of L legs for this trade
-
-