org.flowable.engine.task.Comment Maven / Gradle / Ivy
/* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.flowable.engine.task;
import java.util.Date;
import org.flowable.common.engine.api.history.HistoricData;
import org.flowable.engine.TaskService;
/**
* User comments that form discussions around tasks.
*
* @see TaskService#getTaskComments(String)
* @author Tom Baeyens
* @author Joram Barrez
*/
public interface Comment extends HistoricData {
/** unique identifier for this comment */
String getId();
/** reference to the user that made the comment */
String getUserId();
void setUserId(String userId);
/** time and date when the user made the comment */
@Override
Date getTime();
void setTime(Date time);
/** reference to the task on which this comment was made */
String getTaskId();
void setTaskId(String taskId);
/** reference to the process instance on which this comment was made */
String getProcessInstanceId();
void setProcessInstanceId(String processInstanceId);
/** reference to the type given to the comment */
String getType();
void setType(String type);
/**
* the full comment message the user had related to the task and/or process instance
*
* @see TaskService#getTaskComments(String)
*/
String getFullMessage();
void setFullMessage(String fullMessage);
}