Class TradeConfPartsDef.CommonTradeConfirmationFields.Builder
java.lang.Object
com.caplin.generated.motif.mm.tradeconfirmation.TradeConfPartsDef.CommonTradeConfirmationFields.Builder
- Enclosing class:
- TradeConfPartsDef.CommonTradeConfirmationFields
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
setAccount
(@NotNull String account) setAllocationMode
(@NotNull String allocationMode) setCallAccount
(@NotNull String callAccount) setCanAffirm
(boolean canAffirm) setCanAffirm
(@NotNull String canAffirm) setCanCapitalIncrease
(boolean canCapitalIncrease) setCanCapitalIncrease
(@NotNull String canCapitalIncrease) setCanChangeSSI
(boolean canChangeSSI) setCanChangeSSI
(@NotNull String canChangeSSI) setCanConfirm
(boolean canConfirm) setCanConfirm
(@NotNull String canConfirm) setCanGiveNotice
(boolean canGiveNotice) setCanGiveNotice
(@NotNull String canGiveNotice) setCanRollOver
(boolean canRollOver) setCanRollOver
(@NotNull String canRollOver) setConfirmedBy
(@NotNull String confirmedBy) setConfirmedDateTime
(@NotNull String confirmedDateTime) setConfirmedDateTime
(@NotNull Instant confirmedDateTime) setCurrency
(@NotNull String currency) setDisplayFields
(@NotNull DisplayFields displayFields) setDisplayFields
(@NotNull String displayFields) setEntityDescription
(@NotNull String entityDescription) setEntityId
(@NotNull String entityId) setExecutionDateTime
(@NotNull String executionDateTime) setHasPostTradeHistory
(boolean hasPostTradeHistory) setHasPostTradeHistory
(@NotNull String hasPostTradeHistory) setIndicativeProfitRate
(@NotNull String indicativeProfitRate) setInterestAmount
(@NotNull String interestAmount) setInterestAmount
(@NotNull BigDecimal interestAmount) setInterestRate
(@NotNull String interestRate) setInterestRate
(@NotNull BigDecimal interestRate) setInterestRateDPS
(@NotNull String interestRateDPS) setInterestRateDPS
(@NotNull BigDecimal interestRateDPS) setIsShariaTrade
(boolean isShariaTrade) setIsShariaTrade
(@NotNull String isShariaTrade) setMaturityDate
(@NotNull String maturityDate) setMaturityDate
(@NotNull LocalDate maturityDate) setMaturityTenor
(@NotNull String maturityTenor) setNoticePeriod
(@NotNull String noticePeriod) setNoticePeriodDescription
(@NotNull String noticePeriodDescription) setNumberOfDays
(@NotNull String numberOfDays) setPaymentFrequency
(@NotNull String paymentFrequency) setPrincipalAmount
(@NotNull String principalAmount) setPrincipalAmount
(@NotNull BigDecimal principalAmount) setPrincipalPlusInterest
(@NotNull String principalPlusInterest) setPrincipalPlusInterest
(@NotNull BigDecimal principalPlusInterest) setQuoteDateTime
(@NotNull String quoteDateTime) setQuoteID
(@NotNull String quoteID) setStartDate
(@NotNull String startDate) setStartDate
(@NotNull LocalDate startDate) setStartTenor
(@NotNull String startTenor) setTOBOUser
(@NotNull String tOBOUser) setTradeDate
(@NotNull String tradeDate) setTradeID
(@NotNull String tradeID) setTraderUsername
(@NotNull String traderUsername) setTradingType
(@NotNull String tradingType) @NotNull String
toString()
-
Method Details
-
addField
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value) -
build
-
toString
-
setTOBOUser
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTOBOUser(@NotNull @NotNull String tOBOUser) - Returns:
- The client who the trade is for.
-
setTraderUsername
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTraderUsername(@NotNull @NotNull String traderUsername) - Returns:
- The name of the trader providing the price to the user, or NO_TRADER if there is none.
-
setAccount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAccount(@NotNull @NotNull String account) - Returns:
- The used account for the trade.
-
setAction
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAction(@NotNull @NotNull String action) - Returns:
- Withdraw or deposit for Call Deposit.
-
setCallAccount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCallAccount(@NotNull @NotNull String callAccount) - Returns:
- The account which is being withdrawn from or deposited to.
-
setCurrency
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCurrency(@NotNull @NotNull String currency) - Returns:
- The currency in which the trade is made.
-
setMaturityDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setMaturityDate(@NotNull @NotNull LocalDate maturityDate) - Returns:
- The maturity date of the trade.
-
setMaturityDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setMaturityDate(@NotNull @NotNull String maturityDate) - Returns:
- The maturity date of the trade.
-
setMaturityTenor
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setMaturityTenor(@NotNull @NotNull String maturityTenor) - Returns:
- The maturity tenor of the trade.
-
setStartDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setStartDate(@NotNull @NotNull LocalDate startDate) - Returns:
- The start date of the trade.
-
setStartDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setStartDate(@NotNull @NotNull String startDate) - Returns:
- The start date of the trade.
-
setStartTenor
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setStartTenor(@NotNull @NotNull String startTenor) - Returns:
- The start tenor of the trade.
-
setTradeID
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradeID(@NotNull @NotNull String tradeID) - Returns:
- The unique id identifying the trade.
-
setPrincipalAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPrincipalAmount(@NotNull @NotNull BigDecimal principalAmount) - Returns:
- Principal amount for the trade specified in the provided Currency.
-
setPrincipalAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPrincipalAmount(@NotNull @NotNull String principalAmount) - Returns:
- Principal amount for the trade specified in the provided Currency.
-
setInterestRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestRate(@NotNull @NotNull BigDecimal interestRate) - Returns:
- Interest rate on the given PrincipalAmount.
-
setInterestRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestRate(@NotNull @NotNull String interestRate) - Returns:
- Interest rate on the given PrincipalAmount.
-
setIndicativeProfitRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIndicativeProfitRate(@NotNull @NotNull String indicativeProfitRate) - Returns:
- Indicative profit rate on the given PrincipalAmount.
-
setInterestRateDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestRateDPS(@NotNull @NotNull BigDecimal interestRateDPS) - Returns:
- The precision for a specified InterestRate.
-
setInterestRateDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestRateDPS(@NotNull @NotNull String interestRateDPS) - Returns:
- The precision for a specified InterestRate.
-
setInterestAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestAmount(@NotNull @NotNull BigDecimal interestAmount) - Returns:
- Interest amount (specified in the provided Currency) calculated from the interest rate and principal amount.
-
setInterestAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestAmount(@NotNull @NotNull String interestAmount) - Returns:
- Interest amount (specified in the provided Currency) calculated from the interest rate and principal amount.
-
setPrincipalPlusInterest
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPrincipalPlusInterest(@NotNull @NotNull BigDecimal principalPlusInterest) - Returns:
- Composite amount between principal amount and interest amount.
-
setPrincipalPlusInterest
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPrincipalPlusInterest(@NotNull @NotNull String principalPlusInterest) - Returns:
- Composite amount between principal amount and interest amount.
-
setPaymentFrequency
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPaymentFrequency(@NotNull @NotNull String paymentFrequency) - Returns:
- Interest payment frequencies for term deposits, this could be ZERO-COUPON, MONTHLY, QUARTERLY, SEMI-ANNUALLY or ANNUALLY.
-
setAllocationMode
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAllocationMode(@NotNull @NotNull String allocationMode) - Returns:
- Determines whether the amount will be alLocated to a single or multiple accounts. Supported types are [SINGLE, MULTIPLE] and is defaulted to SINGLE.
-
setNumberOfDays
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNumberOfDays(@NotNull @NotNull String numberOfDays) - Returns:
- The number of days between the start and maturity dates.
-
setExecutionDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setExecutionDateTime(@NotNull @NotNull String executionDateTime) - Parameters:
executionDateTime
- e.g. 20160322123621- Returns:
- executionDateTime
-
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.
-
setTradeDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradeDate(@NotNull @NotNull String tradeDate) - Parameters:
tradeDate
- e.g. 20160314- Returns:
- tradeDate
-
setTradingType
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradingType(@NotNull @NotNull String tradingType) - Returns:
- The type of the trade. Supported types are [LOAN, DEPOSIT, CALL-DEPOSIT, TERM-DEPOSIT, FLEXI-NOTICE-DEPOSIT, TREASURY-BILL or GOVERNMENT-BOND].
-
setQuoteID
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setQuoteID(@NotNull @NotNull String quoteID) - Returns:
- Unique id for a quote, used to determine which quote has been used for trade execution.
-
setQuoteDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setQuoteDateTime(@NotNull @NotNull String quoteDateTime) - Parameters:
quoteDateTime
- e.g. 20160314013000- Returns:
- quoteDateTime
-
setCanAffirm
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanAffirm(boolean canAffirm) - Returns:
- Ability to Affirm the Trade Details are as agreed.
-
setCanAffirm
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanAffirm(@NotNull @NotNull String canAffirm) - Returns:
- Ability to Affirm the Trade Details are as agreed.
-
setDisplayFields
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDisplayFields(@NotNull @NotNull String displayFields) - Parameters:
displayFields
- e.g. method={'import':'static com.caplin.motif.mm.config.DefaultDisplayFields.addDefaultMMTermSummaryDisplayFields','name':'addDefaultMMTermSummaryDisplayFields','comment':'See DefaultDisplayFields javadoc for parameters and available builder methods.'}- Returns:
- Configuration for a frontend to display label-value pairs. Use DefaultDisplayFields builders to provide Caplin default and/or custom fields.
-
setDisplayFields
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDisplayFields(@NotNull @NotNull DisplayFields displayFields) - Parameters:
displayFields
- e.g. method={'import':'static com.caplin.motif.mm.config.DefaultDisplayFields.addDefaultMMTermSummaryDisplayFields','name':'addDefaultMMTermSummaryDisplayFields','comment':'See DefaultDisplayFields javadoc for parameters and available builder methods.'}- Returns:
- Configuration for a frontend to display label-value pairs. Use DefaultDisplayFields builders to provide Caplin default and/or custom fields.
-
setCanCapitalIncrease
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanCapitalIncrease(boolean canCapitalIncrease) - Returns:
- Ability to Capital Increase the Trade amount.
-
setCanCapitalIncrease
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanCapitalIncrease(@NotNull @NotNull String canCapitalIncrease) - Returns:
- Ability to Capital Increase the Trade amount.
-
setCanRollOver
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanRollOver(boolean canRollOver) - Returns:
- Ability to Roll Over the Trade amount.
-
setCanRollOver
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanRollOver(@NotNull @NotNull String canRollOver) - Returns:
- Ability to Roll Over the Trade amount.
-
setCanChangeSSI
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanChangeSSI(boolean canChangeSSI) - Returns:
- Ability to Change the Settlement Instructions.
-
setCanChangeSSI
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanChangeSSI(@NotNull @NotNull String canChangeSSI) - Returns:
- Ability to Change the Settlement Instructions.
-
setCanGiveNotice
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanGiveNotice(boolean canGiveNotice) - Returns:
- Ability to Give notice for Money Market trades.
-
setCanGiveNotice
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanGiveNotice(@NotNull @NotNull String canGiveNotice) - Returns:
- Ability to Give notice for Money Market trades.
-
setHasPostTradeHistory
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setHasPostTradeHistory(boolean hasPostTradeHistory) - Returns:
- Define whether post-trade history (related deals) is available.
-
setHasPostTradeHistory
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setHasPostTradeHistory(@NotNull @NotNull String hasPostTradeHistory) - Returns:
- Define whether post-trade history (related deals) is available.
-
setNoticePeriodDescription
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNoticePeriodDescription(@NotNull @NotNull String noticePeriodDescription) - Parameters:
noticePeriodDescription
- e.g. 32 Days- Returns:
- The notice period description for the trade, sent as the raw display value or a translation token.
-
setNoticePeriod
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNoticePeriod(@NotNull @NotNull String noticePeriod) - Parameters:
noticePeriod
- e.g. 32D- Returns:
- The notice period for the trade.
-
setIsShariaTrade
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsShariaTrade(boolean isShariaTrade) - Parameters:
isShariaTrade
- e.g. true- Returns:
- Indicates whether the trade is a Sharia trade
-
setIsShariaTrade
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIsShariaTrade(@NotNull @NotNull String isShariaTrade) - Parameters:
isShariaTrade
- e.g. true- Returns:
- Indicates whether the trade is a Sharia trade
-
setCanConfirm
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanConfirm(boolean canConfirm) - Returns:
- Ability to Confirm the Settlement Details are now final.
-
setCanConfirm
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanConfirm(@NotNull @NotNull String canConfirm) - Returns:
- Ability to Confirm the Settlement Details are now final.
-
setConfirmedBy
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setConfirmedBy(@NotNull @NotNull String confirmedBy) - Returns:
- The name of the user who confirmed 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.
-
setConfirmedDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setConfirmedDateTime(@NotNull @NotNull Instant confirmedDateTime) - Parameters:
confirmedDateTime
- e.g. 2018-03-16T07:25:16+00:00- Returns:
- The time at which a trade was confirmed in ISO-8601 format
-
setConfirmedDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setConfirmedDateTime(@NotNull @NotNull String confirmedDateTime) - Parameters:
confirmedDateTime
- e.g. 2018-03-16T07:25:16+00:00- Returns:
- The time at which a trade was confirmed in ISO-8601 format
-