Package com.caplin.generated.motif.fx.tradedetails

Class TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder

java.lang.Object

com.caplin.generated.motif.fx.tradedetails.TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder

Enclosing class:

TradeDetailsPartsDef.InterventionTradeDetailsFields

public static final class TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields	build()
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setCompetition(boolean competition)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setCompetition(@NotNull String competition)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setDealable(boolean dealable)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setDealable(@NotNull String dealable)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setDisplayFields(@NotNull DisplayFields displayFields)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setDisplayFields(@NotNull String displayFields)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setEntityDescription(@NotNull String entityDescription)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setIntervenerUsername(@NotNull String intervenerUsername)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setInterventionMode(@NotNull String interventionMode)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setInterventionStatus(@NotNull String interventionStatus)	Deprecated.
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setInterventionTradingType(@NotNull String interventionTradingType)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setPricingMode(@NotNull String pricingMode)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setPrimaryReason(@NotNull String primaryReason)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setReasons(@NotNull DisplayFields reasons)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setReasons(@NotNull String reasons)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setSource(@NotNull String source)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setTradeRequestID(@NotNull String tradeRequestID)
@NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder	setTradeStatus(@NotNull String tradeStatus)
@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 TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder addField(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

build

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setInterventionStatus

@Deprecated
@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setInterventionStatus(@NotNull
 @NotNull String interventionStatus)

Deprecated.

Returns:

Use the TradeStatus field instead

setInterventionTradingType

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setInterventionTradingType(@NotNull
 @NotNull String interventionTradingType)

Returns:

The type of intervention that is required. Caplin supported values are [RFS, ALLOCATION, ALGO]. RFS is assumed if this is not specified. Constants are defined within com.caplin.motif.fx.trading.InterventionTradingType.

setInterventionMode

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setInterventionMode(@NotNull
 @NotNull String interventionMode)

Returns:

Determine what type of intervention is required, such as whether it requires pricing or whether it is a simple accept/reject. Caplin supported values are [ACCEPT, PRICE]. PRICE is assumed if this is not specified.

setTradeStatus

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setTradeStatus(@NotNull
 @NotNull String tradeStatus)

Parameters:

tradeStatus - e.g. AWAITING-PRICE

Returns:

The current status of the trade. Supported types are [AWAITING-TRADER, AWAITING-PRICE, PRICED, EXECUTING, CLOSED, REJECTED, ERRORED, COMPLETED]. CLOSED means the client cancelled the trade request, REJECTED indicates it was rejected by the dealer.

setDealable

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setDealable(boolean dealable)

Returns:

Whether a trade request can be picked up by a sales trader

setDealable

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setDealable(@NotNull
 @NotNull String dealable)

Returns:

Whether a trade request can be picked up by a sales trader

setPricingMode

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setPricingMode(@NotNull
 @NotNull String pricingMode)

Parameters:

pricingMode - e.g. AUTO

Returns:

Whether the trade is being automatically or manually priced. Supported types are [AUTO, MANUAL]

setCompetition

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setCompetition(boolean competition)

Returns:

Whether a quote request is in competition. For example, true for quotes from an ECN and false for quotes from an SDP

setCompetition

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setCompetition(@NotNull
 @NotNull String competition)

Returns:

Whether a quote request is in competition. For example, true for quotes from an ECN and false for quotes from an SDP

setPrimaryReason

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setPrimaryReason(@NotNull
 @NotNull String primaryReason)

Parameters:

primaryReason - e.g. This trade exceeds the GFA

Returns:

The headline reason that a trade requires intervention.

setReasons

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setReasons(@NotNull
 @NotNull String reasons)

Returns:

A JSON structure containing all the reasons and information about why the trade requires intervention. Please see the Sales Intervention Reasons documentation on the website for more information.

setReasons

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setReasons(@NotNull
 @NotNull DisplayFields reasons)

Returns:

A JSON structure containing all the reasons and information about why the trade requires intervention. Please see the Sales Intervention Reasons documentation on the website for more information.

setTradeRequestID

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setTradeRequestID(@NotNull
 @NotNull String tradeRequestID)

Returns:

tradeRequestID

setSource

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setSource(@NotNull
 @NotNull String source)

Returns:

The source of a quote request. The name or ID of an ECN, SDP or other channel

setIntervenerUsername

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setIntervenerUsername(@NotNull
 @NotNull String intervenerUsername)

Parameters:

intervenerUsername - e.g. head_trader@novobank.co.za

Returns:

The user who is currently intervening on and potentially pricing a trade.

setEntityDescription

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setEntityDescription(@NotNull
 @NotNull String entityDescription)

Parameters:

entityDescription - e.g. Customer 1

Returns:

The description of a trade on behalf of entity.

setDisplayFields

@NotNull
public @NotNull TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setDisplayFields(@NotNull
 @NotNull String displayFields)

Parameters:

displayFields - e.g. method={'import':'static com.caplin.motif.fx.config.DefaultDisplayFields.addDefaultSalesAllocationDetailsUpdateFields','name':'addDefaultSalesAllocationDetailsUpdateFields','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 TradeDetailsPartsDef.InterventionTradeDetailsFields.Builder setDisplayFields(@NotNull
 @NotNull DisplayFields displayFields)

Parameters:

displayFields - e.g. method={'import':'static com.caplin.motif.fx.config.DefaultDisplayFields.addDefaultSalesAllocationDetailsUpdateFields','name':'addDefaultSalesAllocationDetailsUpdateFields','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.