java.lang.Object
java.lang.Enum<StarRating>
org.odpi.openmetadata.accessservices.assetmanager.properties.StarRating
All Implemented Interfaces:
Serializable, Comparable<StarRating>, Constable

public enum StarRating extends Enum<StarRating>
A StarRating defines the rating that a user has placed against an asset. This ranges from not recommended through to five stars (excellent).
  • Enum Constant Details

    • NO_RECOMMENDATION

      public static final StarRating NO_RECOMMENDATION
      No recommendation.
    • ONE_STAR

      public static final StarRating ONE_STAR
      Poor
    • TWO_STARS

      public static final StarRating TWO_STARS
      Usable
    • THREE_STARS

      public static final StarRating THREE_STARS
      Good
    • FOUR_STARS

      public static final StarRating FOUR_STARS
      Very good
    • FIVE_STARS

      public static final StarRating FIVE_STARS
      Excellent
  • Method Details

    • values

      public static StarRating[] 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 StarRating 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 instance
      Returns:
      int star rating code
    • getName

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

      public String getDescription()
      Return the default description for the star rating for this enum instance.
      Returns:
      String default 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<StarRating>
      Returns:
      print out of variables in a JSON-style