Package com.tietoenator.trip.jxp

# Enum Class TdbDatabaseListType

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

All Implemented Interfaces:
  `Serializable`, `Comparable<TdbDatabaseListType>`, `Constable`

public enum TdbDatabaseListType extends Enum<TdbDatabaseListType>
Enumeration over various kinds of database lists that can be obtained via the TdbDatabaseList class.

- ## 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
  `Default`
  Default list.
  `NoBaf`
  List that only uses index data.
  `NoCounts`
  List that does not provide record counts.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getListType()`
  Retrieve the TRIPxpi protocol name for this type of database list
  `static TdbDatabaseListType`
  `getTypeof(String typeName)`
  Factory method to return the appropriate type ID from a protocol name
  `static TdbDatabaseListType`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static TdbDatabaseListType[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### 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 Details

  - ### values

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

  - ### getListType

    public String getListType()
    Retrieve the TRIPxpi protocol name for this type of database list
    Returns:
      Protocol name

  - ### getTypeof

    public static TdbDatabaseListType getTypeof(String typeName)
    Factory method to return the appropriate type ID from a protocol name
    Parameters:
      `name` - Protocol name
    Returns:
      Type ID