java.lang.Object
java.lang.Enum<RetentionBasis>
org.odpi.openmetadata.frameworks.connectors.properties.beans.RetentionBasis
All Implemented Interfaces:
Serializable, Comparable<RetentionBasis>, Constable

public enum RetentionBasis extends Enum<RetentionBasis> implements Serializable
RetentionBasis defines the retention requirements associated with a data item.
  • Enum Constant Details

    • UNCLASSIFIED

      public static final RetentionBasis UNCLASSIFIED
      There is no assessment of the retention requirements for this data.
    • TEMPORARY

      public static final RetentionBasis TEMPORARY
      This data is temporary. There are no formal retention requirements.
    • PROJECT_LIFETIME

      public static final RetentionBasis PROJECT_LIFETIME
      The data is needed for the lifetime of the referenced project.
    • TEAM_LIFETIME

      public static final RetentionBasis TEAM_LIFETIME
      The data is needed for the lifetime of the referenced team.
    • CONTRACT_LIFETIME

      public static final RetentionBasis CONTRACT_LIFETIME
      The data is needed for the lifetime of the referenced contract.
    • REGULATED_LIFETIME

      public static final RetentionBasis REGULATED_LIFETIME
      The retention period for the data is defined by the referenced regulation.
    • TIMEBOXED_LIFETIME

      public static final RetentionBasis TIMEBOXED_LIFETIME
      The data is needed for the specified time.
    • OTHER

      public static final RetentionBasis OTHER
      Another basis for determining the retention requirement.
  • Method Details

    • values

      public static RetentionBasis[] 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 RetentionBasis 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
    • getOrdinal

      public int getOrdinal()
      Return the code for this enum used for indexing based on the enum value.
      Returns:
      int code number
    • getName

      public String getName()
      Return the default name for this enum type.
      Returns:
      String name
    • getDescription

      public String getDescription()
      Return the default description for this enum.
      Returns:
      String description
    • getOpenTypeOrdinal

      public int getOpenTypeOrdinal()
      Return the code for this enum that comes from the Open Metadata Type that this enum represents.
      Returns:
      int code number
    • getOpenTypeGUID

      public String getOpenTypeGUID()
      Return the unique identifier for the open metadata enum type that this enum class represents.
      Returns:
      string guid
    • getOpenTypeName

      public String getOpenTypeName()
      Return the unique name for the open metadata enum type that this enum class represents.
      Returns:
      string name
    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Enum<RetentionBasis>
      Returns:
      print out of variables in a JSON-style