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

Enum DisplayFieldArgument.TypeEnum

java.lang.Object

java.lang.Enum<DisplayFieldArgument.TypeEnum>

com.caplin.motif.config.definitions.common.DisplayFieldArgument.TypeEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DisplayFieldArgument.TypeEnum>

Enclosing class:

DisplayFieldArgument

public static enum DisplayFieldArgument.TypeEnum
extends java.lang.Enum<DisplayFieldArgument.TypeEnum>

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.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMOUNT
BUTTON
DATE
DATETIME
NUMBER
POINTS
RATE
TEXT
TIME
TOKEN

Method Summary

Modifier and Type	Method	Description
static DisplayFieldArgument.TypeEnum	fromValue(java.lang.String value)
java.lang.String	getValue()
java.lang.String	toString()
static DisplayFieldArgument.TypeEnum	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static DisplayFieldArgument.TypeEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEXT

public static final DisplayFieldArgument.TypeEnum TEXT

TOKEN

public static final DisplayFieldArgument.TypeEnum TOKEN

NUMBER

public static final DisplayFieldArgument.TypeEnum NUMBER

DATE

public static final DisplayFieldArgument.TypeEnum DATE

TIME

public static final DisplayFieldArgument.TypeEnum TIME

DATETIME

public static final DisplayFieldArgument.TypeEnum DATETIME

RATE

public static final DisplayFieldArgument.TypeEnum RATE

POINTS

public static final DisplayFieldArgument.TypeEnum POINTS

AMOUNT

public static final DisplayFieldArgument.TypeEnum AMOUNT

BUTTON

public static final DisplayFieldArgument.TypeEnum BUTTON

Method Detail

values

public static DisplayFieldArgument.TypeEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DisplayFieldArgument.TypeEnum c : DisplayFieldArgument.TypeEnum.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DisplayFieldArgument.TypeEnum valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public java.lang.String getValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<DisplayFieldArgument.TypeEnum>

fromValue

public static DisplayFieldArgument.TypeEnum fromValue(java.lang.String value)