Package org.odpi.openmetadata.accessservices.assetconsumer.rest

Class CommentRequestBody

java.lang.Object
org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIRequestBody
org.odpi.openmetadata.accessservices.assetconsumer.rest.FeedbackRequestBody
org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody
public class CommentRequestBody extends FeedbackRequestBody
The CommentRequestBody 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.

  • Constructor Details

    • CommentRequestBody

      public CommentRequestBody()
      Default constructor

    • CommentRequestBody

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

  • Method Details

    • getCommentType

      public org.odpi.openmetadata.frameworks.connectors.properties.beans.CommentType getCommentType()
      Return an enum that describes the type of comment.
      Returns:
      CommentType enum

    • setCommentType

      public void setCommentType(org.odpi.openmetadata.frameworks.connectors.properties.beans.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

    • toString

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

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class FeedbackRequestBody
      Returns:
      int hash code