Package org.odpi.openmetadata.commonservices.gaf.properties

Class ValidMetadataValue

  • All Implemented Interfaces:
    Serializable
    public class ValidMetadataValue
extends Object
implements Serializable
    ValidMetadataValue provides the properties for a valid metadata value. The preferredValue is the value that is used in the open metadata type.
    See Also:
    Serialized Form

    • Constructor Detail

      • ValidMetadataValue

        public ValidMetadataValue()
        Constructor

      • ValidMetadataValue

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

    • Method Detail

      • 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

      • 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

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​String> additionalProperties)
        Set up additional properties.
        Parameters:
        additionalProperties - Additional properties object

      • getAdditionalProperties

        public Map<String,​String> getAdditionalProperties()
        Return a copy of the additional properties. Null means no additional properties are available.
        Returns:
        AdditionalProperties

      • getEffectiveFrom

        public Date getEffectiveFrom()
        Return the date/time that this element is effective from (null means effective from the epoch).
        Returns:
        date object

      • setEffectiveFrom

        public void setEffectiveFrom​(Date effectiveFrom)
        Set up the date/time that this element is effective from (null means effective from the epoch).
        Parameters:
        effectiveFrom - date object

      • getEffectiveTo

        public Date getEffectiveTo()
        Return the date/time that element is effective to (null means that it is effective indefinitely into the future).
        Returns:
        date object

      • setEffectiveTo

        public void setEffectiveTo​(Date effectiveTo)
        Set the date/time that element is effective to (null means that it is effective indefinitely into the future).
        Parameters:
        effectiveTo - date object

      • toString

        public String toString()
        Generate a string containing the properties.
        Overrides:
        toString in class Object
        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 Object
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison

      • hashCode

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