com.canto.cumulus.constants

Enum MultipleLanguagesFieldType

java.lang.Object

java.lang.Enum<MultipleLanguagesFieldType>

com.canto.cumulus.constants.MultipleLanguagesFieldType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MultipleLanguagesFieldType>

public enum MultipleLanguagesFieldType
extends java.lang.Enum<MultipleLanguagesFieldType>

Describes the field type for a multiple languages field.

Since:

8.5

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE_FIELD This field is a base field of a multiple languages bundle which means that this field uses the original field UID (for example GUID.UID_REC_NOTES) instead of the generated one for an additional language.
CHILD_FIELD This field is a child field of a multiple languages bundle which means that this field uses the generated field UID incorporating the language of the field instead of the original field UID.
NO_MULTIPLE_LANGUAGE Field is not part of a multiple languages field bundle.

Method Summary

Methods

Modifier and Type	Method and Description
static MultipleLanguagesFieldType	find(int id) Returns the field type for the given id.
int	getID() Returns the ID of this multiple language field type.
static MultipleLanguagesFieldType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MultipleLanguagesFieldType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_MULTIPLE_LANGUAGE

public static final MultipleLanguagesFieldType NO_MULTIPLE_LANGUAGE

Field is not part of a multiple languages field bundle.

BASE_FIELD

public static final MultipleLanguagesFieldType BASE_FIELD

This field is a base field of a multiple languages bundle which means that this field uses the original field UID (for example GUID.UID_REC_NOTES) instead of the generated one for an additional language.

CHILD_FIELD

public static final MultipleLanguagesFieldType CHILD_FIELD

This field is a child field of a multiple languages bundle which means that this field uses the generated field UID incorporating the language of the field instead of the original field UID.

Method Detail

values

public static MultipleLanguagesFieldType[] 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 (MultipleLanguagesFieldType c : MultipleLanguagesFieldType.values())
    System.out.println(c);

Returns:

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

valueOf

public static MultipleLanguagesFieldType 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

find

public static MultipleLanguagesFieldType find(int id)

Returns the field type for the given id.

Parameters:

id - if of the type to return

Returns:

found type for the given id

getID

public int getID()

Returns the ID of this multiple language field type.

Returns:

ID of this multiple language field type