Class CommentProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class CommentProperties
    extends ReferenceableProperties
    The CommentProperties 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.
    See Also:
    Serialized Form
    • Constructor Detail

      • CommentProperties

        public CommentProperties()
        Default constructor
      • CommentProperties

        public CommentProperties​(CommentProperties template)
        Copy/clone constructor.
        Parameters:
        template - element to copy
    • Method Detail

      • 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 java.lang.String getCommentText()
        Return the comment text.
        Returns:
        String commentText
      • setCommentText

        public void setCommentText​(java.lang.String commentText)
        Set up the comment text.
        Parameters:
        commentText - String text
      • getUser

        public java.lang.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​(java.lang.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 whether the comment is private to the creating user or not.
        Returns:
        boolean
      • setIsPublic

        public void setIsPublic​(boolean isPublic)
        Set up whether the comment is private to the creating user or not.
        Parameters:
        isPublic - boolean
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class ReferenceableProperties
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.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