| Package | Description |
|---|---|
| org.flowable.compatibility | |
| org.flowable.compatibility.wrapper | |
| org.flowable.engine |
Public API of the Flowable engine.
Typical usage of the API starts by the creation of a ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine can be obtained.Through the services obtained from such a ProcessEngine, BPM and workflow operation
can be executed:RepositoryService: Manages Deployments.RuntimeService: For starting and searching ProcessInstances.TaskService: Exposes operations to manage human (standalone) tasks, such as claiming, completing and assigning tasks.IdentityService: Used for managing users, groups and the relations between them.ManagementService: Exposes engine administration and maintenance operations,
which have no relation to the runtime exection of business processes.HistoryService: Exposes information about ongoing and past process instances.FormService: Access to form data and rendered forms for starting new process instances and completing tasks. |
| org.flowable.engine.compatibility | |
| org.flowable.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.flowable.engine.impl.cmd | |
| org.flowable.engine.impl.persistence.entity | |
| org.flowable.engine.impl.persistence.entity.data | |
| org.flowable.engine.impl.persistence.entity.data.impl | |
| org.flowable.rest.service.api | |
| org.flowable.ui.task.model.runtime | |
| org.flowable.ui.task.service.runtime |
| Modifier and Type | Method and Description |
|---|---|
Comment |
DefaultFlowable5CompatibilityHandler.addComment(String taskId,
String processInstanceId,
String type,
String message) |
| Modifier and Type | Class and Description |
|---|---|
class |
Flowable5CommentWrapper
Wraps an v5 comment to an v6
Comment. |
| Modifier and Type | Method and Description |
|---|---|
Comment |
TaskService.addComment(String taskId,
String processInstanceId,
String message)
Add a comment to a task and/or process instance.
|
Comment |
TaskService.addComment(String taskId,
String processInstanceId,
String type,
String message)
Add a comment to a task and/or process instance with a custom type.
|
Comment |
TaskService.getComment(String commentId)
Returns an individual comment with the given id.
|
| Modifier and Type | Method and Description |
|---|---|
List<Comment> |
TaskService.getCommentsByType(String type)
All comments of a given type.
|
List<Comment> |
TaskService.getProcessInstanceComments(String processInstanceId)
The comments related to the given process instance.
|
List<Comment> |
TaskService.getProcessInstanceComments(String processInstanceId,
String type)
The comments related to the given process instance.
|
List<Comment> |
TaskService.getTaskComments(String taskId)
The comments related to the given task.
|
List<Comment> |
TaskService.getTaskComments(String taskId,
String type)
The comments related to the given task of the given type.
|
| Modifier and Type | Method and Description |
|---|---|
void |
TaskService.saveComment(Comment comment)
Update a comment to a task and/or process instance.
|
| Modifier and Type | Method and Description |
|---|---|
Comment |
Flowable5CompatibilityHandler.addComment(String taskId,
String processInstanceId,
String type,
String message) |
| Modifier and Type | Method and Description |
|---|---|
Comment |
TaskServiceImpl.addComment(String taskId,
String processInstance,
String message) |
Comment |
TaskServiceImpl.addComment(String taskId,
String processInstance,
String type,
String message) |
Comment |
TaskServiceImpl.getComment(String commentId) |
| Modifier and Type | Method and Description |
|---|---|
List<Comment> |
TaskServiceImpl.getCommentsByType(String type) |
List<Comment> |
TaskServiceImpl.getProcessInstanceComments(String processInstanceId) |
List<Comment> |
TaskServiceImpl.getProcessInstanceComments(String processInstanceId,
String type) |
List<Comment> |
TaskServiceImpl.getTaskComments(String taskId) |
List<Comment> |
TaskServiceImpl.getTaskComments(String taskId,
String type) |
| Modifier and Type | Method and Description |
|---|---|
void |
TaskServiceImpl.saveComment(Comment comment) |
| Modifier and Type | Method and Description |
|---|---|
Comment |
GetCommentCmd.execute(CommandContext commandContext) |
Comment |
AddCommentCmd.execute(CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
List<Comment> |
GetProcessInstanceCommentsCmd.execute(CommandContext commandContext) |
List<Comment> |
GetTypeCommentsCmd.execute(CommandContext commandContext) |
List<Comment> |
GetTaskCommentsCmd.execute(CommandContext commandContext) |
List<Comment> |
GetTaskCommentsByTypeCmd.execute(CommandContext commandContext) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CommentEntity |
| Modifier and Type | Class and Description |
|---|---|
class |
CommentEntityImpl |
| Modifier and Type | Method and Description |
|---|---|
Comment |
CommentEntityManagerImpl.findComment(String commentId) |
Comment |
CommentEntityManager.findComment(String commentId) |
| Modifier and Type | Method and Description |
|---|---|
List<Comment> |
CommentEntityManagerImpl.findCommentsByProcessInstanceId(String processInstanceId) |
List<Comment> |
CommentEntityManager.findCommentsByProcessInstanceId(String processInstanceId) |
List<Comment> |
CommentEntityManagerImpl.findCommentsByProcessInstanceId(String processInstanceId,
String type) |
List<Comment> |
CommentEntityManager.findCommentsByProcessInstanceId(String processInstanceId,
String type) |
List<Comment> |
CommentEntityManagerImpl.findCommentsByTaskId(String taskId) |
List<Comment> |
CommentEntityManager.findCommentsByTaskId(String taskId) |
List<Comment> |
CommentEntityManagerImpl.findCommentsByTaskIdAndType(String taskId,
String type) |
List<Comment> |
CommentEntityManager.findCommentsByTaskIdAndType(String taskId,
String type) |
List<Comment> |
CommentEntityManagerImpl.findCommentsByType(String type) |
List<Comment> |
CommentEntityManager.findCommentsByType(String type) |
| Modifier and Type | Method and Description |
|---|---|
Comment |
CommentDataManager.findComment(String commentId) |
| Modifier and Type | Method and Description |
|---|---|
List<Comment> |
CommentDataManager.findCommentsByProcessInstanceId(String processInstanceId) |
List<Comment> |
CommentDataManager.findCommentsByProcessInstanceId(String processInstanceId,
String type) |
List<Comment> |
CommentDataManager.findCommentsByTaskId(String taskId) |
List<Comment> |
CommentDataManager.findCommentsByTaskIdAndType(String taskId,
String type) |
List<Comment> |
CommentDataManager.findCommentsByType(String type) |
| Modifier and Type | Method and Description |
|---|---|
Comment |
MybatisCommentDataManager.findComment(String commentId) |
| Modifier and Type | Method and Description |
|---|---|
List<Comment> |
MybatisCommentDataManager.findCommentsByProcessInstanceId(String processInstanceId) |
List<Comment> |
MybatisCommentDataManager.findCommentsByProcessInstanceId(String processInstanceId,
String type) |
List<Comment> |
MybatisCommentDataManager.findCommentsByTaskId(String taskId) |
List<Comment> |
MybatisCommentDataManager.findCommentsByTaskIdAndType(String taskId,
String type) |
List<Comment> |
MybatisCommentDataManager.findCommentsByType(String type) |
| Modifier and Type | Method and Description |
|---|---|
CommentResponse |
RestResponseFactory.createRestComment(Comment comment) |
CommentResponse |
RestResponseFactory.createRestComment(Comment comment,
RestUrlBuilder urlBuilder) |
| Modifier and Type | Method and Description |
|---|---|
List<CommentResponse> |
RestResponseFactory.createRestCommentList(List<Comment> comments) |
| Constructor and Description |
|---|
CommentRepresentation(Comment comment) |
| Modifier and Type | Method and Description |
|---|---|
Comment |
FlowableCommentService.createComment(String message,
SecurityScope createdBy,
String processInstanceId) |
Comment |
FlowableCommentService.createComment(String message,
SecurityScope createdBy,
String taskId,
String processInstanceId) |
| Modifier and Type | Method and Description |
|---|---|
List<Comment> |
FlowableCommentService.getCommentsForProcessInstance(String processInstanceId) |
List<Comment> |
FlowableCommentService.getCommentsForTask(String taskId) |
| Modifier and Type | Method and Description |
|---|---|
void |
FlowableCommentService.deleteComment(Comment comment) |
Copyright © 2023 Flowable. All rights reserved.