Package com.caplin.generated.motif.mm.tradeconfirmation

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

Modifier and Type	Method	Description
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	addField(@NotNull java.lang.String key, @NotNull java.lang.String value)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields	build()
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setAccount(@NotNull java.lang.String account)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setAction(@NotNull java.lang.String action)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setAllocationMode(@NotNull java.lang.String allocationMode)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCallAccount(@NotNull java.lang.String callAccount)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanAffirm(boolean canAffirm)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanAffirm(@NotNull java.lang.String canAffirm)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanCapitalIncrease(boolean canCapitalIncrease)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanCapitalIncrease(@NotNull java.lang.String canCapitalIncrease)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanChangeSSI(boolean canChangeSSI)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanChangeSSI(@NotNull java.lang.String canChangeSSI)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanConfirm(boolean canConfirm)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanConfirm(@NotNull java.lang.String canConfirm)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanGiveNotice(boolean canGiveNotice)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanGiveNotice(@NotNull java.lang.String canGiveNotice)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCurrency(@NotNull java.lang.String currency)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setDisplayFields(@NotNull DisplayFields displayFields)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setDisplayFields(@NotNull java.lang.String displayFields)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setEntityDescription(@NotNull java.lang.String entityDescription)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setEntityId(@NotNull java.lang.String entityId)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setExecutionDateTime(@NotNull java.lang.String executionDateTime)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setIndicativeProfitRate(@NotNull java.lang.String indicativeProfitRate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setInterestAmount(@NotNull java.lang.String interestAmount)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setInterestAmount(@NotNull java.math.BigDecimal interestAmount)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setInterestRate(@NotNull java.lang.String interestRate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setInterestRate(@NotNull java.math.BigDecimal interestRate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setInterestRateDPS(@NotNull java.lang.String interestRateDPS)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setInterestRateDPS(@NotNull java.math.BigDecimal interestRateDPS)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setIsShariaTrade(boolean isShariaTrade)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setIsShariaTrade(@NotNull java.lang.String isShariaTrade)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setMaturityDate(@NotNull java.lang.String maturityDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setMaturityDate(@NotNull java.time.LocalDate maturityDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setMaturityTenor(@NotNull java.lang.String maturityTenor)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setNoticePeriod(@NotNull java.lang.String noticePeriod)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setNoticePeriodDescription(@NotNull java.lang.String noticePeriodDescription)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setNumberOfDays(@NotNull java.lang.String numberOfDays)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setPaymentFrequency(@NotNull java.lang.String paymentFrequency)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setPrincipalAmount(@NotNull java.lang.String principalAmount)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setPrincipalAmount(@NotNull java.math.BigDecimal principalAmount)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setPrincipalPlusInterest(@NotNull java.lang.String principalPlusInterest)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setPrincipalPlusInterest(@NotNull java.math.BigDecimal principalPlusInterest)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setQuoteDateTime(@NotNull java.lang.String quoteDateTime)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setQuoteID(@NotNull java.lang.String quoteID)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setStartDate(@NotNull java.lang.String startDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setStartDate(@NotNull java.time.LocalDate startDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setStartTenor(@NotNull java.lang.String startTenor)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTOBOUser(@NotNull java.lang.String tOBOUser)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTradeDate(@NotNull java.lang.String tradeDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTradeID(@NotNull java.lang.String tradeID)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTraderUsername(@NotNull java.lang.String traderUsername)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTradingType(@NotNull java.lang.String tradingType)
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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 class java.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.

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.