Package org.odpi.openmetadata.frameworks.openmetadata.metadataelements

Class ValidValueElement

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement
All Implemented Interfaces:
MetadataElement
public class ValidValueElement extends Object implements MetadataElement
ValidValueElement contains the properties and header for a valid value definition or set entity retrieved from the metadata repository.

  • Constructor Details

    • ValidValueElement

      public ValidValueElement()
      Default constructor

    • ValidValueElement

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

  • Method Details

    • getElementHeader

      public ElementHeader getElementHeader()
      Return the element header associated with the properties.
      Specified by:
      getElementHeader in interface MetadataElement
      Returns:
      element header object

    • setElementHeader

      public void setElementHeader(ElementHeader elementHeader)
      Set up the element header associated with the properties.
      Specified by:
      setElementHeader in interface MetadataElement
      Parameters:
      elementHeader - element header object

    • getValidValueProperties

      public ValidValueProperties getValidValueProperties()
      Return the properties for the valid value definition or set.
      Returns:
      properties bean

    • setValidValueProperties

      public void setValidValueProperties(ValidValueProperties validValueProperties)
      Set up the properties for the valid value definition or set.
      Parameters:
      validValueProperties - properties bean

    • getSetGUID

      public String getSetGUID()
      Return the set unique identifier if the valid value is retrieved via a set.
      Returns:
      string identifier

    • setSetGUID

      public void setSetGUID(String setGUID)
      Set up the set unique identifier if the valid value is retrieved via a set.
      Parameters:
      setGUID - string identifier

    • getIsDefaultValue

      public boolean getIsDefaultValue()
      Return whether this valid value is the default of the setGUID (if supplied)
      Returns:
      flag

    • setIsDefaultValue

      public void setIsDefaultValue(boolean defaultValue)
      Set up whether this valid value is the default of the setGUID (if supplied).
      Parameters:
      defaultValue - flag

    • getRelatedElement

      public RelatedElement getRelatedElement()
      Return information about the related element and relationship (if any) that was used to retrieve the valid value.
      Returns:
      related element

    • setRelatedElement

      public void setRelatedElement(RelatedElement relatedElement)
      Set up information about the related element and relationship (if any) that was used to retrieve the valid value.
      Parameters:
      relatedElement - related element

    • toString

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

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code