Package org.odpi.openmetadata.frameworks.connectors.properties.beans

Class ValidValue

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
org.odpi.openmetadata.frameworks.connectors.properties.beans.ValidValue
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ValidValueDefinition, ValidValueSet
public class ValidValue extends Referenceable
ValidValue provides the common super class for ValidValueSet and ValidValueDefinition.
See Also:

  • Field Details

    • displayName

      protected String displayName

    • description

      protected String description

    • usage

      protected String usage

    • scope

      protected String scope

    • preferredValue

      protected String preferredValue

    • dataType

      protected String dataType

    • isDeprecated

      protected boolean isDeprecated

  • Constructor Details

    • ValidValue

      public ValidValue()
      Constructor

    • ValidValue

      public ValidValue(ValidValue template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getDisplayName

      public String getDisplayName()
      Returns the stored display name property for the valid value. If no display name is available then null is returned.
      Returns:
      String name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the stored display name property for the valid value.
      Parameters:
      displayName - String name

    • getDescription

      public String getDescription()
      Returns the stored description property for the valid value. If no description is provided then null is returned.
      Returns:
      description String text

    • setDescription

      public void setDescription(String description)
      Set up the stored description property associated with the valid value.
      Parameters:
      description - String text

    • getUsage

      public String getUsage()
      Return the description of how this valid value should be used.
      Returns:
      String text

    • setUsage

      public void setUsage(String usage)
      Set up the description of how this valid value should be used.
      Parameters:
      usage - String text

    • getScope

      public String getScope()
      Return the scope of values that this valid value covers (normally used with sets)
      Returns:
      String text

    • setScope

      public void setScope(String scope)
      Set up the scope of values that this valid value covers (normally used with sets)
      Parameters:
      scope - String text

    • getPreferredValue

      public String getPreferredValue()
      Return the preferred values to use in implementations (normally used with definitions)
      Returns:
      String value

    • setPreferredValue

      public void setPreferredValue(String preferredValue)
      Set up the preferred values to use in implementations (normally used with definitions)
      Parameters:
      preferredValue - String value

    • getDataType

      public String getDataType()
      Returns the data type of the preferred value.
      Returns:
      string

    • setDataType

      public void setDataType(String dataType)
      Set up the data type of the preferred value.
      Parameters:
      dataType - string

    • getIsDeprecated

      public boolean getIsDeprecated()
      Is the valid value deprecated?
      Returns:
      boolean flag

    • setIsDeprecated

      public void setIsDeprecated(boolean deprecated)
      Set whether the valid value is deprecated or not. Default is false.
      Parameters:
      deprecated - boolean flag

    • toString

      public String toString()
      Generate a string containing the properties.
      Overrides:
      toString in class Referenceable
      Returns:
      string value

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Referenceable
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class Referenceable
      Returns:
      int