com.tietoenator.trip.jxp.database

## Enum TdbFieldGroupType

- java.lang.Object
- - java.lang.Enum<TdbFieldGroupType>
  - - com.tietoenator.trip.jxp.database.TdbFieldGroupType

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TdbFieldGroupType>

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

  An enumeration of the possible field group types.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `Structural` Structural field group.
    `Tuple` Field group that defines a tuple structure.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getName()` Return the TRIPxpi protocol name for the current field group type identifier
    `static TdbFieldGroupType` | `getTypeof(java.lang.String name)` Retrieve the field group type ID that matches the provided name
    `static TdbFieldGroupType` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static TdbFieldGroupType[]` | `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

    - #### Structural

          public static final TdbFieldGroupType Structural

      Structural field group. Used for searching and to inform applications and users about related fields.

    - #### Tuple

          public static final TdbFieldGroupType Tuple

      Field group that defines a tuple structure. In addition to the behaviors of strucural field groups, tuple field groups inform the TRIP kernel that the fields in the group are tupled and so must have the same number of subfields.

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

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

    - #### getTypeof

          public static TdbFieldGroupType getTypeof(java.lang.String name)

      Retrieve the field group type ID that matches the provided name
      Parameters:
        `name` - The name to match
      Returns:
        The type ID

    - #### getName

          public java.lang.String getName()

      Return the TRIPxpi protocol name for the current field group type identifier
      Returns:
        The name