Package org.odpi.openmetadata.frameworks.connectors.properties.beans

Class Comment

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
org.odpi.openmetadata.frameworks.connectors.properties.beans.Comment
Direct Known Subclasses:
CommentConversation
public class Comment extends Referenceable
The Comment bean stores information about a comment connected to an asset. Comments provide informal feedback to assets and can be added at any time. Comments have the userId of the person who added the feedback, along with their comment text. The content of the comment is a personal statement (which is why the user's id is in the comment) and there is no formal review of the content.

  • Field Details

    • commentType

      protected CommentType commentType

    • commentText

      protected String commentText

    • user

      protected String user

    • isPublic

      protected boolean isPublic

  • Constructor Details

    • Comment

      public Comment()
      Default constructor

    • Comment

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

  • Method Details

    • getCommentType

      public CommentType getCommentType()
      Return an enum that describes the type of comment.
      Returns:
      CommentType enum

    • setCommentType

      public void setCommentType(CommentType commentType)
      Set up the enum that describes the type of comment.
      Parameters:
      commentType - CommentType enum

    • getCommentText

      public String getCommentText()
      Return the comment text.
      Returns:
      String commentText

    • setCommentText

      public void setCommentText(String commentText)
      Set up the comment text.
      Parameters:
      commentText - String text

    • getUser

      public String getUser()
      Return the user id of the person who created the comment. Null means the user id is not known.
      Returns:
      String commenting user

    • setUser

      public void setUser(String user)
      Set up the user id of the person who created the comment. Null means the user id is not known.
      Parameters:
      user - String commenting user

    • getIsPublic

      public boolean getIsPublic()
      Return if this like is private ot the creating user.
      Returns:
      boolean

    • setIsPublic

      public void setIsPublic(boolean aPublic)
      Set up whether the like is private to the creating user or not.
      Parameters:
      aPublic - boolean

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Referenceable
      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 Referenceable
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Hash of properties
      Overrides:
      hashCode in class Referenceable
      Returns:
      int