Package com.caplin.generated.motif.fx.warning

Class WarningPartsDef.AmendWarning.Builder

java.lang.Object

com.caplin.generated.motif.fx.warning.WarningPartsDef.AmendWarning.Builder

Enclosing class:

WarningPartsDef.AmendWarning

public static final class WarningPartsDef.AmendWarning.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull WarningPartsDef.AmendWarning.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull WarningPartsDef.AmendWarning	build()
@NotNull WarningPartsDef.AmendWarning.Builder	setAmendmentReasons(@NotNull String amendmentReasons)
@NotNull WarningPartsDef.AmendWarning.Builder	setAmendmentType(@NotNull String amendmentType)
@NotNull WarningPartsDef.AmendWarning.Builder	setWarningType(@NotNull String warningType)
@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 WarningPartsDef.AmendWarning.Builder addField(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

build

@NotNull
public @NotNull WarningPartsDef.AmendWarning build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setWarningType

@NotNull
public @NotNull WarningPartsDef.AmendWarning.Builder setWarningType(@NotNull
 @NotNull String warningType)

Parameters:

warningType - e.g. Generic

Returns:

The type of a warning message. Caplin supported warning types are [AMEND_REASON, GENERIC]. See the constants defined within com.caplin.motif.fx.trading.WarningTypes.

setAmendmentType

@NotNull
public @NotNull WarningPartsDef.AmendWarning.Builder setAmendmentType(@NotNull
 @NotNull String amendmentType)

Parameters:

amendmentType - e.g. Economic

Returns:

The type of the trade amendment, only used when amending a trade

setAmendmentReasons

@NotNull
public @NotNull WarningPartsDef.AmendWarning.Builder setAmendmentReasons(@NotNull
 @NotNull String amendmentReasons)

Parameters:

amendmentReasons - e.g. Customer Initiated

Returns:

A list of possible reasons for the trade amendment, only used when amending a trade