Class DisplayFieldArgument
- java.lang.Object
-
- com.caplin.motif.config.definitions.common.DisplayFieldArgument
-
@Generated("org.openapitools.codegen.languages.SpringCodegen") public class DisplayFieldArgument extends java.lang.Object
DisplayFieldArgument
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DisplayFieldArgument.TypeEnum
Type of the value.
-
Constructor Summary
Constructors Constructor Description DisplayFieldArgument()
DisplayFieldArgument(java.lang.String value, DisplayFieldArgument.TypeEnum type)
Constructor with only required parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DisplayFieldArgument
action(DisplayFieldArgumentAction action)
DisplayFieldArgument
color(java.lang.String color)
DisplayFieldArgument
digitsBeforePips(java.lang.Integer digitsBeforePips)
DisplayFieldArgument
dps(java.lang.Integer dps)
boolean
equals(java.lang.Object o)
DisplayFieldArgumentAction
getAction()
Get actionjava.lang.String
getColor()
The color of the argument value.java.lang.Integer
getDigitsBeforePips()
Digits before pips for a points or rate value.java.lang.Integer
getDps()
Number of decimal places for a points, rate or amount value.java.lang.Integer
getNumberOfPips()
Number of pips for a points or rate value.@NotNull DisplayFieldArgument.TypeEnum
getType()
Type of the value.@NotNull java.lang.String
getValue()
The value to be applied to the template.int
hashCode()
DisplayFieldArgument
numberOfPips(java.lang.Integer numberOfPips)
void
setAction(DisplayFieldArgumentAction action)
void
setColor(java.lang.String color)
void
setDigitsBeforePips(java.lang.Integer digitsBeforePips)
void
setDps(java.lang.Integer dps)
void
setNumberOfPips(java.lang.Integer numberOfPips)
void
setType(DisplayFieldArgument.TypeEnum type)
void
setValue(java.lang.String value)
java.lang.String
toString()
DisplayFieldArgument
type(DisplayFieldArgument.TypeEnum type)
DisplayFieldArgument
value(java.lang.String value)
-
-
-
Constructor Detail
-
DisplayFieldArgument
public DisplayFieldArgument()
-
DisplayFieldArgument
public DisplayFieldArgument(java.lang.String value, DisplayFieldArgument.TypeEnum type)
Constructor with only required parameters
-
-
Method Detail
-
value
public DisplayFieldArgument value(java.lang.String value)
-
getValue
@NotNull public @NotNull java.lang.String getValue()
The value to be applied to the template.- Returns:
- value
-
setValue
public void setValue(java.lang.String value)
-
type
public DisplayFieldArgument type(DisplayFieldArgument.TypeEnum type)
-
getType
@NotNull public @NotNull DisplayFieldArgument.TypeEnum getType()
Type of the value. Used by the frontend for formatting. * `TEXT` - Plaintext value that should be displayed unmodified. * `TOKEN` - Translation token. The token must be known to the frontend. * `NUMBER` - A number. The frontend applies number formatting as specified by the user's locale. Please set the value with the intended precision, as the frontends do not make any precision adjustments for NUMBER values. * `DATE` - An ISO date (`YYYY-MM-DD`). Will be formatted as per user's locale setting. * `TIME` - An ISO date-time (`YYYY-MM-DD[T]HH:mm:ss.SSS`) or time (`HH:mm:ss.SSS`) with or without milliseconds. Input must be in UTC. Milliseconds will be displayed only if the input format contained milliseconds. Frontend will convert to local time and display the time part only, formatted as per user's locale setting. * `DATETIME` - An ISO date-time (`YYYY-MM-DD[T]HH:mm:ss.SSS`) with or without milliseconds. Input must be in UTC. Milliseconds will be displayed only if the input format contained milliseconds. Frontend will convert to local time and display the date and time formatted as per user's locale setting. * `RATE` - A rate value that may be formatted with adapter-provided formatting attributes. * `POINTS` - A points value that may be formatted with adapter-provided formatting attributes. * `AMOUNT` - An amount value that may be formatted with adapter-provided formatting attributes. * `BUTTON` - A plaintext value to be displayed on a button, and an optional name of an action to be performed upon clicking the button.- Returns:
- type
-
setType
public void setType(DisplayFieldArgument.TypeEnum type)
-
action
public DisplayFieldArgument action(DisplayFieldArgumentAction action)
-
getAction
public DisplayFieldArgumentAction getAction()
Get action- Returns:
- action
-
setAction
public void setAction(DisplayFieldArgumentAction action)
-
digitsBeforePips
public DisplayFieldArgument digitsBeforePips(java.lang.Integer digitsBeforePips)
-
getDigitsBeforePips
public java.lang.Integer getDigitsBeforePips()
Digits before pips for a points or rate value.- Returns:
- digitsBeforePips
-
setDigitsBeforePips
public void setDigitsBeforePips(java.lang.Integer digitsBeforePips)
-
numberOfPips
public DisplayFieldArgument numberOfPips(java.lang.Integer numberOfPips)
-
getNumberOfPips
public java.lang.Integer getNumberOfPips()
Number of pips for a points or rate value.- Returns:
- numberOfPips
-
setNumberOfPips
public void setNumberOfPips(java.lang.Integer numberOfPips)
-
dps
public DisplayFieldArgument dps(java.lang.Integer dps)
-
getDps
public java.lang.Integer getDps()
Number of decimal places for a points, rate or amount value.- Returns:
- dps
-
setDps
public void setDps(java.lang.Integer dps)
-
color
public DisplayFieldArgument color(java.lang.String color)
-
getColor
public java.lang.String getColor()
The color of the argument value. Can be a design system token (e.g. neutral_base) or, alternatively, any valid HTML color code (e.g. #FFFFFF or red).- Returns:
- color
-
setColor
public void setColor(java.lang.String color)
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-