Package com.uc4.api.objects

Enum Class ErtUsage

java.lang.Object

java.lang.Enum<ErtUsage>

com.uc4.api.objects.ErtUsage

All Implemented Interfaces:

Serializable, Comparable<ErtUsage>, Constable

public enum ErtUsage
extends Enum<ErtUsage>

The Enum represent ERT usage value for a Variables.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DATE	Variable is used as Date and its MLS Id.
NOMINAL	Variable is used as Nominal and its MLS Id.
NONE	Variable is used as No ERT usage and its MLS Id.
NUMERIC	Variable is used as Numeric and its MLS Id.
TIME	Variable is used as Time and its MLS Id.
TIMESTAMP	Variable is used as TimeStamp and its MLS Id.

Method Summary

Modifier and Type	Method	Description
static ErtUsage	getErtUsage(int id)	Gets the ERT usage Enum Value.
static Map<Integer,ErtUsage>	getErtUsageKeyValues()	Gets the Read Only Map of ERT usage.
int	getId()	Gets the id for ERT Usage
int	getMLSId()	Gets the MLS id against ERT Usage
static ErtUsage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ErtUsage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final ErtUsage NONE

Variable is used as No ERT usage and its MLS Id.

NOMINAL

public static final ErtUsage NOMINAL

Variable is used as Nominal and its MLS Id.

NUMERIC

public static final ErtUsage NUMERIC

Variable is used as Numeric and its MLS Id.

TIMESTAMP

public static final ErtUsage TIMESTAMP

Variable is used as TimeStamp and its MLS Id.

DATE

public static final ErtUsage DATE

Variable is used as Date and its MLS Id.

TIME

public static final ErtUsage TIME

Variable is used as Time and its MLS Id.

Method Details

values

public static ErtUsage[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ErtUsage valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getId

public int getId()

Gets the id for ERT Usage

Returns:

the id

getMLSId

public int getMLSId()

Gets the MLS id against ERT Usage

Returns:

the mlsid of ERT.

getErtUsage

public static ErtUsage getErtUsage(int id)

Gets the ERT usage Enum Value. Case 1 : Return ErtUsage if id between 0 to 5 Case 2 : Returns ErtUsage.NONE if id other then Case1

Parameters:

id - the id

Returns:

the ERT usage Enum

getErtUsageKeyValues

public static Map<Integer,ErtUsage> getErtUsageKeyValues()

Gets the Read Only Map of ERT usage. Key is ErtUsage id which could be between 0 to 5 Value = ErtUsage Enum

Returns:

the Map of ErtUsage