Package com.caplin.generated.motif.commodities.tradeconfirmation

Class TradeConfPartsDef.CommonTradeConfirmationFields.Builder

java.lang.Object

com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.CommonTradeConfirmationFields.Builder

Enclosing class:

TradeConfPartsDef.CommonTradeConfirmationFields

public static final class TradeConfPartsDef.CommonTradeConfirmationFields.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields	build()
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanAffirm(boolean canAffirm)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanAffirm(@NotNull String canAffirm)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCommodity(@NotNull String commodity)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCurrency(@NotNull String currency)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setDealBreakdown(@NotNull Table dealBreakdown)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setDealBreakdown(@NotNull String dealBreakdown)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setEffectiveDate(@NotNull String effectiveDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setEntityDescription(@NotNull String entityDescription)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setFloatingPrice(@NotNull String floatingPrice)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setLegTradeConfirmation(@NotNull TradeConfPartsDef.LegTradeConfirmationFields legTradeConfirmation)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setLEI(@NotNull String lEI)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setMarket(@NotNull String market)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setNextActionDeadline(@NotNull String nextActionDeadline)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setNextActionDeadline(@NotNull Instant nextActionDeadline)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setNextActionDeadlineDisplayTimezone(@NotNull String nextActionDeadlineDisplayTimezone)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setPaymentDate(@NotNull String paymentDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setPricingDate(@NotNull String pricingDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setReferencePrice(@NotNull String referencePrice)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setSettlementStatus(@NotNull String settlementStatus)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTerminationDate(@NotNull String terminationDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTOBOUser(@NotNull String tOBOUser)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTotalPremium(@NotNull String totalPremium)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTotalPremium(@NotNull BigDecimal totalPremium)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTradeDate(@NotNull String tradeDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTradeID(@NotNull String tradeID)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTradingType(@NotNull String tradingType)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setUnit(@NotNull String unit)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setUPI(@NotNull String uPI)	Deprecated.
@NotNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

addField

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder addField(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

build

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setTradingType

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradingType(@NotNull
 @NotNull String tradingType)

Returns:

Caplin supported values are [FIXED_SWAP, BASIS_SWAP, EURO_PUT, EURO_CALL, EURO_COLLAR, EURO_3_WAY_COLLAR, EURO_CALL_SPREAD, ASIAN_CAP, ASIAN_FLOOR, ASIAN_COLLAR, ASIAN_3_WAY_COLLAR, ASIAN_CAP_SPREAD, ASIAN_FLOOR_SPREAD, SPREAD_PUT]. See the constants defined within com.caplin.motif.commodities.trading.CommoditiesTradingType for further details.

setCommodity

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCommodity(@NotNull
 @NotNull String commodity)

Returns:

The commodity of the trade.

setTradeID

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradeID(@NotNull
 @NotNull String tradeID)

Returns:

A unique identifier for this trade.

setEffectiveDate

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setEffectiveDate(@NotNull
 @NotNull String effectiveDate)

Returns:

The date the trade comes into effect.

setTerminationDate

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTerminationDate(@NotNull
 @NotNull String terminationDate)

Returns:

The termination date of the trade.

setTradeDate

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradeDate(@NotNull
 @NotNull String tradeDate)

Parameters:

tradeDate - e.g. 20160314

Returns:

tradeDate

setReferencePrice

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setReferencePrice(@NotNull
 @NotNull String referencePrice)

Returns:

The referenced ISDA mapping of the underlying traded commodity

setFloatingPrice

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setFloatingPrice(@NotNull
 @NotNull String floatingPrice)

Returns:

The description of the referenced ISDA mapping of the underlying traded commodity

setPricingDate

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPricingDate(@NotNull
 @NotNull String pricingDate)

Returns:

The date the price was generated on.

setPaymentDate

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPaymentDate(@NotNull
 @NotNull String paymentDate)

Returns:

The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.

setLEI

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setLEI(@NotNull
 @NotNull String lEI)

Returns:

Legal entity identifier, unique number to identify the entity engaging in a financial transaction.

setUPI

@Deprecated
@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setUPI(@NotNull
 @NotNull String uPI)

Deprecated.

Returns:

Unique product identifier, similar to USI/UTI but at product level not transaction level.

setDealBreakdown

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDealBreakdown(@NotNull
 @NotNull String dealBreakdown)

Returns:

A JSON structure containing all the individual deals of a commodities trade. Use DefaultTableFields builders to provide Caplin default and/or custom fields.

setDealBreakdown

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDealBreakdown(@NotNull
 @NotNull Table dealBreakdown)

Returns:

A JSON structure containing all the individual deals of a commodities trade. Use DefaultTableFields builders to provide Caplin default and/or custom fields.

setSettlementStatus

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setSettlementStatus(@NotNull
 @NotNull String settlementStatus)

Returns:

Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]

setNextActionDeadline

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNextActionDeadline(@NotNull
 @NotNull Instant nextActionDeadline)

Parameters:

nextActionDeadline - e.g. 2018-03-16T07:25:16+00:00

Returns:

The deadline for a user to perform a trade's next action in ISO-8601 format

setNextActionDeadline

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNextActionDeadline(@NotNull
 @NotNull String nextActionDeadline)

Parameters:

nextActionDeadline - e.g. 2018-03-16T07:25:16+00:00

Returns:

The deadline for a user to perform a trade's next action in ISO-8601 format

setNextActionDeadlineDisplayTimezone

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNextActionDeadlineDisplayTimezone(@NotNull
 @NotNull String nextActionDeadlineDisplayTimezone)

Parameters:

nextActionDeadlineDisplayTimezone - e.g. America/New_York

Returns:

The timezone for the NextActionDeadline field in the form Area/Location

setTOBOUser

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTOBOUser(@NotNull
 @NotNull String tOBOUser)

Returns:

The user the trade is on behalf of.

setEntityDescription

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setEntityDescription(@NotNull
 @NotNull String entityDescription)

Returns:

The entity the trade is on behalf of.

setMarket

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setMarket(@NotNull
 @NotNull String market)

Parameters:

market - e.g. Metals

Returns:

market

setCanAffirm

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanAffirm(boolean canAffirm)

Returns:

Ability to Affirm the Trade Details are as agreed.

setCanAffirm

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCanAffirm(@NotNull
 @NotNull String canAffirm)

Returns:

Ability to Affirm the Trade Details are as agreed.

setUnit

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setUnit(@NotNull
 @NotNull String unit)

Parameters:

unit - e.g. bbl

Returns:

unit

setCurrency

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCurrency(@NotNull
 @NotNull String currency)

Returns:

The currency the transaction has been made in.

setTotalPremium

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTotalPremium(@NotNull
 @NotNull BigDecimal totalPremium)

Returns:

The total premiums of deal breakdown. When there is no deal breakdown present it will be the actual premium paid for the deal.

setTotalPremium

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTotalPremium(@NotNull
 @NotNull String totalPremium)

Returns:

The total premiums of deal breakdown. When there is no deal breakdown present it will be the actual premium paid for the deal.

setLegTradeConfirmation

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setLegTradeConfirmation(@NotNull
 @NotNull TradeConfPartsDef.LegTradeConfirmationFields legTradeConfirmation)

Returns:

legTradeConfirmation