Class CommentEntity

java.lang.Object
org.camunda.bpm.engine.impl.persistence.entity.CommentEntity
All Implemented Interfaces:
Serializable, DbEntity, HasDbRevision, HistoricEntity, Comment, Event

public class CommentEntity extends Object implements Comment, Event, HasDbRevision, DbEntity, HistoricEntity, Serializable
Author:
Tom Baeyens
See Also:
  • Field Details

    • TYPE_EVENT

      public static final String TYPE_EVENT
      See Also:
    • TYPE_COMMENT

      public static final String TYPE_COMMENT
      See Also:
    • id

      protected String id
    • type

      protected String type
    • userId

      protected String userId
    • time

      protected Date time
    • taskId

      protected String taskId
    • processInstanceId

      protected String processInstanceId
    • action

      protected String action
    • message

      protected String message
    • fullMessage

      protected String fullMessage
    • tenantId

      protected String tenantId
    • rootProcessInstanceId

      protected String rootProcessInstanceId
    • removalTime

      protected Date removalTime
    • revision

      protected int revision
    • MESSAGE_PARTS_MARKER

      public static String MESSAGE_PARTS_MARKER
  • Constructor Details

    • CommentEntity

      public CommentEntity()
  • Method Details

    • getPersistentState

      public Object getPersistentState()
      Description copied from interface: DbEntity
      Returns a representation of the object, as would be stored in the database. Used when deciding if updates have occurred to the object or not since it was last loaded.
      Specified by:
      getPersistentState in interface DbEntity
    • getFullMessageBytes

      public byte[] getFullMessageBytes()
    • setFullMessageBytes

      public void setFullMessageBytes(byte[] fullMessageBytes)
    • setMessage

      public void setMessage(String[] messageParts)
    • getMessageParts

      public List<String> getMessageParts()
      Description copied from interface: Event
      The meaning of the message parts is defined by the action as you can find in Event.getAction()
      Specified by:
      getMessageParts in interface Event
    • getId

      public String getId()
      Description copied from interface: Comment
      comment id
      Specified by:
      getId in interface Comment
      Specified by:
      getId in interface DbEntity
    • setId

      public void setId(String id)
      Specified by:
      setId in interface DbEntity
    • getUserId

      public String getUserId()
      Description copied from interface: Comment
      reference to the user that made the comment
      Specified by:
      getUserId in interface Comment
      Specified by:
      getUserId in interface Event
    • setUserId

      public void setUserId(String userId)
    • getTaskId

      public String getTaskId()
      Description copied from interface: Comment
      reference to the task on which this comment was made
      Specified by:
      getTaskId in interface Comment
      Specified by:
      getTaskId in interface Event
    • setTaskId

      public void setTaskId(String taskId)
    • getMessage

      public String getMessage()
      Description copied from interface: Event
      The message that can be used in case this action only has a single message part.
      Specified by:
      getMessage in interface Event
    • setMessage

      public void setMessage(String message)
    • getTime

      public Date getTime()
      Description copied from interface: Comment
      time and date when the user made the comment
      Specified by:
      getTime in interface Comment
      Specified by:
      getTime in interface Event
    • setTime

      public void setTime(Date time)
    • getProcessInstanceId

      public String getProcessInstanceId()
      Description copied from interface: Comment
      reference to the process instance on which this comment was made
      Specified by:
      getProcessInstanceId in interface Comment
      Specified by:
      getProcessInstanceId in interface Event
    • setProcessInstanceId

      public void setProcessInstanceId(String processInstanceId)
    • getType

      public String getType()
    • setType

      public void setType(String type)
    • getFullMessage

      public String getFullMessage()
      Description copied from interface: Comment
      the full comment message the user had related to the task and/or process instance
      Specified by:
      getFullMessage in interface Comment
      See Also:
    • setFullMessage

      public void setFullMessage(String fullMessage)
    • getAction

      public String getAction()
      Description copied from interface: Event
      Indicates the type of of action and also indicates the meaning of the parts as exposed in Event.getMessageParts()
      Specified by:
      getAction in interface Event
    • setAction

      public void setAction(String action)
    • getTenantId

      public String getTenantId()
    • setTenantId

      public void setTenantId(String tenantId)
    • getRootProcessInstanceId

      public String getRootProcessInstanceId()
      Description copied from interface: Comment
      reference to the root process instance id of the process instance on which this comment was made
      Specified by:
      getRootProcessInstanceId in interface Comment
    • setRootProcessInstanceId

      public void setRootProcessInstanceId(String rootProcessInstanceId)
    • getRemovalTime

      public Date getRemovalTime()
      Description copied from interface: Comment
      The time the historic comment will be removed.
      Specified by:
      getRemovalTime in interface Comment
    • setRemovalTime

      public void setRemovalTime(Date removalTime)
    • toEventMessage

      public String toEventMessage(String message)
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • setRevision

      public void setRevision(int revision)
      Specified by:
      setRevision in interface HasDbRevision
    • getRevision

      public int getRevision()
      Specified by:
      getRevision in interface HasDbRevision
    • getRevisionNext

      public int getRevisionNext()
      Specified by:
      getRevisionNext in interface HasDbRevision