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 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	setCanAffirm(boolean canAffirm)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCanAffirm(@NotNull java.lang.String canAffirm)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCommodity(@NotNull java.lang.String commodity)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setCurrency(@NotNull java.lang.String currency)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setDealBreakdown(@NotNull Table dealBreakdown)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setDealBreakdown(@NotNull java.lang.String dealBreakdown)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setEffectiveDate(@NotNull java.lang.String effectiveDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setEntityDescription(@NotNull java.lang.String entityDescription)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setLEI(@NotNull java.lang.String lEI)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setMarket(@NotNull java.lang.String market)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setNextActionDeadline(@NotNull java.lang.String nextActionDeadline)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setNextActionDeadline(@NotNull java.time.Instant nextActionDeadline)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setNextActionDeadlineDisplayTimezone(@NotNull java.lang.String nextActionDeadlineDisplayTimezone)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setPaymentDate(@NotNull java.lang.String paymentDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setPricingDate(@NotNull java.lang.String pricingDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setReferencePrice(@NotNull java.lang.String referencePrice)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setReferencePrice(@NotNull java.math.BigDecimal referencePrice)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setSettlementStatus(@NotNull java.lang.String settlementStatus)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTerminationDate(@NotNull java.lang.String terminationDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTOBOUser(@NotNull java.lang.String tOBOUser)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTotalPremium(@NotNull java.lang.String totalPremium)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTotalPremium(@NotNull java.math.BigDecimal totalPremium)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTradeDate(@NotNull java.lang.String tradeDate)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTradeID(@NotNull java.lang.String tradeID)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setTradingType(@NotNull java.lang.String tradingType)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setUnit(@NotNull java.lang.String unit)
@NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder	setUPI(@NotNull java.lang.String uPI)
@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

setTradingType

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradingType(@NotNull
                                                                                       @NotNull java.lang.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 java.lang.String commodity)

Returns:

The commodity of the trade.

setTradeID

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

Returns:

A unique identifier for this trade.

setEffectiveDate

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

Returns:

The date the trade comes into effect.

setTerminationDate

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

Returns:

The termination date of the trade.

setTradeDate

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

Parameters:

tradeDate - e.g. 20160314

Returns:

tradeDate

setReferencePrice

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setReferencePrice(@NotNull
                                                                                          @NotNull java.math.BigDecimal referencePrice)

Returns:

The reference price of the traded commodity

setReferencePrice

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

Returns:

The reference price of the traded commodity

setPricingDate

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

Returns:

The date the price was generated on.

setPaymentDate

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

Returns:

The date by when the payment needs to be done.

setLEI

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

Returns:

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

setUPI

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

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 java.lang.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 java.lang.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 java.time.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 java.lang.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 java.lang.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 java.lang.String tOBOUser)

Returns:

The user the trade is on behalf of.

setEntityDescription

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

Returns:

The entity the trade is on behalf of.

setMarket

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setMarket(@NotNull
                                                                                  @NotNull java.lang.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 java.lang.String canAffirm)

Returns:

Ability to Affirm the Trade Details are as agreed.

setUnit

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

Parameters:

unit - e.g. bbl

Returns:

unit

setCurrency

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

Returns:

The currency the transaction has been made in.

setTotalPremium

@NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTotalPremium(@NotNull
                                                                                        @NotNull java.math.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 java.lang.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.