org.jbpm.pvm
Interface Comment

All Known Implementing Classes:
CommentImpl

public interface Comment

a free text comment that can be made to an Execution or a task. This class also supports threaded discussions with the parent-child relation.

Author:
Tom Baeyens

Method Summary
 Comment createReply(java.lang.String text)
          add a reply to this comment
 long getDbid()
          the meaningless database primary key
 java.lang.String getMessage()
          the actual message.
 java.util.List<Comment> getReplies()
          replies to this comment
 Comment getReplyTarget()
          the comment to which this comment is a reply.
 java.util.Date getTime()
          time that specifies when the comment was made
 java.lang.String getUserId()
          the id of the user that made this comment.
 void removeReply(Comment reply)
          remove a reply from this comment.
 

Method Detail

getDbid

long getDbid()
the meaningless database primary key


getUserId

java.lang.String getUserId()
the id of the user that made this comment. The term actorId is an abstract reference to an entity in an external identity component.


getMessage

java.lang.String getMessage()
the actual message. Both plain text as well as HTML can be stored as the message.


getTime

java.util.Date getTime()
time that specifies when the comment was made


createReply

Comment createReply(java.lang.String text)
add a reply to this comment


removeReply

void removeReply(Comment reply)
remove a reply from this comment. This will also remove the inverse relation by setting the reply's replyTarget property to null.


getReplyTarget

Comment getReplyTarget()
the comment to which this comment is a reply.


getReplies

java.util.List<Comment> getReplies()
replies to this comment