com.canto.cumulus.constants

Enum FieldValueMode

java.lang.Object

java.lang.Enum<FieldValueMode>

com.canto.cumulus.constants.FieldValueMode

All Implemented Interfaces:

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

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

This enum specifies the available modes for the field value of a catalog field.

Since:

8.0

See Also:

FieldDefinition.getValueMode()

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORMULA_VALUE The field value is calculated by the cumulus server whenever the record is saved.
USER_VALUE The field value is entered by a user (or by a filter, asset store when cataloging or updating the asset).

Method Summary

Methods

Modifier and Type	Method and Description
static FieldValueMode	findType(int id) Finds the value mode for the given id.
int	getID() Returns the id of this value mode.
static FieldValueMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FieldValueMode[]	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

USER_VALUE

public static final FieldValueMode USER_VALUE

The field value is entered by a user (or by a filter, asset store when cataloging or updating the asset).

FORMULA_VALUE

public static final FieldValueMode FORMULA_VALUE

The field value is calculated by the cumulus server whenever the record is saved.

Method Detail

values

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

Returns:

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

valueOf

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

getID

public int getID()

Returns the id of this value mode.

Returns:

id

findType

public static FieldValueMode findType(int id)

Finds the value mode for the given id.

Parameters:

id - wanted id

Returns:

the found value mode for the given id or USER_VALUE if the id cannot be found