Package org.odpi.openmetadata.accessservices.assetowner.properties

Class SupplementaryProperties

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    AssetProperties
    public class SupplementaryProperties
extends ReferenceableProperties
    SupplementaryProperties describe additional information about a technical element (typically assets and schemas) that has been added as part of a governance process.
    See Also:
    Serialized Form

    • Constructor Detail

      • SupplementaryProperties

        public SupplementaryProperties()
        Default constructor

      • SupplementaryProperties

        public SupplementaryProperties​(SupplementaryProperties template)
        Copy/clone constructor. Note, this is a deep copy
        Parameters:
        template - object to copy

    • Method Detail

      • getDisplayName

        public String getDisplayName()
        Returns the stored display name property for the technical element. 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 technical element.
        Parameters:
        displayName - String name

      • getDisplaySummary

        public String getDisplaySummary()
        Return the short (1-2 sentence) description of the technical element.
        Returns:
        string text

      • setDisplaySummary

        public void setDisplaySummary​(String displaySummary)
        Set up the short (1-2 sentence) description of the technical element.
        Parameters:
        displaySummary - string text

      • getDisplayDescription

        public String getDisplayDescription()
        Returns the stored description property for the technical element. If no description is provided then null is returned.
        Returns:
        String text

      • setDisplayDescription

        public void setDisplayDescription​(String displayDescription)
        Set up the stored description property for the technical element.
        Parameters:
        displayDescription - String text

      • getAbbreviation

        public String getAbbreviation()
        Return the abbreviation used for this technical element.
        Returns:
        string text

      • setAbbreviation

        public void setAbbreviation​(String abbreviation)
        Set up the abbreviation used for this technical element.
        Parameters:
        abbreviation - string text

      • getUsage

        public String getUsage()
        Return details of the expected usage of this technical element.
        Returns:
        string text

      • setUsage

        public void setUsage​(String usage)
        Set up details of the expected usage of this technical element.
        Parameters:
        usage - string text

      • equals

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