org.camunda.bpm.engine.impl.persistence.entity

Class CommentEntity

java.lang.Object

org.camunda.bpm.engine.impl.persistence.entity.CommentEntity

All Implemented Interfaces:

Serializable, DbEntity, HistoricEntity, Comment, Event

public class CommentEntity
extends Object
implements Comment, Event, DbEntity, HistoricEntity, Serializable

Author:

Tom Baeyens

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	action
protected String	fullMessage
protected String	id
protected String	message
static String	MESSAGE_PARTS_MARKER
protected String	processInstanceId
protected Date	removalTime
protected String	rootProcessInstanceId
protected String	taskId
protected String	tenantId
protected Date	time
protected String	type
static String	TYPE_COMMENT
static String	TYPE_EVENT
protected String	userId

Fields inherited from interface org.camunda.bpm.engine.task.Event

ACTION_ADD_ATTACHMENT, ACTION_ADD_COMMENT, ACTION_ADD_GROUP_LINK, ACTION_ADD_USER_LINK, ACTION_DELETE_ATTACHMENT, ACTION_DELETE_GROUP_LINK, ACTION_DELETE_USER_LINK

Constructor Summary

Constructors

Constructor and Description
CommentEntity()

Method Summary

Modifier and Type	Method and Description
String	getAction() Indicates the type of of action and also indicates the meaning of the parts as exposed in Event.getMessageParts()
String	getFullMessage() the full comment message the user had related to the task and/or process instance
byte[]	getFullMessageBytes()
String	getId() comment id
String	getMessage() The message that can be used in case this action only has a single message part.
List<String>	getMessageParts() The meaning of the message parts is defined by the action as you can find in Event.getAction()
Object	getPersistentState() Returns a representation of the object, as would be stored in the database.
String	getProcessInstanceId() reference to the process instance on which this comment was made
Date	getRemovalTime() The time the historic comment will be removed.
String	getRootProcessInstanceId() reference to the root process instance id of the process instance on which this comment was made
String	getTaskId() reference to the task on which this comment was made
String	getTenantId()
Date	getTime() time and date when the user made the comment
String	getType()
String	getUserId() reference to the user that made the comment
void	setAction(String action)
void	setFullMessage(String fullMessage)
void	setFullMessageBytes(byte[] fullMessageBytes)
void	setId(String id)
void	setMessage(String message)
void	setMessage(String[] messageParts)
void	setProcessInstanceId(String processInstanceId)
void	setRemovalTime(Date removalTime)
void	setRootProcessInstanceId(String rootProcessInstanceId)
void	setTaskId(String taskId)
void	setTenantId(String tenantId)
void	setTime(Date time)
void	setType(String type)
void	setUserId(String userId)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_EVENT

public static final String TYPE_EVENT

See Also:

Constant Field Values

TYPE_COMMENT

public static final String TYPE_COMMENT

See Also:

Constant Field Values

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

MESSAGE_PARTS_MARKER

public static String MESSAGE_PARTS_MARKER

Constructor Detail

CommentEntity

public CommentEntity()

Method Detail

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 DbEntity

Specified by:

getId in interface Comment

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:

TaskService.getTaskComments(String)

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)

toString

public String toString()

Overrides:

toString in class Object