com.tietoenator.trip.jxp

## Enum TdbDatabaseListType

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

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

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

  Enumeration over various kinds of database lists that can be obtained via the TdbDatabaseList class.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `Default` Default list.
    `NoBaf` List that only uses index data.
    `NoCounts` List that does not provide record counts.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getListType()` Retrieve the TRIPxpi protocol name for this type of database list
    `static TdbDatabaseListType` | `getTypeof(java.lang.String typeName)` Factory method to return the appropriate type ID from a protocol name
    `static TdbDatabaseListType` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static TdbDatabaseListType[]` | `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

    - #### Default

          public static final TdbDatabaseListType Default

      Default list. Also provides up to date record counts for databases and clusters.

    - #### NoBaf

          public static final TdbDatabaseListType NoBaf

      List that only uses index data. Also provides record counts for databases and clusters as denoted in the index (new unindexed records are not counted).

    - #### NoCounts

          public static final TdbDatabaseListType NoCounts

      List that does not provide record counts. This is the most performant way to list databases and clusters when there are a lot of databases and large clusters.

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

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

    - #### getListType

          public java.lang.String getListType()

      Retrieve the TRIPxpi protocol name for this type of database list
      Returns:
        Protocol name

    - #### getTypeof

          public static TdbDatabaseListType getTypeof(java.lang.String typeName)

      Factory method to return the appropriate type ID from a protocol name
      Parameters:
        `name` - Protocol name
      Returns:
        Type ID