Package com.caplin.motif.fx.config
Class DefaultDisplayFields
- java.lang.Object
-
- com.caplin.motif.fx.config.DefaultDisplayFields
-
public final class DefaultDisplayFields extends java.lang.Object
Static builder methods to build standard DisplayField items
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static DisplayFields
addAccount(DisplayFields displayFields, java.lang.String account)
Adds the Account field to your display-fields configurationstatic DisplayFields
addAllInRate(DisplayFields DisplayFields, FormattedRate allInRate)
Adds the All-In-Rate field to your display-fields configurationstatic DisplayFields
addAmount(DisplayFields displayFields, FormattedAmount amount)
Adds the Amount field to your display-fields configurationstatic DisplayFields
addAmountWithBuySell(DisplayFields DisplayFields, FormattedAmount amount, java.lang.String buySell)
Adds the Amount field to your display-fields configurationstatic DisplayFields
addClient(DisplayFields displayFields, java.lang.String entityDescription, java.lang.String fullName)
Adds the Client field to your display-fields configurationstatic DisplayFields
addClientSpotRate(DisplayFields displayFields, FormattedRate clientSpotRate)
Adds the Client Spot Rate field to your display-fields configurationstatic DisplayFields
addContraAmount(DisplayFields displayFields, FormattedAmount contraAmount)
Adds the Contra Amount field to your display-fields configurationstatic DisplayFields
addCurrencyPair(DisplayFields displayFields, java.lang.String currencyPair)
Adds the Currency Pair field to your display-fields configurationstatic DisplayFields
addDate(DisplayFields displayFields, java.time.LocalDate date)
Adds a Date field to your display-fields configurationstatic DisplayFields
addDefaultAllocationConfirmationFields(DisplayFields displayFields, java.lang.String entityDescription, java.lang.String fullName, java.lang.String currencyPair, java.time.LocalDate executionDate, java.time.Instant executionDateTime, FormattedRate spotRate, java.lang.Integer totalDeals, FormattedAmount profit)
Adds the default display fields for an Allocation confirmation message: - Client - Currency Pair - Date - Time - Spot Rate - Total Deals - Estimated Profitstatic DisplayFields
addDefaultAllocationDetailsUpdateFields(DisplayFields displayFields, FormattedAmount originalAmount, FormattedAmount originalContraAmount, java.lang.String currencyPair, java.time.LocalDate originalSettlementDate, java.lang.String originalTenor, java.lang.String originalAccount, FormattedRate originalRate)
Adds the default deliverable deal display fields for an Allocation details-update message: - Original Amount - Original Contra - Currency Pair - Settlement - Account - Original Ratestatic DisplayFields
addDefaultAllocationDetailsUpdateFields(DisplayFields displayFields, FormattedAmount originalAmount, FormattedAmount originalContraAmount, java.lang.String currencyPair, java.time.LocalDate originalSettlementDate, java.lang.String originalTenor, java.lang.String originalAccount, FormattedRate originalRate, java.time.LocalDate fixingDate)
Adds the default display fields for an Allocation details-update message: - Original Amount - Original Contra - Currency Pair - Settlement - Original Fixing Date (if non-deliverable) - Account - Original Ratestatic DisplayFields
addDefaultPostTradeHistoryFields(DisplayFields displayFields, FormattedAmount originalAmount, java.time.LocalDate settlementDate, java.lang.String settlementTenor, FormattedAmount remainingAmount)
Adds the post trade history fields to your display fields configurationstatic DisplayFields
addDefaultSalesAllocationConfirmationFields(DisplayFields displayFields, java.lang.String entityDescription, java.lang.String fullName, java.lang.String currencyPair, java.time.LocalDate executionDate, java.time.Instant executionDateTime, FormattedRate traderSpotRate, FormattedPoints spotMargin, FormattedRate clientSpotRate, java.lang.Integer totalDeals, FormattedAmount profit)
Adds the default deliverable deal display fields for a Sales Allocation confirmation message: - Client - Currency Pair - Execution Date Time - Trader Spot Rate - Spot Margin - Client Spot Rate - Total Deals - Estimated Profitstatic DisplayFields
addDefaultSalesAllocationConfirmationFields(DisplayFields displayFields, java.lang.String entityDescription, java.lang.String fullName, java.lang.String currencyPair, java.time.LocalDate executionDate, java.time.Instant executionDateTime, FormattedRate traderSpotRate, FormattedPoints spotMargin, FormattedRate clientSpotRate, java.lang.Integer totalDeals, FormattedAmount profit, java.lang.String settlementCurrency, java.lang.String fixingSource)
Adds the default display fields for a Sales Allocation confirmation message: - Client - Currency Pair - Settlement Currency (if non-deliverable) - Fixing Source (if non-deliverable) - Date - Time - Trader Spot Rate - Spot Margin - Client Spot Rate - Total Deals - Estimated Profitstatic DisplayFields
addDefaultSalesAllocationDetailsUpdateFields(DisplayFields displayFields, FormattedAmount originalAmount, FormattedAmount originalContraAmount, java.lang.String currencyPair, java.time.LocalDate originalSettlementDate, java.lang.String originalTenor, java.lang.String originalAccount, FormattedRate originalRate)
Adds the default deliverable deal display fields for a Sales Allocation details-update message: - Original Amount - Original Contra - Currency Pair - Settlement - Account - Original Ratestatic DisplayFields
addDefaultSalesAllocationDetailsUpdateFields(DisplayFields displayFields, FormattedAmount originalAmount, FormattedAmount originalContraAmount, java.lang.String currencyPair, java.time.LocalDate originalSettlementDate, java.lang.String originalTenor, java.lang.String originalAccount, FormattedRate originalRate, java.time.LocalDate fixingDate, java.lang.String settlementCurrency, java.lang.String fixingSource)
Adds the default display fields for a Sales Allocation details-update message: - Amount - Contra Amount - Currency Pair - Settlement Currency (if non-deliverable) - Settlement - Fixing Date (if non-deliverable) - Fixing Source (if non-deliverable) - Account - Original Ratestatic DisplayFields
addEndDate(DisplayFields DisplayFields, java.time.LocalDate endDate)
Adds the End date field to your display-fields configurationstatic DisplayFields
addEstimatedProfit(DisplayFields displayFields, FormattedAmount profit)
Adds the Estimated Profit field to your display-fields configurationstatic DisplayFields
addExecutionDateTime(DisplayFields DisplayFields, java.time.Instant executionDateTime)
Adds the Execution time field to your display-fields configurationstatic DisplayFields
addFixingDate(DisplayFields displayFields, java.time.LocalDate date)
Adds the Fixing Date field to your display-fields configurationstatic DisplayFields
addFixingSource(DisplayFields displayFields, java.lang.String fixingSource)
Adds the Fixing Source field to your display-fields configurationstatic DisplayFields
addForwardMidPoints(DisplayFields DisplayFields, FormattedPoints midPoints)
Adds the Mid Points field to your display-fields configurationstatic DisplayFields
addForwardPoints(DisplayFields DisplayFields, FormattedPoints forwardPoints)
Adds the Forward Points field to your display-fields configurationstatic DisplayFields
addGeneralOutrightFields(DisplayFields DisplayFields, java.lang.String account, java.lang.String tradeID, java.time.Instant executionDateTime, java.lang.String currencyPair, java.lang.String user)
Adds the leg independent display fields for an outright tradestatic DisplayFields
addGenericFwdLegFields(DisplayFields displayFields, BuySell buySell, FormattedAmount amount, FormattedAmount contraAmount, FormattedPoints forwardPoints, FormattedPoints forwardMidPoints)
Adds generic fwd leg fields (look at other adders to see what it can be combined with):static DisplayFields
addNdfLegFields(DisplayFields displayFields, java.time.LocalDate fixingDate)
adds ndf specific leg fields can be used with addOtherFwdLegFields and addGenericFwdLegFields to create ndf leg fieldsstatic DisplayFields
addOriginalAmount(DisplayFields displayFields, FormattedAmount originalAmount)
Adds the Original Amount field to your display-fields configurationstatic DisplayFields
addOriginalSettlement(DisplayFields displayFields, java.time.LocalDate date, java.lang.String tenor)
Adds the Original Settlement field to your display-fields configurationstatic DisplayFields
addOtherFwdLegFields(DisplayFields displayFields, FormattedRate spotRate, FormattedRate spotMidRate, FormattedRate allInRate, java.time.LocalDate settlementDate, java.lang.String settlementTenor)
adds fwd specific leg fields use with addGenericFwdLegFields to create fwd leg fieldsstatic DisplayFields
addRate(DisplayFields displayFields, FormattedRate rate)
Adds the Rate field to your display-fields configurationstatic DisplayFields
addRemainingAmount(DisplayFields displayFields, FormattedAmount remainingAmount)
Adds the Remaining Amount field to your display-fields configurationstatic DisplayFields
addSettlement(DisplayFields displayFields, java.time.LocalDate date, java.lang.String tenor)
Adds the Settlement field to your display-fields configurationstatic DisplayFields
addSettlementCurrency(DisplayFields displayFields, java.lang.String currency)
Adds the Settlement Currency field to your display-fields configurationstatic DisplayFields
addSpotMargin(DisplayFields displayFields, FormattedPoints spotMargin)
Adds the Spot Margin field to your display-fields configurationstatic DisplayFields
addSpotMidRate(DisplayFields DisplayFields, FormattedRate spotMidRate)
Adds the Mid Spot-Rate field to your display-fields configurationstatic DisplayFields
addSpotRate(DisplayFields displayFields, FormattedRate spotRate)
Adds the Spot Rate field to your display-fields configurationstatic DisplayFields
addSpotTradeDetailsFields(DisplayFields displayFields, BuySell buySell, FormattedAmount amount, FormattedAmount contraAmount, FormattedRate spotRate, FormattedRate spotMidRate, java.time.LocalDate settlementDate, java.lang.String settlementTenor)
Adds spot trade leg fieldsstatic DisplayFields
addStartDate(DisplayFields DisplayFields, java.time.LocalDate startDate)
Adds the Start date field to your display-fields configurationstatic DisplayFields
addSubmittedBy(DisplayFields DisplayFields, java.lang.String user)
Adds the Submitted by field to your display-fields configurationstatic DisplayFields
addSwapLegFields(DisplayFields displayFields, FormattedRate allInRate, java.time.LocalDate settlementDate, java.lang.String settlementTenor)
Adds swap specific leg fields use with addGenericFwdLegFields to create a set of swap leg fieldsstatic DisplayFields
addSwapMidPoints(DisplayFields DisplayFields, FormattedPoints swapMidPoints)
Adds the Mid Swap Points field to your display-fields configurationstatic DisplayFields
addSwapPoints(DisplayFields DisplayFields, FormattedPoints swapPoints)
Adds the Swap Points field to your display-fields configurationstatic DisplayFields
addSwapSpotFields(DisplayFields displayFields, FormattedRate spotRate, FormattedRate spotMidRate, FormattedPoints swapPoints, FormattedPoints swapMidPoints)
Adds swap specific leg independent fieldsstatic DisplayFields
addTime(DisplayFields displayFields, java.time.Instant time)
Adds a Time field to your display-fields configurationstatic DisplayFields
addTimeOptionFields(DisplayFields displayFields, FormattedRate spotRate, FormattedRate spotMidRate, java.time.LocalDate startDate, java.time.LocalDate endDate)
adds time option specific leg fields can be used with addGenericFwdLegFields to create time option leg fieldsstatic DisplayFields
addTotalDeals(DisplayFields displayFields, int totalDeals)
Adds the Total Deals field to your display-fields configurationstatic DisplayFields
addTradeID(DisplayFields DisplayFields, java.lang.String tradeID)
Adds the Trade ID field to your display-fields configurationstatic DisplayFields
addTraderSpotRate(DisplayFields displayFields, FormattedRate traderSpotRate)
Adds the Trader Spot Rate field to your display-fields configuration
-
-
-
Method Detail
-
addClient
public static DisplayFields addClient(DisplayFields displayFields, java.lang.String entityDescription, java.lang.String fullName)
Adds the Client field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field toentityDescription
- The display name of the TOBO client's entity, e.g. "Caplin Systems Ltd"fullName
- The display name of the TOBO client, e.g. "John Smith"
-
addCurrencyPair
public static DisplayFields addCurrencyPair(DisplayFields displayFields, java.lang.String currencyPair)
Adds the Currency Pair field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field tocurrencyPair
- The base and term currency e.g. GBPUSD
-
addSettlementCurrency
public static DisplayFields addSettlementCurrency(DisplayFields displayFields, java.lang.String currency)
Adds the Settlement Currency field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field tocurrency
- The settlement currency of a non-deliverable deal, e.g. GBP
-
addDate
public static DisplayFields addDate(DisplayFields displayFields, java.time.LocalDate date)
Adds a Date field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field todate
- Date
-
addTime
public static DisplayFields addTime(DisplayFields displayFields, java.time.Instant time)
Adds a Time field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field totime
- Time instant
-
addTraderSpotRate
public static DisplayFields addTraderSpotRate(DisplayFields displayFields, FormattedRate traderSpotRate)
Adds the Trader Spot Rate field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field totraderSpotRate
- The trader spot rate
-
addSpotMargin
public static DisplayFields addSpotMargin(DisplayFields displayFields, FormattedPoints spotMargin)
Adds the Spot Margin field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field tospotMargin
- The spot margin
-
addClientSpotRate
public static DisplayFields addClientSpotRate(DisplayFields displayFields, FormattedRate clientSpotRate)
Adds the Client Spot Rate field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field toclientSpotRate
- The client spot rate, e.g. 1.23456
-
addSpotRate
public static DisplayFields addSpotRate(DisplayFields displayFields, FormattedRate spotRate)
Adds the Spot Rate field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field tospotRate
- The (client) spot rate, e.g. 1.23456
-
addTotalDeals
public static DisplayFields addTotalDeals(DisplayFields displayFields, int totalDeals)
Adds the Total Deals field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field tototalDeals
- The number of deals included in the confirmation, e.g. for an allocation or reprice.
-
addEstimatedProfit
public static DisplayFields addEstimatedProfit(DisplayFields displayFields, FormattedAmount profit)
Adds the Estimated Profit field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field toprofit
- The profit amount
-
addAmount
public static DisplayFields addAmount(DisplayFields displayFields, FormattedAmount amount)
Adds the Amount field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field toamount
- The amount
-
addOriginalAmount
public static DisplayFields addOriginalAmount(DisplayFields displayFields, FormattedAmount originalAmount)
Adds the Original Amount field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field tooriginalAmount
- The original amount
-
addRemainingAmount
public static DisplayFields addRemainingAmount(DisplayFields displayFields, FormattedAmount remainingAmount)
Adds the Remaining Amount field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field toremainingAmount
- The remaining amount
-
addContraAmount
public static DisplayFields addContraAmount(DisplayFields displayFields, FormattedAmount contraAmount)
Adds the Contra Amount field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field tocontraAmount
- The contra amount
-
addSettlement
public static DisplayFields addSettlement(DisplayFields displayFields, java.time.LocalDate date, @Nullable java.lang.String tenor)
Adds the Settlement field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field todate
- The settlement datetenor
- Optional tenor, to be displayed in brackets after the settlement date
-
addOriginalSettlement
public static DisplayFields addOriginalSettlement(DisplayFields displayFields, java.time.LocalDate date, @Nullable java.lang.String tenor)
Adds the Original Settlement field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field todate
- The original settlement datetenor
- Optional tenor, to be displayed in brackets after the settlement date
-
addFixingDate
public static DisplayFields addFixingDate(DisplayFields displayFields, java.time.LocalDate date)
Adds the Fixing Date field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field todate
- The fixing date
-
addFixingSource
public static DisplayFields addFixingSource(DisplayFields displayFields, java.lang.String fixingSource)
Adds the Fixing Source field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field tofixingSource
- The fixing source
-
addAccount
public static DisplayFields addAccount(DisplayFields displayFields, java.lang.String account)
Adds the Account field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field toaccount
- The account description
-
addRate
public static DisplayFields addRate(DisplayFields displayFields, FormattedRate rate)
Adds the Rate field to your display-fields configuration- Parameters:
displayFields
- The DisplayFields to add the field torate
- The rate value
-
addTradeID
public static DisplayFields addTradeID(DisplayFields DisplayFields, java.lang.String tradeID)
Adds the Trade ID field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field totradeID
- The Trade ID, e.g. "75e4073d040f"
-
addSubmittedBy
public static DisplayFields addSubmittedBy(DisplayFields DisplayFields, java.lang.String user)
Adds the Submitted by field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field touser
- The user that submitted the trade, e.g. "Autotrader"
-
addSpotMidRate
public static DisplayFields addSpotMidRate(DisplayFields DisplayFields, FormattedRate spotMidRate)
Adds the Mid Spot-Rate field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field tospotMidRate
- The Mid-Spot Rate.
-
addAmountWithBuySell
public static DisplayFields addAmountWithBuySell(DisplayFields DisplayFields, FormattedAmount amount, java.lang.String buySell)
Adds the Amount field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field toamount
- The amountbuySell
- Whether the amount is bought or sold
-
addForwardPoints
public static DisplayFields addForwardPoints(DisplayFields DisplayFields, FormattedPoints forwardPoints)
Adds the Forward Points field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field toforwardPoints
- The Forward points.
-
addForwardMidPoints
public static DisplayFields addForwardMidPoints(DisplayFields DisplayFields, FormattedPoints midPoints)
Adds the Mid Points field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field tomidPoints
- The Mid points.
-
addAllInRate
public static DisplayFields addAllInRate(DisplayFields DisplayFields, FormattedRate allInRate)
Adds the All-In-Rate field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field toallInRate
- The All-In-Rate.
-
addStartDate
public static DisplayFields addStartDate(DisplayFields DisplayFields, java.time.LocalDate startDate)
Adds the Start date field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field tostartDate
- The Start date.
-
addEndDate
public static DisplayFields addEndDate(DisplayFields DisplayFields, java.time.LocalDate endDate)
Adds the End date field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field toendDate
- The End date.
-
addSwapPoints
public static DisplayFields addSwapPoints(DisplayFields DisplayFields, FormattedPoints swapPoints)
Adds the Swap Points field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field toswapPoints
- The Swap points.
-
addSwapMidPoints
public static DisplayFields addSwapMidPoints(DisplayFields DisplayFields, FormattedPoints swapMidPoints)
Adds the Mid Swap Points field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field toswapMidPoints
- The Swap points.
-
addExecutionDateTime
public static DisplayFields addExecutionDateTime(DisplayFields DisplayFields, java.time.Instant executionDateTime)
Adds the Execution time field to your display-fields configuration- Parameters:
DisplayFields
- The DisplayFields to add the field toexecutionDateTime
- The date and time of the trade, e.g. "12/07/2022 10:21:46"
-
addDefaultSalesAllocationConfirmationFields
public static DisplayFields addDefaultSalesAllocationConfirmationFields(DisplayFields displayFields, @Nullable java.lang.String entityDescription, @Nullable java.lang.String fullName, @Nullable java.lang.String currencyPair, @Nullable java.time.LocalDate executionDate, @Nullable java.time.Instant executionDateTime, @Nullable FormattedRate traderSpotRate, @Nullable FormattedPoints spotMargin, @Nullable FormattedRate clientSpotRate, @Nullable java.lang.Integer totalDeals, @Nullable FormattedAmount profit)
Adds the default deliverable deal display fields for a Sales Allocation confirmation message: - Client - Currency Pair - Execution Date Time - Trader Spot Rate - Spot Margin - Client Spot Rate - Total Deals - Estimated Profit- Parameters:
displayFields
- The DisplayFields to add the field toentityDescription
- The value matching the EntityDescription fields on a trade confirmation.fullName
- The value matching the FullName field on a trade confirmationcurrencyPair
- The value matching the CurrencyPair field on a trade confirmation.executionDate
- The execution dateexecutionDateTime
- The execution date timetraderSpotRate
- The value matching the TraderSpotRate field on your Sales trade confirmationspotMargin
- The value matching the SpotMargin field on your Sales trade confirmation@param spotMarginclientSpotRate
- The value matching the SpotRate field on your trade confirmationtotalDeals
- The number of allocated or repriced deals.profit
- The value matching the Profit field on your trade confirmation
-
addDefaultSalesAllocationConfirmationFields
public static DisplayFields addDefaultSalesAllocationConfirmationFields(DisplayFields displayFields, @Nullable java.lang.String entityDescription, @Nullable java.lang.String fullName, @Nullable java.lang.String currencyPair, @Nullable java.time.LocalDate executionDate, @Nullable java.time.Instant executionDateTime, @Nullable FormattedRate traderSpotRate, @Nullable FormattedPoints spotMargin, @Nullable FormattedRate clientSpotRate, @Nullable java.lang.Integer totalDeals, @Nullable FormattedAmount profit, @Nullable java.lang.String settlementCurrency, @Nullable java.lang.String fixingSource)
Adds the default display fields for a Sales Allocation confirmation message: - Client - Currency Pair - Settlement Currency (if non-deliverable) - Fixing Source (if non-deliverable) - Date - Time - Trader Spot Rate - Spot Margin - Client Spot Rate - Total Deals - Estimated Profit- Parameters:
displayFields
- The DisplayFields to add the field toentityDescription
- The value matching the EntityDescription fields on a trade confirmation.fullName
- The value matching the FullName field on a trade confirmationcurrencyPair
- The value matching the CurrencyPair field on a trade confirmation.executionDate
- The execution date in ISO format.executionDateTime
- The execution date time in ISO format. May optionally contain milliseconds.traderSpotRate
- The value matching the TraderSpotRate field on your Sales trade confirmationspotMargin
- The value matching the SpotMargin field on your Sales trade confirmation@param spotMarginclientSpotRate
- The value matching the SpotRate field on your trade confirmationtotalDeals
- The number of allocated or repriced deals.profit
- The value matching the Profit field on your trade confirmationsettlementCurrency
- The settlement currency for a non-deliverable dealfixingSource
- The fixing source for a non-deliverable deal
-
addDefaultAllocationConfirmationFields
public static DisplayFields addDefaultAllocationConfirmationFields(DisplayFields displayFields, @Nullable java.lang.String entityDescription, @Nullable java.lang.String fullName, @Nullable java.lang.String currencyPair, @Nullable java.time.LocalDate executionDate, @Nullable java.time.Instant executionDateTime, @Nullable FormattedRate spotRate, @Nullable java.lang.Integer totalDeals, @Nullable FormattedAmount profit)
Adds the default display fields for an Allocation confirmation message: - Client - Currency Pair - Date - Time - Spot Rate - Total Deals - Estimated Profit- Parameters:
displayFields
- The DisplayFields to add the field toentityDescription
- The value matching the EntityDescription fields on a trade confirmation.fullName
- The value matching the FullName field on a trade confirmationcurrencyPair
- The value matching the CurrencyPair field on a trade confirmation.executionDate
- The date the trade was executed.executionDateTime
- The execution date time in ISO format. May optionally contain milliseconds.param executionDateTimespotRate
- The value matching the SpotRate field on your trade confirmationtotalDeals
- The number of allocated or repriced deals.profit
- The value matching the Profit field on your trade confirmation
-
addDefaultSalesAllocationDetailsUpdateFields
public static DisplayFields addDefaultSalesAllocationDetailsUpdateFields(DisplayFields displayFields, @Nullable FormattedAmount originalAmount, @Nullable FormattedAmount originalContraAmount, @Nullable java.lang.String currencyPair, @Nullable java.time.LocalDate originalSettlementDate, @Nullable java.lang.String originalTenor, @Nullable java.lang.String originalAccount, @Nullable FormattedRate originalRate)
Adds the default deliverable deal display fields for a Sales Allocation details-update message: - Original Amount - Original Contra - Currency Pair - Settlement - Account - Original Rate- Parameters:
displayFields
- The DisplayFields to add the field tooriginalAmount
- The original amountoriginalContraAmount
- The original contra amountcurrencyPair
- The currency pairoriginalSettlementDate
- The original settlement dateoriginalTenor
- Optional original tenororiginalAccount
- The original accountoriginalRate
- The original rate
-
addDefaultSalesAllocationDetailsUpdateFields
public static DisplayFields addDefaultSalesAllocationDetailsUpdateFields(DisplayFields displayFields, @Nullable FormattedAmount originalAmount, @Nullable FormattedAmount originalContraAmount, @Nullable java.lang.String currencyPair, @Nullable java.time.LocalDate originalSettlementDate, @Nullable java.lang.String originalTenor, @Nullable java.lang.String originalAccount, @Nullable FormattedRate originalRate, @Nullable java.time.LocalDate fixingDate, @Nullable java.lang.String settlementCurrency, @Nullable java.lang.String fixingSource)
Adds the default display fields for a Sales Allocation details-update message: - Amount - Contra Amount - Currency Pair - Settlement Currency (if non-deliverable) - Settlement - Fixing Date (if non-deliverable) - Fixing Source (if non-deliverable) - Account - Original Rate- Parameters:
displayFields
- The DisplayFields to add the field tooriginalAmount
- The original amountoriginalContraAmount
- The original contra amountcurrencyPair
- The currency pairoriginalSettlementDate
- The original settlement dateoriginalTenor
- Optional original tenororiginalAccount
- The original accountoriginalRate
- The original ratefixingDate
- The fixing date for a non-deliverable tradesettlementCurrency
- The settlement currency for a non-deliverable tradefixingSource
- The fixing source for a non-deliverable trade
-
addDefaultAllocationDetailsUpdateFields
public static DisplayFields addDefaultAllocationDetailsUpdateFields(DisplayFields displayFields, @Nullable FormattedAmount originalAmount, @Nullable FormattedAmount originalContraAmount, @Nullable java.lang.String currencyPair, @Nullable java.time.LocalDate originalSettlementDate, @Nullable java.lang.String originalTenor, @Nullable java.lang.String originalAccount, @Nullable FormattedRate originalRate)
Adds the default deliverable deal display fields for an Allocation details-update message: - Original Amount - Original Contra - Currency Pair - Settlement - Account - Original Rate- Parameters:
displayFields
- The DisplayFields to add the field tooriginalAmount
- The original amountoriginalContraAmount
- The original contra amountcurrencyPair
- The currency pairoriginalSettlementDate
- The original settlement dateoriginalTenor
- Optional original tenororiginalAccount
- The original accountoriginalRate
- The original rate
-
addDefaultAllocationDetailsUpdateFields
public static DisplayFields addDefaultAllocationDetailsUpdateFields(DisplayFields displayFields, @Nullable FormattedAmount originalAmount, @Nullable FormattedAmount originalContraAmount, @Nullable java.lang.String currencyPair, @Nullable java.time.LocalDate originalSettlementDate, @Nullable java.lang.String originalTenor, @Nullable java.lang.String originalAccount, @Nullable FormattedRate originalRate, @Nullable java.time.LocalDate fixingDate)
Adds the default display fields for an Allocation details-update message: - Original Amount - Original Contra - Currency Pair - Settlement - Original Fixing Date (if non-deliverable) - Account - Original Rate- Parameters:
displayFields
- The DisplayFields to add the field tooriginalAmount
- The original amountoriginalContraAmount
- The original contra amountcurrencyPair
- The currency pairoriginalSettlementDate
- The original settlement dateoriginalTenor
- Optional original tenororiginalAccount
- The original accountoriginalRate
- The original ratefixingDate
- The fixing date for a non-deliverable trade
-
addGeneralOutrightFields
public static DisplayFields addGeneralOutrightFields(DisplayFields DisplayFields, @Nullable java.lang.String account, @Nullable java.lang.String tradeID, @Nullable java.time.Instant executionDateTime, @Nullable java.lang.String currencyPair, @Nullable java.lang.String user)
Adds the leg independent display fields for an outright trade- Parameters:
DisplayFields
- The DisplayFields to add the field to.account
- The account that completed the trade.tradeID
- The trade ID.executionDateTime
- The date and time of executioncurrencyPair
- The currency pair in the trade.user
- The user associated with the trade.
-
addSpotTradeDetailsFields
public static DisplayFields addSpotTradeDetailsFields(DisplayFields displayFields, @Nonnull BuySell buySell, @Nullable FormattedAmount amount, @Nullable FormattedAmount contraAmount, @Nullable FormattedRate spotRate, @Nullable FormattedRate spotMidRate, @Nullable java.time.LocalDate settlementDate, @Nullable java.lang.String settlementTenor)
Adds spot trade leg fields- Parameters:
displayFields
- The DisplayFields to add the field to.buySell
- Whether the amount is bought or soldamount
- The dealt amountcontraAmount
- The dealt amountspotRate
- The (client) spot rate, e.g. 1.23456spotMidRate
- The Mid-Spot Rate.settlementDate
- The settlement datesettlementTenor
- Optional tenor, to be displayed in brackets after the settlement date
-
addGenericFwdLegFields
public static DisplayFields addGenericFwdLegFields(DisplayFields displayFields, @Nonnull BuySell buySell, @Nullable FormattedAmount amount, @Nullable FormattedAmount contraAmount, @Nullable FormattedPoints forwardPoints, @Nullable FormattedPoints forwardMidPoints)
Adds generic fwd leg fields (look at other adders to see what it can be combined with):- Parameters:
displayFields
- The DisplayFields to add the field to.buySell
- Whether the amount is bought or soldamount
- The dealt amountcontraAmount
- The dealt amountforwardPoints
- The Forward points.forwardMidPoints
- The Forward Mid points.
-
addOtherFwdLegFields
public static DisplayFields addOtherFwdLegFields(DisplayFields displayFields, @Nullable FormattedRate spotRate, @Nullable FormattedRate spotMidRate, @Nullable FormattedRate allInRate, @Nullable java.time.LocalDate settlementDate, @Nullable java.lang.String settlementTenor)
adds fwd specific leg fields use with addGenericFwdLegFields to create fwd leg fields- Parameters:
displayFields
- The DisplayFields to add the field to.spotRate
- The (client) spot rate, e.g. 1.23456spotMidRate
- The Mid-Spot Rate.allInRate
- The All-In-Rate.settlementDate
- The settlement datesettlementTenor
- Optional tenor, to be displayed in brackets after the settlement date
-
addNdfLegFields
public static DisplayFields addNdfLegFields(DisplayFields displayFields, @Nullable java.time.LocalDate fixingDate)
adds ndf specific leg fields can be used with addOtherFwdLegFields and addGenericFwdLegFields to create ndf leg fields- Parameters:
displayFields
- The DisplayFields to add the field tofixingDate
- The fixing date
-
addTimeOptionFields
public static DisplayFields addTimeOptionFields(DisplayFields displayFields, @Nullable FormattedRate spotRate, @Nullable FormattedRate spotMidRate, @Nullable java.time.LocalDate startDate, @Nullable java.time.LocalDate endDate)
adds time option specific leg fields can be used with addGenericFwdLegFields to create time option leg fields- Parameters:
displayFields
- The DisplayFields to add the field to.spotRate
- The (client) spot rate, e.g. 1.23456spotMidRate
- The Mid-Spot Rate.startDate
- The Start date.endDate
- The Start date.
-
addSwapSpotFields
public static DisplayFields addSwapSpotFields(DisplayFields displayFields, @Nullable FormattedRate spotRate, @Nullable FormattedRate spotMidRate, @Nullable FormattedPoints swapPoints, @Nullable FormattedPoints swapMidPoints)
Adds swap specific leg independent fields- Parameters:
displayFields
- The DisplayFields to add the field to.spotRate
- The (client) spot rate, e.g. 1.23456spotMidRate
- The Mid-Spot Rate.swapPoints
- The Swap points.
-
addSwapLegFields
public static DisplayFields addSwapLegFields(DisplayFields displayFields, @Nullable FormattedRate allInRate, @Nullable java.time.LocalDate settlementDate, @Nullable java.lang.String settlementTenor)
Adds swap specific leg fields use with addGenericFwdLegFields to create a set of swap leg fields- Parameters:
displayFields
- The DisplayFields to add the field to.allInRate
- The All-In-Rate.settlementDate
- The settlement datesettlementTenor
- Optional tenor, to be displayed in brackets after the settlement date
-
addDefaultPostTradeHistoryFields
public static DisplayFields addDefaultPostTradeHistoryFields(DisplayFields displayFields, @Nullable FormattedAmount originalAmount, @Nullable java.time.LocalDate settlementDate, @Nullable java.lang.String settlementTenor, @Nullable FormattedAmount remainingAmount)
Adds the post trade history fields to your display fields configuration- Parameters:
displayFields
- The DisplayFields to add the field to.originalAmount
- The original amount of the parent tradesettlementDate
- The settlement date of the parent tradesettlementTenor
- Optional tenor, to be displayed in brackets after the settlement dateremainingAmount
- The remaining amount of the parent trade
-
-