Package org.odpi.openmetadata.frameworks.openmetadata.properties.feedback

Class SearchKeywordProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.EntityProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.SearchKeywordProperties
public class SearchKeywordProperties extends OpenMetadataRootProperties
SearchKeywordProperties stores information about a search keyword tag connected to a referenceable. Search keywords are typically anchored to an element so that they are included in the search scope for the referenceable.

  • Constructor Details

    • SearchKeywordProperties

      public SearchKeywordProperties()
      Default constructor

    • SearchKeywordProperties

      public SearchKeywordProperties(SearchKeywordProperties template)
      Copy/clone constructor.
      Parameters:
      template - element to copy

  • Method Details

    • getDisplayName

      public String getDisplayName()
      Return the name of the keyword.
      Returns:
      String tag name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the name of the keyword.
      Parameters:
      displayName - String tag name

    • getDescription

      public String getDescription()
      Return the optional keyword description.
      Returns:
      String tag description

    • setDescription

      public void setDescription(String description)
      Set up the the optional keyword description.
      Parameters:
      description - tag description

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class OpenMetadataRootProperties
      Returns:
      print out of variables in a JSON-style

    • equals

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

    • hashCode

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