Package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest

Class TagRequestBody

java.lang.Object
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.OCFOMASAPIRequestBody
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.FeedbackRequestBody
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.TagRequestBody
public class TagRequestBody extends FeedbackRequestBody
TagRequestBody provides a structure for passing an informal tag as a request body over a REST API.

  • Constructor Details

    • TagRequestBody

      public TagRequestBody()
      Default constructor

    • TagRequestBody

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

  • Method Details

    • getTagName

      public String getTagName()
      Return the name of the tag.
      Returns:
      string

    • setTagName

      public void setTagName(String tagName)
      Set up the name of the tag.
      Parameters:
      tagName - string

    • getTagDescription

      public String getTagDescription()
      Return the description that accompanies the tag.
      Returns:
      string description

    • setTagDescription

      public void setTagDescription(String tagDescription)
      Set up the description that accompanies the tag.
      Parameters:
      tagDescription - String (optional) description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class FeedbackRequestBody
      Returns:
      list of properties and their values.

    • equals

      public boolean equals(Object objectToCompare)
      Equals method that returns true if containing properties are the same.
      Overrides:
      equals in class FeedbackRequestBody
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

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