Class TradeConfPartsDef.CommonTradeConfirmationFields.Builder
- java.lang.Object
-
- com.caplin.generated.motif.mm.tradeconfirmation.TradeConfPartsDef.CommonTradeConfirmationFields.Builder
-
- Enclosing class:
- TradeConfPartsDef.CommonTradeConfirmationFields
public static final class TradeConfPartsDef.CommonTradeConfirmationFields.Builder extends java.lang.Object
-
-
Method Summary
-
-
-
Method Detail
-
addField
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder addField(@NotNull @NotNull java.lang.String key, @NotNull @NotNull java.lang.String value)
-
build
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields build()
-
toString
@NotNull public @NotNull java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
setTOBOUser
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTOBOUser(@NotNull @NotNull java.lang.String tOBOUser)
- Returns:
- The client who the trade is for.
-
setTraderUsername
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTraderUsername(@NotNull @NotNull java.lang.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 java.lang.String account)
- Returns:
- The used account for the trade.
-
setAction
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAction(@NotNull @NotNull java.lang.String action)
- Returns:
- Withdraw or deposit for Call Deposit.
-
setCallAccount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCallAccount(@NotNull @NotNull java.lang.String callAccount)
- Returns:
- The account which is being withdrawn from or deposited to.
-
setCurrency
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCurrency(@NotNull @NotNull java.lang.String currency)
- Returns:
- The currency in which the trade is made.
-
setMaturityDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setMaturityDate(@NotNull @NotNull java.time.LocalDate maturityDate)
- Returns:
- The maturity date of the trade.
-
setMaturityDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setMaturityDate(@NotNull @NotNull java.lang.String maturityDate)
- Returns:
- The maturity date of the trade.
-
setMaturityTenor
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setMaturityTenor(@NotNull @NotNull java.lang.String maturityTenor)
- Returns:
- The maturity tenor of the trade.
-
setStartDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setStartDate(@NotNull @NotNull java.time.LocalDate startDate)
- Returns:
- The start date of the trade.
-
setStartDate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setStartDate(@NotNull @NotNull java.lang.String startDate)
- Returns:
- The start date of the trade.
-
setStartTenor
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setStartTenor(@NotNull @NotNull java.lang.String startTenor)
- Returns:
- The start tenor of the trade.
-
setTradeID
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradeID(@NotNull @NotNull java.lang.String tradeID)
- Returns:
- The unique id identifying the trade.
-
setPrincipalAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPrincipalAmount(@NotNull @NotNull java.math.BigDecimal principalAmount)
- Returns:
- Principal amount for the trade specified in the provided Currency.
-
setPrincipalAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPrincipalAmount(@NotNull @NotNull java.lang.String principalAmount)
- Returns:
- Principal amount for the trade specified in the provided Currency.
-
setInterestRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestRate(@NotNull @NotNull java.math.BigDecimal interestRate)
- Returns:
- Interest rate on the given PrincipalAmount.
-
setInterestRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestRate(@NotNull @NotNull java.lang.String interestRate)
- Returns:
- Interest rate on the given PrincipalAmount.
-
setIndicativeProfitRate
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setIndicativeProfitRate(@NotNull @NotNull java.lang.String indicativeProfitRate)
- Returns:
- Indicative profit rate on the given PrincipalAmount.
-
setInterestRateDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestRateDPS(@NotNull @NotNull java.math.BigDecimal interestRateDPS)
- Returns:
- The precision for a specified InterestRate.
-
setInterestRateDPS
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestRateDPS(@NotNull @NotNull java.lang.String interestRateDPS)
- Returns:
- The precision for a specified InterestRate.
-
setInterestAmount
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setInterestAmount(@NotNull @NotNull java.math.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 java.lang.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 java.math.BigDecimal principalPlusInterest)
- Returns:
- Composite amount between principal amount and interest amount.
-
setPrincipalPlusInterest
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPrincipalPlusInterest(@NotNull @NotNull java.lang.String principalPlusInterest)
- Returns:
- Composite amount between principal amount and interest amount.
-
setPaymentFrequency
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPaymentFrequency(@NotNull @NotNull java.lang.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 java.lang.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 java.lang.String numberOfDays)
- Returns:
- The number of days between the start and maturity dates.
-
setExecutionDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setExecutionDateTime(@NotNull @NotNull java.lang.String executionDateTime)
- Parameters:
executionDateTime
- e.g. 20160322123621- Returns:
- executionDateTime
-
setEntityId
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setEntityId(@NotNull @NotNull java.lang.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 java.lang.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 java.lang.String tradeDate)
- Parameters:
tradeDate
- e.g. 20160314- Returns:
- tradeDate
-
setTradingType
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradingType(@NotNull @NotNull java.lang.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 java.lang.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 java.lang.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 java.lang.String canAffirm)
- Returns:
- Ability to Affirm the Trade Details are as agreed.
-
setDisplayFields
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDisplayFields(@NotNull @NotNull java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String canGiveNotice)
- Returns:
- Ability to Give notice for Money Market trades.
-
setNoticePeriodDescription
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNoticePeriodDescription(@NotNull @NotNull java.lang.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 java.lang.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 java.lang.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 java.lang.String canConfirm)
- Returns:
- Ability to Confirm the Settlement Details are now final.
-
setConfirmedBy
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setConfirmedBy(@NotNull @NotNull java.lang.String confirmedBy)
- Returns:
- The name of the user who confirmed a trade.
-
setConfirmedDateTime
@NotNull public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setConfirmedDateTime(@NotNull @NotNull java.time.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 java.lang.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
-
-