Package com.caplin.motif.config.definitions.common

Class DisplayFieldArgument

java.lang.Object
com.caplin.motif.config.definitions.common.DisplayFieldArgument
@Generated("org.openapitools.codegen.languages.SpringCodegen") public class DisplayFieldArgument extends Object
DisplayFieldArgument

  • Constructor Details

    • DisplayFieldArgument

      public DisplayFieldArgument()

    • DisplayFieldArgument

      public DisplayFieldArgument(String value, DisplayFieldArgument.TypeEnum type)
      Constructor with only required parameters

  • Method Details

    • value

      public DisplayFieldArgument value(String value)

    • getValue

      @NotNull public @NotNull String getValue()
      The value to be applied to the template.
      Returns:
      value

    • setValue

      public void setValue(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(Integer digitsBeforePips)

    • getDigitsBeforePips

      public Integer getDigitsBeforePips()
      Digits before pips for a points or rate value.
      Returns:
      digitsBeforePips

    • setDigitsBeforePips

      public void setDigitsBeforePips(Integer digitsBeforePips)

    • numberOfPips

      public DisplayFieldArgument numberOfPips(Integer numberOfPips)

    • getNumberOfPips

      public Integer getNumberOfPips()
      Number of pips for a points or rate value.
      Returns:
      numberOfPips

    • setNumberOfPips

      public void setNumberOfPips(Integer numberOfPips)

    • dps

      public DisplayFieldArgument dps(Integer dps)

    • getDps

      public Integer getDps()
      Number of decimal places for a points, rate or amount value.
      Returns:
      dps

    • setDps

      public void setDps(Integer dps)

    • color

      public DisplayFieldArgument color(String color)

    • getColor

      public 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(String color)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object