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

Enum Class SurveyActionTarget

java.lang.Object
java.lang.Enum<SurveyActionTarget>
org.odpi.openmetadata.frameworks.surveyaction.controls.SurveyActionTarget
All Implemented Interfaces:
Serializable, Comparable<SurveyActionTarget>, Constable
public enum SurveyActionTarget extends Enum<SurveyActionTarget>
SurveyActionTarget provides some standard action type names to use in the implementation of survey action services.

  • Enum Constant Details

    • SURVEY_REPORT

      public static final SurveyActionTarget SURVEY_REPORT
      The survey report created by a survey action service.

  • Field Details

    • name

      public final String name
      Action target name

    • description

      public final String description
      Description of the action target.

    • typeName

      public final String typeName
      The open metadata type name of the element that can be this type of action target.

  • Method Details

    • values

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

    • getActionTargetTypes

      public static List<ActionTargetType> getActionTargetTypes()
      Return all the action targets defined in this enum.
      Returns:
      list

    • getActionTargetType

      public ActionTargetType getActionTargetType()
      Return an action target type for use in the governance action service's provider.
      Returns:
      action target type

    • getName

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

    • getDescription

      public String getDescription()
      Return the description of the action target.
      Returns:
      string description

    • getTypeName

      public String getTypeName()
      Return the type name of the element that is linked to for this type of action target.
      Returns:
      type name

    • getDeployedImplementationType

      public String getDeployedImplementationType()
      Return the preferred value of the deployed implementation type of the element that is linked to for this type of action target. This is typically only set for assets.
      Returns:
      preferred value string

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<SurveyActionTarget>
      Returns:
      return string containing the property names and values