Class TradeConfPartsDef.CommonTradeConfirmationFields.Builder
java.lang.Object
com.caplin.generated.motif.fx.tradeconfirmation.TradeConfPartsDef.CommonTradeConfirmationFields.Builder
- Enclosing class:
- TradeConfPartsDef.CommonTradeConfirmationFields
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
setAccount
(@NotNull String account) setAccount
(@NotNull String account, boolean isEditable) setAllocationSettlementDateOptions
(@NotNull String allocationSettlementDateOptions) setAmountDPS
(int amountDPS) setAmountDPS
(@NotNull String amountDPS) setAssetType
(@NotNull String assetType) setBackOfficeID
(@NotNull String backOfficeID) setCanAllocate
(@NotNull String canAllocate) setCanDrawdown
(boolean canDrawdown) setCanDrawdown
(@NotNull String canDrawdown) Deprecated.setClientAgreementDateTime
(@NotNull String clientAgreementDateTime) setClientAgreementDateTime
(@NotNull String clientAgreementDateTime, boolean isEditable) setClientAgreementDateTime
(@NotNull Instant clientAgreementDateTime) setClientAgreementDateTime
(@NotNull Instant clientAgreementDateTime, boolean isEditable) setContraAmountDPS
(int contraAmountDPS) setContraAmountDPS
(@NotNull String contraAmountDPS) setContraCostAmount
(@NotNull String contraCostAmount) setContraCostAmount
(@NotNull BigDecimal contraCostAmount) setContraCostCurrency
(@NotNull String contraCostCurrency) setContraCostCurrencyDPS
(int contraCostCurrencyDPS) setContraCostCurrencyDPS
(@NotNull String contraCostCurrencyDPS) setContraCostPercentage
(@NotNull String contraCostPercentage) setContraCostPercentage
(@NotNull BigDecimal contraCostPercentage) setCostAmount
(@NotNull String costAmount) setCostAmount
(@NotNull BigDecimal costAmount) setCostCurrency
(@NotNull String costCurrency) setCostCurrencyDPS
(int costCurrencyDPS) setCostCurrencyDPS
(@NotNull String costCurrencyDPS) setCostPercentage
(@NotNull String costPercentage) setCostPercentage
(@NotNull BigDecimal costPercentage) setCurrencyPair
(@NotNull String currencyPair) setDealtCurrency
(@NotNull String dealtCurrency) setDealtCurrency
(@NotNull String dealtCurrency, boolean isEditable, boolean isRisk) setDeliverableType
(@NotNull String deliverableType) setDetailedWarningMessage
(@NotNull String detailedWarningMessage) setDigitsBeforePips
(int digitsBeforePips) setDigitsBeforePips
(@NotNull String digitsBeforePips) setEntityDescription
(@NotNull String entityDescription) setEntityId
(@NotNull String entityId) setExecutionDateTime
(@NotNull String executionDateTime) setFullName
(@NotNull String fullName) setHasPostTradeHistory
(boolean hasPostTradeHistory) setHasPostTradeHistory
(@NotNull String hasPostTradeHistory) setIsAllocated
(boolean isAllocated) Deprecated.setIsAllocated
(@NotNull String isAllocated) Deprecated.setIsAmendable
(boolean isAmendable) setIsAmendable
(@NotNull String isAmendable) setIsCancellable
(boolean isCancellable) setIsCancellable
(@NotNull String isCancellable) setIsReversible
(boolean isReversible) setIsReversible
(@NotNull String isReversible) setNaturalLanguageSummaryHidden
(boolean naturalLanguageSummaryHidden) setNaturalLanguageSummaryHidden
(@NotNull String naturalLanguageSummaryHidden) setNumberOfPips
(int numberOfPips) setNumberOfPips
(@NotNull String numberOfPips) setOrderID
(@NotNull String orderID) setOriginalTradeID
(@NotNull String originalTradeID) setPostTradeType
(@NotNull String postTradeType) setPriceSource
(@NotNull String priceSource) setPurpose
(@NotNull String purpose) setRemarks
(@NotNull String remarks) setServiceContraCostCurrencyDPS
(int serviceContraCostCurrencyDPS) setServiceContraCostCurrencyDPS
(@NotNull String serviceContraCostCurrencyDPS) setServiceCostCurrencyDPS
(int serviceCostCurrencyDPS) setServiceCostCurrencyDPS
(@NotNull String serviceCostCurrencyDPS) setSpotMidRate
(@NotNull String spotMidRate) setSpotMidRate
(@NotNull BigDecimal spotMidRate) setSpotRate
(@NotNull String spotRate) setSpotRate
(@NotNull BigDecimal spotRate) setSpotRateDPS
(int spotRateDPS) setSpotRateDPS
(@NotNull String spotRateDPS) setTOBOUser
(@NotNull String tOBOUser) setTOBOUser
(@NotNull String tOBOUser, boolean isEditable, boolean isRisk) setTradeDate
(@NotNull String tradeDate) setTradeID
(@NotNull String tradeID) setTraderUsername
(@NotNull String traderUsername) setTradingType
(@NotNull String tradingType) setWarningCode
(@NotNull String warningCode) setWarningMessage
(@NotNull String warningMessage) @NotNull String
toString()
-
Method Details
-
addField
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value) -
build
-
toString
-
setTradeID
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradeID(@NotNull @NotNull String tradeID) - Parameters:
tradeID
- e.g. 00001561- Returns:
- A unique identifier for this trade
-
setCurrencyPair
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCurrencyPair(@NotNull @NotNull String currencyPair) - Returns:
- The currency pair for the trade. For example, EURUSD
-
setDealtCurrency
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDealtCurrency(@NotNull @NotNull String dealtCurrency, boolean isEditable, boolean isRisk) - Parameters:
dealtCurrency
- e.g. GBP- Returns:
- The currency of the Amount of a trade or order.
-
setDealtCurrency
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDealtCurrency(@NotNull @NotNull String dealtCurrency) - Parameters:
dealtCurrency
- e.g. GBP- Returns:
- The currency of the Amount of a trade or order.
-
setDealtCurrencyEditable
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDealtCurrencyEditable() -
setDealtCurrencyRisk
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDealtCurrencyRisk() -
setSpotRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setSpotRate(@NotNull @NotNull BigDecimal spotRate) - Parameters:
spotRate
- e.g. 1.08341- Returns:
- spotRate
-
setSpotRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setSpotRate(@NotNull @NotNull String spotRate) - Parameters:
spotRate
- e.g. 1.08341- Returns:
- spotRate
-
setSpotMidRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setSpotMidRate(@NotNull @NotNull BigDecimal spotMidRate) - Parameters:
spotMidRate
- e.g. 1.08345- Returns:
- The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.
-
setSpotMidRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setSpotMidRate(@NotNull @NotNull String spotMidRate) - Parameters:
spotMidRate
- e.g. 1.08345- Returns:
- The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.
-
setSpotRateDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setSpotRateDPS(int spotRateDPS) - Parameters:
spotRateDPS
- e.g. 5- Returns:
- The number of decimal places to display after the decimal point.
-
setSpotRateDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setSpotRateDPS(@NotNull @NotNull String spotRateDPS) - Parameters:
spotRateDPS
- e.g. 5- Returns:
- The number of decimal places to display after the decimal point.
-
setExecutionDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setExecutionDateTime(@NotNull @NotNull String executionDateTime) - Parameters:
executionDateTime
- e.g. 20160322123621- Returns:
- executionDateTime
-
setTradeDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradeDate(@NotNull @NotNull String tradeDate) - Parameters:
tradeDate
- e.g. 20160314- Returns:
- tradeDate
-
setAccount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAccount(@NotNull @NotNull String account, boolean isEditable) - Parameters:
account
- e.g. Garfields|GARF- Returns:
- The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
-
setAccount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAccount(@NotNull @NotNull String account) - Parameters:
account
- e.g. Garfields|GARF- Returns:
- The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
-
setAccountEditable
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAccountEditable() -
setTraderUsername
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTraderUsername(@NotNull @NotNull String traderUsername) - Parameters:
traderUsername
- e.g. sales_trader@novobank.co.za- 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.
-
setTOBOUser
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTOBOUser(@NotNull @NotNull String tOBOUser, boolean isEditable, boolean isRisk) - Parameters:
tOBOUser
- e.g. client@customer.co.za- 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.
-
setTOBOUser
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTOBOUser(@NotNull @NotNull String tOBOUser) - Parameters:
tOBOUser
- e.g. client@customer.co.za- 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.
-
setTOBOUserEditable
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTOBOUserEditable() -
setTOBOUserRisk
-
setFullName
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setFullName(@NotNull @NotNull String fullName) - Returns:
- The full name of the user the trade is on behalf of
-
setEntityId
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setEntityId(@NotNull @NotNull String entityId) - Parameters:
entityId
- e.g. CUSTONE- 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.
-
setEntityDescription
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setEntityDescription(@NotNull @NotNull String entityDescription) - Parameters:
entityDescription
- e.g. Customer 1- Returns:
- The description of a trade on behalf of entity.
-
setAssetType
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAssetType(@NotNull @NotNull String assetType) - Parameters:
assetType
- e.g. FX- Returns:
- A grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations. Supported asset types are [FX, PM]
-
setTradingType
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradingType(@NotNull @NotNull String tradingType) - Returns:
- Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
-
setDeliverableType
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDeliverableType(@NotNull @NotNull String deliverableType) - Returns:
- Caplin supported values are [DELIVERABLE, NON_DELIVERABLE]. Determines whether trade is deliverable or not (for ndfs etc)
-
setDigitsBeforePips
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDigitsBeforePips(int digitsBeforePips) - Parameters:
digitsBeforePips
- e.g. 2- 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 field 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.
-
setDigitsBeforePips
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDigitsBeforePips(@NotNull @NotNull String digitsBeforePips) - Parameters:
digitsBeforePips
- e.g. 2- 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 field 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.
-
setNumberOfPips
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNumberOfPips(int numberOfPips) - Parameters:
numberOfPips
- e.g. 2- 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.
-
setNumberOfPips
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNumberOfPips(@NotNull @NotNull String numberOfPips) - Parameters:
numberOfPips
- e.g. 2- 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.
-
setOrderID
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setOrderID(@NotNull @NotNull String orderID) - Returns:
- The id of the order.
-
setWarningCode
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setWarningCode(@NotNull @NotNull String warningCode) - Parameters:
warningCode
- e.g. 001- Returns:
- The code for the warning regarding a quote request.
-
setWarningMessage
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setWarningMessage(@NotNull @NotNull String warningMessage) - Parameters:
warningMessage
- e.g. **CREDIT CHECK:** This user has a credit limit of **1,000,000.00 USD** which should not be exceeded.- Returns:
- The message to display for any warnings regarding a quote request. Supports Markdown syntax for formatting.
-
setDetailedWarningMessage
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDetailedWarningMessage(@NotNull @NotNull String detailedWarningMessage) - Parameters:
detailedWarningMessage
- e.g. color: {{theme:foreground.semantic.warning_inverse}}- Returns:
- detailedWarningMessage
-
setClient
@Deprecated @NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClient(@NotNull @NotNull String client) Deprecated.- Returns:
- Client is a duplicate of TOBOUser
-
setCostAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostAmount(@NotNull @NotNull BigDecimal costAmount) - Parameters:
costAmount
- e.g. 12412891.31- Returns:
- The actual transactional cost of performing the trade to the client in the home currency
-
setCostAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostAmount(@NotNull @NotNull String costAmount) - Parameters:
costAmount
- e.g. 12412891.31- Returns:
- The actual transactional cost of performing the trade to the client in the home currency
-
setCostCurrency
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostCurrency(@NotNull @NotNull String costCurrency) - Parameters:
costCurrency
- e.g. GBP- Returns:
- The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
-
setCostCurrencyDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostCurrencyDPS(int costCurrencyDPS) - Parameters:
costCurrencyDPS
- e.g. 2- Returns:
- The number of decimal places to display after the decimal point.
-
setCostCurrencyDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostCurrencyDPS(@NotNull @NotNull String costCurrencyDPS) - Parameters:
costCurrencyDPS
- e.g. 2- Returns:
- The number of decimal places to display after the decimal point.
-
setCostPercentage
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostPercentage(@NotNull @NotNull BigDecimal costPercentage) - Parameters:
costPercentage
- e.g. 13.56- 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%.
-
setCostPercentage
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostPercentage(@NotNull @NotNull String costPercentage) - Parameters:
costPercentage
- e.g. 13.56- 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%.
-
setContraCostAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostAmount(@NotNull @NotNull BigDecimal contraCostAmount) - Returns:
- The actual transactional cost of performing the trade to the client on the contra currency
-
setContraCostAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostAmount(@NotNull @NotNull String contraCostAmount) - Returns:
- The actual transactional cost of performing the trade to the client on the contra currency
-
setContraCostCurrency
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostCurrency(@NotNull @NotNull String contraCostCurrency) - Parameters:
contraCostCurrency
- e.g. GBP- Returns:
- The contra currency that the cost is displayed in
-
setContraCostCurrencyDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostCurrencyDPS(int contraCostCurrencyDPS) - Parameters:
contraCostCurrencyDPS
- e.g. 2- Returns:
- The number of decimal places to display after the decimal point.
-
setContraCostCurrencyDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostCurrencyDPS(@NotNull @NotNull String contraCostCurrencyDPS) - Parameters:
contraCostCurrencyDPS
- e.g. 2- Returns:
- The number of decimal places to display after the decimal point.
-
setContraCostPercentage
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostPercentage(@NotNull @NotNull BigDecimal contraCostPercentage) - Parameters:
contraCostPercentage
- e.g. 13.56- 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%.
-
setContraCostPercentage
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostPercentage(@NotNull @NotNull String contraCostPercentage) - Parameters:
contraCostPercentage
- e.g. 13.56- 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%.
-
setServiceCostCurrencyDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setServiceCostCurrencyDPS(int serviceCostCurrencyDPS) - Parameters:
serviceCostCurrencyDPS
- e.g. 2- Returns:
- The number of decimal places to display after the decimal point.
-
setServiceCostCurrencyDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setServiceCostCurrencyDPS(@NotNull @NotNull String serviceCostCurrencyDPS) - Parameters:
serviceCostCurrencyDPS
- e.g. 2- Returns:
- The number of decimal places to display after the decimal point.
-
setServiceContraCostCurrencyDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setServiceContraCostCurrencyDPS(int serviceContraCostCurrencyDPS) - Parameters:
serviceContraCostCurrencyDPS
- e.g. 2- Returns:
- The number of decimal places to display after the decimal point.
-
setServiceContraCostCurrencyDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setServiceContraCostCurrencyDPS(@NotNull @NotNull String serviceContraCostCurrencyDPS) - Parameters:
serviceContraCostCurrencyDPS
- e.g. 2- Returns:
- The number of decimal places to display after the decimal point.
-
setCanAllocate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanAllocate(@NotNull @NotNull String canAllocate) - Returns:
- Defines if a user can allocate a trade. Enum of: NONE, FULL, FULL_OR_PARTIAL
-
setCanDrawdown
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanDrawdown(boolean canDrawdown) - Returns:
- Ability to Drawdown a time option trade.
-
setCanDrawdown
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanDrawdown(@NotNull @NotNull String canDrawdown) - Returns:
- Ability to Drawdown a time option trade.
-
setAllocationSettlementDateOptions
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAllocationSettlementDateOptions(@NotNull @NotNull String allocationSettlementDateOptions) - Parameters:
allocationSettlementDateOptions
- e.g. ORIGINAL,EARLIER,LATER- Returns:
- Comma-separated list, defines available settlement dates for an allocation.
-
setIsAllocated
@Deprecated @NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsAllocated(boolean isAllocated) Deprecated.- Returns:
- Deprecated, use HasPostTradeHistory instead.
-
setIsAllocated
@Deprecated @NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsAllocated(@NotNull @NotNull String isAllocated) Deprecated.- Returns:
- Deprecated, use HasPostTradeHistory instead.
-
setHasPostTradeHistory
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setHasPostTradeHistory(boolean hasPostTradeHistory) - Returns:
- Define whether post-trade history (related deals e.g. drawdowns, allocations, early take ups and roll overs) is available.
-
setHasPostTradeHistory
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setHasPostTradeHistory(@NotNull @NotNull String hasPostTradeHistory) - Returns:
- Define whether post-trade history (related deals e.g. drawdowns, allocations, early take ups and roll overs) is available.
-
setIsReversible
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsReversible(boolean isReversible) - Returns:
- Whether a trade can be reversed.
-
setIsReversible
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsReversible(@NotNull @NotNull String isReversible) - Returns:
- Whether a trade can be reversed.
-
setIsAmendable
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsAmendable(boolean isAmendable) - Returns:
- Whether a trade can be amended.
-
setIsAmendable
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsAmendable(@NotNull @NotNull String isAmendable) - Returns:
- Whether a trade can be amended.
-
setIsCancellable
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsCancellable(boolean isCancellable) - Returns:
- Whether a trade can be cancelled.
-
setIsCancellable
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsCancellable(@NotNull @NotNull String isCancellable) - Returns:
- Whether a trade can be cancelled.
-
setAmountDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAmountDPS(int amountDPS) - Parameters:
amountDPS
- e.g. 2- Returns:
- The precision for a specified currency pair and dealt currency
-
setAmountDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAmountDPS(@NotNull @NotNull String amountDPS) - Parameters:
amountDPS
- e.g. 2- Returns:
- The precision for a specified currency pair and dealt currency
-
setContraAmountDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraAmountDPS(int contraAmountDPS) - Parameters:
contraAmountDPS
- e.g. 2- Returns:
- The precision for a specified currency pair and contra currency
-
setContraAmountDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraAmountDPS(@NotNull @NotNull String contraAmountDPS) - Parameters:
contraAmountDPS
- e.g. 2- Returns:
- The precision for a specified currency pair and contra currency
-
setRemarks
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setRemarks(@NotNull @NotNull String remarks) - Returns:
- The text content of a comment left on a leg of a trade or order.
-
setUTI
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setUTI(@NotNull @NotNull String uTI) - Returns:
- Unique Transaction Identifier.
-
setBackOfficeID
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setBackOfficeID(@NotNull @NotNull String backOfficeID) - Returns:
- Back office trade identifier.
-
setPriceSource
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPriceSource(@NotNull @NotNull String priceSource) - Parameters:
priceSource
- e.g. st1@caplin.com- Returns:
- Identifies the person or system that priced the trade.
-
setVenue
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setVenue(@NotNull @NotNull String venue) - Parameters:
venue
- e.g. FX Sales- Returns:
- Where the trade was placed.
-
setPurpose
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPurpose(@NotNull @NotNull String purpose) - Parameters:
purpose
- e.g. Commercial- Returns:
- The purpose of a trade.
-
setTags
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTags(@NotNull @NotNull String tags) - Parameters:
tags
- e.g. method={'import':'static com.caplin.motif.fx.config.definitions.common.Tag','name':'Arrays.asList'}- Returns:
- Tags for a trade.
-
setTags
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTags(@NotNull @NotNull List<Tag> tags) - Parameters:
tags
- e.g. method={'import':'static com.caplin.motif.fx.config.definitions.common.Tag','name':'Arrays.asList'}- Returns:
- Tags for a trade.
-
setClientAgreementDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClientAgreementDateTime(@NotNull @NotNull Instant clientAgreementDateTime, boolean isEditable) - Returns:
- Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different
-
setClientAgreementDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClientAgreementDateTime(@NotNull @NotNull Instant clientAgreementDateTime) - Returns:
- Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different
-
setClientAgreementDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClientAgreementDateTime(@NotNull @NotNull String clientAgreementDateTime, boolean isEditable) - Returns:
- Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different
-
setClientAgreementDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClientAgreementDateTime(@NotNull @NotNull String clientAgreementDateTime) - Returns:
- Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different
-
setClientAgreementDateTimeEditable
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClientAgreementDateTimeEditable() -
setPostTradeType
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPostTradeType(@NotNull @NotNull String postTradeType) - Returns:
- The post-trade action that created this trade. Enum of: ROLL_BACK, ROLL_FORWARD, ALLOCATION, DRAWDOWN
-
setOriginalTradeID
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setOriginalTradeID(@NotNull @NotNull String originalTradeID) - Returns:
- TradeID of the trade that this trade was created from.
-
setStatus
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setStatus(@NotNull @NotNull String status) - Returns:
- Status of the trade. Frontends may use this value for display purpose, but no logic is associated with it. Use Can* flags to drive post-trade logic.
-
setNaturalLanguageSummaryHidden
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNaturalLanguageSummaryHidden(boolean naturalLanguageSummaryHidden) - Returns:
- When true, the natural language summary will be hidden on the RFS ticket summary.
-
setNaturalLanguageSummaryHidden
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNaturalLanguageSummaryHidden(@NotNull @NotNull String naturalLanguageSummaryHidden) - Returns:
- When true, the natural language summary will be hidden on the RFS ticket summary.
-