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

Class ValidValue

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.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
Direct Known Subclasses:
ValidValueDefinition, ValidValueSet
public class ValidValue extends Referenceable
ValidValue provides the common super class for ValidValueSet and ValidValueDefinition.

  • Field Summary

    Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

    CURRENT_AUDIT_HEADER_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    ValidValue()
    Constructor
    ValidValue(ValidValue template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    String
    getDataType()
    Returns the data type of the preferred value.
    String
    getDescription()
    Returns the stored description property for the valid value.
    String
    getDisplayName()
    Returns the stored display name property for the valid value.
    boolean
    getIsDeprecated()
    Is the valid value deprecated?
    String
    getPreferredValue()
    Return the preferred values to use in implementations (normally used with definitions)
    String
    getScope()
    Return the scope of values that this valid value covers (normally used with sets)
    String
    getUsage()
    Return the description of how this valid value should be used.
    int
    hashCode()
    Return hash code based on properties.
    void
    setDataType(String dataType)
    Set up the data type of the preferred value.
    void
    setDescription(String description)
    Set up the stored description property associated with the valid value.
    void
    setDisplayName(String displayName)
    Set up the stored display name property for the valid value.
    void
    setIsDeprecated(boolean deprecated)
    Set whether the valid value is deprecated or not.
    void
    setPreferredValue(String preferredValue)
    Set up the preferred values to use in implementations (normally used with definitions)
    void
    setScope(String scope)
    Set up the scope of values that this valid value covers (normally used with sets)
    void
    setUsage(String usage)
    Set up the description of how this valid value should be used.
    String
    toString()
    Generate a string containing the properties.

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

    getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

    getExtendedProperties, setExtendedProperties

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader

    getClassifications, getGUID, setClassifications, setGUID

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

    getHeaderVersion, getOrigin, getStatus, getType, getVersions, setHeaderVersion, setOrigin, setStatus, setType, setVersions

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • 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