Package org.odpi.openmetadata.frameworks.surveyaction.controls

Enum Class SurveyActionGuard

java.lang.Object
java.lang.Enum<SurveyActionGuard>
org.odpi.openmetadata.frameworks.surveyaction.controls.SurveyActionGuard
All Implemented Interfaces:
Serializable, Comparable<SurveyActionGuard>, Constable
public enum SurveyActionGuard extends Enum<SurveyActionGuard>
The SurveyActionGuard enum describes the standard guards that are automatically set up for all survey action services.

  • Enum Constant Details

  • Field Details

    • name

      public final String name

    • completionStatus

      public final CompletionStatus completionStatus

    • description

      public final String description

  • Method Details

    • values

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

    • getName

      public String getName()
      Return the name of the guard.
      Returns:
      string name

    • getCompletionStatus

      public CompletionStatus getCompletionStatus()
      Return the typical completion status used with this guard.
      Returns:
      completion status

    • getDescription

      public String getDescription()
      Return the description of the guard.
      Returns:
      text

    • getSimpleSurveyGuardTypes

      public static List<GuardType> getSimpleSurveyGuardTypes()
      Return details of the guards used on a simple survey. These guards are set automatically if the survey does not set a guard itself.
      Returns:
      guard types

    • getDataValidationSurveyGuardTypes

      public static List<GuardType> getDataValidationSurveyGuardTypes()
      Return details of the guards used on a survey that is validating the structure and content of data. Each check produces a Qualify Annotation. If all checks pass, the certification is added to the asset. If any checks fail, a request for action is created for the asset, linking the failing quality annotations.
      Returns:
      guard types

    • getGuardType

      public GuardType getGuardType()
      Return the details of a specific guard.
      Returns:
      guard type

    • toString

      public String toString()
      Output of this enum class and main value.
      Overrides:
      toString in class Enum<SurveyActionGuard>
      Returns:
      string showing enum value