java.lang.Object
- com.caplin.generated.motif.fx.tradeconfirmation.TradeConfPartsDef.CommonTradeConfirmationFields

All Implemented Interfaces:: BuilderMessage, Message

Enclosing class:: TradeConfPartsDef

public static final class TradeConfPartsDef.CommonTradeConfirmationFields
extends Object
implements BuilderMessage

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TradeConfPartsDef.CommonTradeConfirmationFields.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static @NotNull TradeConfPartsDef.CommonTradeConfirmationFields`	`from(@NotNull Map<String,String> fields)`
`static @NotNull TradeConfPartsDef.CommonTradeConfirmationFields`	`from(@NotNull Map<String,String> fields, @NotNull String fieldPrefix)`
`@Nullable String`	`getAccount()`
`@Nullable String`	`getAssetType()`
`@Nullable String`	`getBackOfficeID()`
`@Nullable Boolean`	`getCanAllocate()`
`@Nullable Boolean`	`getCanRoll()`
`@Nullable String`	`getClient()`	Deprecated.
`@Nullable BigDecimal`	`getContraCostAmount()`
`@Nullable BigDecimal`	`getContraCostCurrency()`
`@Nullable BigDecimal`	`getContraCostPercentage()`
`@Nullable BigDecimal`	`getCostAmount()`
`@Nullable String`	`getCostCurrency()`
`@Nullable Integer`	`getCostCurrencyDPS()`
`@Nullable BigDecimal`	`getCostPercentage()`
`@Nullable String`	`getCurrencyPair()`
`@Nullable String`	`getDealtCurrency()`
`@Nullable String`	`getDeliverableType()`
`@Nullable Integer`	`getDigitsBeforePips()`
`@Nullable String`	`getEntityDescription()`
`@Nullable String`	`getEntityId()`
`@Nullable String`	`getExecutionDateTime()`
`@NotNull Map<String,Collection<String>>`	`getFieldFlags()`
`@NotNull Map<String,String>`	`getFields()`
`@NotNull Map<String,Collection<String>>`	`getFlagFields()`
`@Nullable Boolean`	`getForceReporting()`
`@Nullable String`	`getFullName()`
`@Nullable Boolean`	`getIsAllocated()`
`@Nullable Boolean`	`getIsAmendable()`
`@Nullable Boolean`	`getIsCancellable()`
`@Nullable Boolean`	`getIsReversible()`
`@Nullable Integer`	`getNumberOfPips()`
`@Nullable String`	`getOrderID()`
`@Nullable String`	`getPriceSource()`
`@Nullable String`	`getPurpose()`
`@Nullable String`	`getRemarks()`
`@Nullable BigDecimal`	`getSpotMidRate()`
`@Nullable BigDecimal`	`getSpotRate()`
`@Nullable Integer`	`getSpotRateDPS()`
`@Nullable String`	`getTOBOUser()`
`@Nullable String`	`getTradeDate()`
`@Nullable String`	`getTradeID()`
`@Nullable String`	`getTraderUsername()`
`@Nullable String`	`getTradingType()`
`@Nullable String`	`getUTI()`
`@Nullable String`	`getVenue()`
`@Nullable String`	`getWarningCode()`
`@Nullable String`	`getWarningMessage()`
`static @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder`	`newBuilder()`
`@NotNull String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.caplin.motif.datasource.BuilderMessage
getFieldFlags, getFlagFields

Methods inherited from interface com.caplin.motif.datasource.Message
getField

- Method Detail
  - getTradeID
```
@Nullable
public @Nullable String getTradeID()
```
    Returns:
    
    A unique identifier for this trade
  - getCurrencyPair
```
@Nullable
public @Nullable String getCurrencyPair()
```
    Returns:
    
    The currency pair for the trade. For example, EURUSD
  - getDealtCurrency
```
@Nullable
public @Nullable String getDealtCurrency()
```
    Returns:
    
    The currency of the Amount of a trade or order.
  - getSpotRate
```
@Nullable
public @Nullable BigDecimal getSpotRate()
```
    Returns:
    
    spotRate e.g. 1.08341
  - getSpotMidRate
```
@Nullable
public @Nullable BigDecimal getSpotMidRate()
```
    Returns:
    
    The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.
  - getSpotRateDPS
```
@Nullable
public @Nullable Integer getSpotRateDPS()
```
    Returns:
    
    The number of decimal places to display after the decimal point.
  - getExecutionDateTime
```
@Nullable
public @Nullable String getExecutionDateTime()
```
    Returns:
    
    executionDateTime e.g. 20160322123621
  - getTradeDate
```
@Nullable
public @Nullable String getTradeDate()
```
    Returns:
    
    tradeDate e.g. 20160314
  - 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>
  - 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.
  - getAssetType
```
@Nullable
public @Nullable String getAssetType()
```
    Returns:
    
    A grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations. Supported asset types are [FX, PM]
  - getTradingType
```
@Nullable
public @Nullable String getTradingType()
```
    Returns:
    
    Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
  - getDeliverableType
```
@Nullable
public @Nullable String getDeliverableType()
```
    Returns:
    
    Caplin supported values are [DELIVERABLE, NON_DELIVERABLE]. Determines whether trade is deliverable or not (for ndfs etc)
  - getDigitsBeforePips
```
@Nullable
public @Nullable Integer getDigitsBeforePips()
```
    Returns:
    
    Precision-related field that tells the client how to display rates. This is the number of digits between the decimal point and the pips (i.e the big digits that the client wants to look at). For most currency pairs the value of this bla will be 2, i.e. for a USDGBP rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.
  - getNumberOfPips
```
@Nullable
public @Nullable Integer getNumberOfPips()
```
    Returns:
    
    Precision-related field that tells the client how to display rates. This is the number of pips the client wants to look at. Normally this value is 2.
  - getOrderID
```
@Nullable
public @Nullable String getOrderID()
```
    Returns:
    
    The id of the order.
  - getWarningCode
```
@Nullable
public @Nullable String getWarningCode()
```
    Returns:
    
    The code for the warning regarding a quote request.
  - getWarningMessage
```
@Nullable
public @Nullable String getWarningMessage()
```
    Returns:
    
    The message to display for any warnings regarding a quote request
  - getClient
```
@Deprecated
@Nullable
public @Nullable String getClient()
```
    Deprecated.
    
    Returns:
    
    Client is a duplicate of TOBOUser
  - getCostAmount
```
@Nullable
public @Nullable BigDecimal getCostAmount()
```
    Returns:
    
    The actual transactional cost of performing the trade to the client in the home currency
  - getCostCurrency
```
@Nullable
public @Nullable String getCostCurrency()
```
    Returns:
    
    The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
  - getCostPercentage
```
@Nullable
public @Nullable BigDecimal getCostPercentage()
```
    Returns:
    
    Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.
  - getContraCostAmount
```
@Nullable
public @Nullable BigDecimal getContraCostAmount()
```
    Returns:
    
    The actual transactional cost of performing the trade to the client on the contra currency
  - getContraCostCurrency
```
@Nullable
public @Nullable BigDecimal getContraCostCurrency()
```
    Returns:
    
    The contra currency that the cost is displayed in
  - getContraCostPercentage
```
@Nullable
public @Nullable BigDecimal getContraCostPercentage()
```
    Returns:
    
    Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.
  - getCanAllocate
```
@Nullable
public @Nullable Boolean getCanAllocate()
```
    Returns:
    
    Defines if a user can allocate a trade.
  - getCanRoll
```
@Nullable
public @Nullable Boolean getCanRoll()
```
    Returns:
    
    Defines if a user can roll a trade.
  - getIsAllocated
```
@Nullable
public @Nullable Boolean getIsAllocated()
```
    Returns:
    
    Define if a trade is already allocated or rolled
  - getIsReversible
```
@Nullable
public @Nullable Boolean getIsReversible()
```
    Returns:
    
    Whether a trade can be reversed.
  - getIsAmendable
```
@Nullable
public @Nullable Boolean getIsAmendable()
```
    Returns:
    
    Whether a trade can be amended.
  - getIsCancellable
```
@Nullable
public @Nullable Boolean getIsCancellable()
```
    Returns:
    
    Whether a trade can be cancelled.
  - getCostCurrencyDPS
```
@Nullable
public @Nullable Integer getCostCurrencyDPS()
```
    Returns:
    
    The number of decimal places to display after the decimal point.
  - getRemarks
```
@Nullable
public @Nullable String getRemarks()
```
    Returns:
    
    The text content of a comment left on a leg of a trade or order.
  - getForceReporting
```
@Nullable
public @Nullable Boolean getForceReporting()
```
    Returns:
    
    Indicates whether a trade is flagged for reporting
  - getUTI
```
@Nullable
public @Nullable String getUTI()
```
    Returns:
    
    Unique Transaction Identifier.
  - getBackOfficeID
```
@Nullable
public @Nullable String getBackOfficeID()
```
    Returns:
    
    Back office trade identifier.
  - getPriceSource
```
@Nullable
public @Nullable String getPriceSource()
```
    Returns:
    
    Identifies the person or system that priced the trade.
  - getVenue
```
@Nullable
public @Nullable String getVenue()
```
    Returns:
    
    Where the trade was placed.
  - getPurpose
```
@Nullable
public @Nullable String getPurpose()
```
    Returns:
    
    The purpose of a trade.
  - 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 TradeConfPartsDef.CommonTradeConfirmationFields from(@NotNull
                                                                            @NotNull Map<String,String> fields)
```
  - from
```
@NotNull
public static @NotNull TradeConfPartsDef.CommonTradeConfirmationFields from(@NotNull
                                                                            @NotNull Map<String,String> fields,
                                                                            @NotNull
                                                                            @NotNull String fieldPrefix)
```
  - newBuilder
```
@NotNull
public static @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder newBuilder()
```

Class TradeConfPartsDef.CommonTradeConfirmationFields

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.caplin.motif.datasource.BuilderMessage

Methods inherited from interface com.caplin.motif.datasource.Message

Method Detail

getTradeID

getCurrencyPair

getDealtCurrency

getSpotRate

getSpotMidRate

getSpotRateDPS

getExecutionDateTime

getTradeDate

getAccount

getTraderUsername

getTOBOUser

getFullName

getEntityId

getEntityDescription

getAssetType

getTradingType

getDeliverableType

getDigitsBeforePips

getNumberOfPips

getOrderID

getWarningCode

getWarningMessage

getClient

getCostAmount

getCostCurrency

getCostPercentage

getContraCostAmount

getContraCostCurrency

getContraCostPercentage

getCanAllocate

getCanRoll

getIsAllocated

getIsReversible

getIsAmendable

getIsCancellable

getCostCurrencyDPS

getRemarks

getForceReporting

getUTI

getBackOfficeID

getPriceSource

getVenue

getPurpose

getFields

getFieldFlags

getFlagFields

toString

from

from

newBuilder