Package com.uc4.api.objects

Enum ErtUsage

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ErtUsage>
    public enum ErtUsage
extends java.lang.Enum<ErtUsage>
    The Enum represent ERT usage value for a Variables.

    • 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ErtUsage getErtUsage​(int id)
      Gets the ERT usage Enum Value.
      static java.util.Map<java.lang.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​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ErtUsage[] 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, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 Detail

      • values

        public static ErtUsage[] 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 (ErtUsage c : ErtUsage.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ErtUsage 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()
        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 java.util.Map<java.lang.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