Enum Class RetirementState

java.lang.Object
java.lang.Enum<RetirementState>
com.inductiveautomation.historian.common.model.browse.RetirementState
All Implemented Interfaces:
Serializable, Comparable<RetirementState>, Constable

public enum RetirementState extends Enum<RetirementState>
Which retirement state of nodes a historian browse includes; the value of HistorianBrowseTraits.RETIREMENT_STATE. Engines that declare RETIRED_NODE_AWARE honor it; other engines ignore it and return their default node set.

A node whose retiredTime equals the current instant is RETIRED, not ACTIVE.

  • Enum Constant Details

    • ACTIVE

      public static final RetirementState ACTIVE
      Only nodes whose retiredTime is absent or strictly in the future; the default.
    • RETIRED

      public static final RetirementState RETIRED
      Only nodes whose retiredTime is present and at or before the current instant.
    • ALL

      public static final RetirementState ALL
      All nodes regardless of retiredTime.
  • Method Details

    • values

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