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

Class WarningPartsDef.Warning.Builder

java.lang.Object

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

Enclosing class:

WarningPartsDef.Warning

public static final class WarningPartsDef.Warning.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull WarningPartsDef.Warning.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull WarningPartsDef.Warning	build()
@NotNull WarningPartsDef.Warning.Builder	setWarningMessage(@NotNull String warningMessage)
@NotNull WarningPartsDef.Warning.Builder	setWarningTitle(@NotNull String warningTitle)
@NotNull WarningPartsDef.Warning.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.Warning.Builder addField(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

build

@NotNull
public @NotNull WarningPartsDef.Warning build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setWarningType

@NotNull
public @NotNull WarningPartsDef.Warning.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.

setWarningTitle

@NotNull
public @NotNull WarningPartsDef.Warning.Builder setWarningTitle(@NotNull
 @NotNull String warningTitle)

Parameters:

warningTitle - e.g. Credit Check

Returns:

The title of a warning message. Supports strings and i18n tokens.

setWarningMessage

@NotNull
public @NotNull WarningPartsDef.Warning.Builder setWarningMessage(@NotNull
 @NotNull String warningMessage)

Parameters:

warningMessage - e.g. **CREDIT CHECK:** This user has a credit limit of **1,000,000.00 USD** which should not be exceeded.

Returns:

The message to display for any warnings regarding a quote request. Supports Markdown syntax for formatting.