Class TradeConfPartsDef.LegTradeConfirmationFields.Builder
- java.lang.Object
-
- com.caplin.generated.motif.fx.tradeconfirmation.TradeConfPartsDef.LegTradeConfirmationFields.Builder
-
- Enclosing class:
- TradeConfPartsDef.LegTradeConfirmationFields
public static final class TradeConfPartsDef.LegTradeConfirmationFields.Builder extends java.lang.Object
-
-
Method Summary
-
-
-
Method Detail
-
addField
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder addField(@NotNull @NotNull java.lang.String key, @NotNull @NotNull java.lang.String value)
-
build
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields build()
-
toString
@NotNull public @NotNull java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
setAllInRate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInRate(@NotNull @NotNull java.math.BigDecimal allInRate)
- Parameters:
allInRate
- e.g. 1.091790- Returns:
- allInRate
-
setAllInRate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInRate(@NotNull @NotNull java.lang.String allInRate)
- Parameters:
allInRate
- e.g. 1.091790- Returns:
- allInRate
-
setAllInRateDPS
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInRateDPS(int allInRateDPS)
- Parameters:
allInRateDPS
- e.g. 5- Returns:
- The number of decimal places to display after the decimal point.
-
setAllInRateDPS
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInRateDPS(@NotNull @NotNull java.lang.String allInRateDPS)
- Parameters:
allInRateDPS
- e.g. 5- Returns:
- The number of decimal places to display after the decimal point.
-
setAllInMidRate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInMidRate(@NotNull @NotNull java.math.BigDecimal allInMidRate)
- Parameters:
allInMidRate
- e.g. 1.091790- Returns:
- The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
-
setAllInMidRate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllInMidRate(@NotNull @NotNull java.lang.String allInMidRate)
- Parameters:
allInMidRate
- e.g. 1.091790- Returns:
- The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
-
setFwdPoints
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdPoints(@NotNull @NotNull java.math.BigDecimal fwdPoints)
- Parameters:
fwdPoints
- e.g. 0.001198- Returns:
- fwdPoints
-
setFwdPoints
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdPoints(@NotNull @NotNull java.lang.String fwdPoints)
- Parameters:
fwdPoints
- e.g. 0.001198- Returns:
- fwdPoints
-
setFwdMidPoints
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdMidPoints(@NotNull @NotNull java.math.BigDecimal fwdMidPoints)
- Parameters:
fwdMidPoints
- e.g. 0.005390- Returns:
- The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.
-
setFwdMidPoints
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdMidPoints(@NotNull @NotNull java.lang.String fwdMidPoints)
- Parameters:
fwdMidPoints
- e.g. 0.005390- Returns:
- The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.
-
setFwdPips
@Deprecated @NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFwdPips(@NotNull @NotNull java.lang.String fwdPips)
Deprecated.- Parameters:
fwdPips
- e.g. 11.98- Returns:
- fwdPips
-
setBuySell
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setBuySell(@NotNull @NotNull java.lang.String buySell)
- Returns:
- The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
-
setAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmount(@NotNull @NotNull java.math.BigDecimal amount, boolean isEditable, boolean isRisk)
- Returns:
- The amount of a trade or order in the DealtCurrency.
-
setAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmount(@NotNull @NotNull java.math.BigDecimal amount)
- Returns:
- The amount of a trade or order in the DealtCurrency.
-
setAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmount(@NotNull @NotNull java.lang.String amount, boolean isEditable, boolean isRisk)
- Returns:
- The amount of a trade or order in the DealtCurrency.
-
setAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmount(@NotNull @NotNull java.lang.String amount)
- Returns:
- The amount of a trade or order in the DealtCurrency.
-
setAmountEditable
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmountEditable()
-
setAmountRisk
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAmountRisk()
-
setContraAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraAmount(@NotNull @NotNull java.math.BigDecimal contraAmount)
- Parameters:
contraAmount
- e.g. 350- Returns:
- The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.
-
setContraAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraAmount(@NotNull @NotNull java.lang.String contraAmount)
- Parameters:
contraAmount
- e.g. 350- Returns:
- The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.
-
setTenor
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setTenor(@NotNull @NotNull java.lang.String tenor, boolean isEditable, boolean isRisk)
- Parameters:
tenor
- e.g. 1M- Returns:
- Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. broken indicates that a SettlementDate must be sent
-
setTenor
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setTenor(@NotNull @NotNull java.lang.String tenor)
- Parameters:
tenor
- e.g. 1M- Returns:
- Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. broken indicates that a SettlementDate must be sent
-
setTenorEditable
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setTenorEditable()
-
setTenorRisk
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setTenorRisk()
-
setSettlementDate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setSettlementDate(@NotNull @NotNull java.lang.String settlementDate, boolean isEditable, boolean isRisk)
- Returns:
- settlementDate
-
setSettlementDate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setSettlementDate(@NotNull @NotNull java.lang.String settlementDate)
- Returns:
- settlementDate
-
setSettlementDateEditable
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setSettlementDateEditable()
-
setSettlementDateRisk
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setSettlementDateRisk()
-
setFilledAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFilledAmount(@NotNull @NotNull java.math.BigDecimal filledAmount)
- Parameters:
filledAmount
- e.g. 0- Returns:
- filledAmount
-
setFilledAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFilledAmount(@NotNull @NotNull java.lang.String filledAmount)
- Parameters:
filledAmount
- e.g. 0- Returns:
- filledAmount
-
setRemainingAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setRemainingAmount(@NotNull @NotNull java.math.BigDecimal remainingAmount)
- Parameters:
remainingAmount
- e.g. 500- Returns:
- remainingAmount
-
setRemainingAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setRemainingAmount(@NotNull @NotNull java.lang.String remainingAmount)
- Parameters:
remainingAmount
- e.g. 500- Returns:
- remainingAmount
-
setRiskDate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setRiskDate(@NotNull @NotNull java.lang.String riskDate)
- Parameters:
riskDate
- e.g. 20160314- Returns:
- The date in the settlement window which yields the lowest client sell price, or the highest client buy price.
-
setRiskTenor
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setRiskTenor(@NotNull @NotNull java.lang.String riskTenor)
- Parameters:
riskTenor
- e.g. 1W- Returns:
- The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.
-
setStartDate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setStartDate(@NotNull @NotNull java.lang.String startDate, boolean isRisk)
- Parameters:
startDate
- e.g. 20150620- Returns:
- startDate
-
setStartDate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setStartDate(@NotNull @NotNull java.lang.String startDate)
- Parameters:
startDate
- e.g. 20150620- Returns:
- startDate
-
setStartDateRisk
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setStartDateRisk()
-
setStartTenor
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setStartTenor(@NotNull @NotNull java.lang.String startTenor, boolean isRisk)
- Parameters:
startTenor
- e.g. 1W- Returns:
- startTenor
-
setStartTenor
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setStartTenor(@NotNull @NotNull java.lang.String startTenor)
- Parameters:
startTenor
- e.g. 1W- Returns:
- startTenor
-
setStartTenorRisk
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setStartTenorRisk()
-
setIsTimeOption
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setIsTimeOption(boolean isTimeOption)
- Parameters:
isTimeOption
- e.g. true- Returns:
- true if a leg is time-option
-
setIsTimeOption
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setIsTimeOption(@NotNull @NotNull java.lang.String isTimeOption)
- Parameters:
isTimeOption
- e.g. true- Returns:
- true if a leg is time-option
-
setAccount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAccount(@NotNull @NotNull java.lang.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>
-
setProfit
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setProfit(@NotNull @NotNull java.math.BigDecimal profit)
- Parameters:
profit
- e.g. 1000- Returns:
- The sales profit in the specified currency.
-
setProfit
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setProfit(@NotNull @NotNull java.lang.String profit)
- Parameters:
profit
- e.g. 1000- Returns:
- The sales profit in the specified currency.
-
setCostAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setCostAmount(@NotNull @NotNull java.math.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.LegTradeConfirmationFields.Builder setCostAmount(@NotNull @NotNull java.lang.String costAmount)
- Parameters:
costAmount
- e.g. 12412891.31- Returns:
- The actual transactional cost of performing the trade to the client in the home currency
-
setEntityId
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.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.LegTradeConfirmationFields.Builder setEntityDescription(@NotNull @NotNull java.lang.String entityDescription)
- Parameters:
entityDescription
- e.g. Customer 1- Returns:
- The description of a trade on behalf of entity.
-
setCostCurrency
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setCostCurrency(@NotNull @NotNull java.lang.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
-
setCostPercentage
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setCostPercentage(@NotNull @NotNull java.math.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.LegTradeConfirmationFields.Builder setCostPercentage(@NotNull @NotNull java.lang.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.LegTradeConfirmationFields.Builder setContraCostAmount(@NotNull @NotNull java.math.BigDecimal contraCostAmount)
- Returns:
- The actual transactional cost of performing the trade to the client on the contra currency
-
setContraCostAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraCostAmount(@NotNull @NotNull java.lang.String contraCostAmount)
- Returns:
- The actual transactional cost of performing the trade to the client on the contra currency
-
setContraCostCurrency
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraCostCurrency(@NotNull @NotNull java.math.BigDecimal contraCostCurrency)
- Returns:
- The contra currency that the cost is displayed in
-
setContraCostCurrency
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraCostCurrency(@NotNull @NotNull java.lang.String contraCostCurrency)
- Returns:
- The contra currency that the cost is displayed in
-
setContraCostPercentage
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setContraCostPercentage(@NotNull @NotNull java.math.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.LegTradeConfirmationFields.Builder setContraCostPercentage(@NotNull @NotNull java.lang.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%.
-
setTOBOUser
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setTOBOUser(@NotNull @NotNull java.lang.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.LegTradeConfirmationFields.Builder setTOBOUser(@NotNull @NotNull java.lang.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.LegTradeConfirmationFields.Builder setTOBOUserEditable()
-
setTOBOUserRisk
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setTOBOUserRisk()
-
setFullName
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setFullName(@NotNull @NotNull java.lang.String fullName)
- Returns:
- The full name of the user the trade is on behalf of
-
setForwardPointsDecimalOffset
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setForwardPointsDecimalOffset(int forwardPointsDecimalOffset)
- Parameters:
forwardPointsDecimalOffset
- e.g. 4- Returns:
- Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.
-
setForwardPointsDecimalOffset
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setForwardPointsDecimalOffset(@NotNull @NotNull java.lang.String forwardPointsDecimalOffset)
- Parameters:
forwardPointsDecimalOffset
- e.g. 4- Returns:
- Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.
-
setAllocatableAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllocatableAmount(@NotNull @NotNull java.math.BigDecimal allocatableAmount)
- Parameters:
allocatableAmount
- e.g. 500- Returns:
- This is the amount that can be allocated or rolled.
-
setAllocatableAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllocatableAmount(@NotNull @NotNull java.lang.String allocatableAmount)
- Parameters:
allocatableAmount
- e.g. 500- Returns:
- This is the amount that can be allocated or rolled.
-
setAllocatableContraAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllocatableContraAmount(@NotNull @NotNull java.math.BigDecimal allocatableContraAmount)
- Parameters:
allocatableContraAmount
- e.g. 500- Returns:
- This is the amount that can be allocated or rolled, defined in the contra currency of the DealtCurrency
-
setAllocatableContraAmount
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAllocatableContraAmount(@NotNull @NotNull java.lang.String allocatableContraAmount)
- Parameters:
allocatableContraAmount
- e.g. 500- Returns:
- This is the amount that can be allocated or rolled, defined in the contra currency of the DealtCurrency
-
setOriginalRate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setOriginalRate(@NotNull @NotNull java.math.BigDecimal originalRate)
- Returns:
- The Rate of the trade that this trade was created from.
-
setOriginalRate
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setOriginalRate(@NotNull @NotNull java.lang.String originalRate)
- Returns:
- The Rate of the trade that this trade was created from.
-
setAdjustedSwapPoints
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAdjustedSwapPoints(@NotNull @NotNull java.math.BigDecimal adjustedSwapPoints)
- Returns:
- The swap points adjusted for this repriced trade
-
setAdjustedSwapPoints
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setAdjustedSwapPoints(@NotNull @NotNull java.lang.String adjustedSwapPoints)
- Returns:
- The swap points adjusted for this repriced trade
-
setSettlementTradeFields
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setSettlementTradeFields(@NotNull SettlementInstructionsPartsDef.SettlementTradeFields settlementTradeFields)
- Returns:
- settlementTradeFields
-
setNostroAccountFields
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setNostroAccountFields(@NotNull SettlementInstructionsPartsDef.NostroAccount nostroAccountFields)
- Returns:
- nostroAccountFields
-
addRemarks
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder addRemarks(@NotNull @NotNull TradeConfPartsDef.RemarksEntry remarks)
- Returns:
- remarks
-
setRemarks
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder setRemarks(@NotNull @NotNull TradeConfPartsDef.RemarksEntry remarks, int id)
- Returns:
- remarks
-
addAllRemarks
@NotNull public @NotNull TradeConfPartsDef.LegTradeConfirmationFields.Builder addAllRemarks(@NotNull @NotNull java.util.Collection<TradeConfPartsDef.RemarksEntry> remarks)
- Returns:
- remarks
-
-