Flowable主要API介绍

1. ProcessEngine

        负责与各个服务进行交互和管理流程的整个生命周期。

方法 描述
getName()
close()
startExecutors() 启动所有流程引擎中的执行器。执行器用于处理流程实例的执行,在引擎启动时,执行器会自动运行并处理待办任务和定时任务。
getRepositoryService() 获取流程仓库服务对象。用于管理流程定义的部署和查询。
getRuntimeService() 获取运行时服务对象。用于操作流程的运行时数据,如启动流程实例、执行流程任务、查询流程实例状态等。
getFormService() 获取表单服务对象。用于管理表单数据和处理与表单相关的操作,如获取表单内容、保存表单数据等。
getTaskService() 获取任务服务对象。用于管理任务数据和处理与任务相关的操作,如创建任务、完成任务、查询任务列表等。
getHistoryService() 获取历史数据服务对象。用于访问和查询流程的历史数据,如查询已完成的流程实例、查询历史任务等。
getIdentityService() 获取身份验证和授权服务对象。用于管理用户、组、角色等身份信息,以及进行权限和身份验证的操作。
getManagementService() 获取管理服务对象。用于进行底层的引擎管理和操作,如数据库管理、作业管理、引擎配置等。
getDynamicBpmnService() 获取动态 BPMN 服务对象。用于动态修改流程定义的流程元素,如添加活动、删除活动、修改连线等。
getProcessMigrationService() 获取流程迁移服务对象。用于支持流程定义的迁移操作,如迁移流程实例、修改流程定义版本等。
getProcessEngineConfiguration() 获取流程引擎的配置对象。可以通过配置对象进行流程引擎的详细配置和定制,如数据库配置、作业调度配置、缓存配置等。

2. RepositoryService

        RepositoryService 是 Flowable 引擎中的服务之一,用于管理流程定义的部署和查询。它提供了一系列方法,用于管理流程定义的生命周期、与流程定义相关的资源、以及对流程定义的查询操作。

方法 描述

createDeployment();

创建一个流程部署。通过该方法可以将流程定义的相关文件(如 BPMN 文件和表单文件)进行打包并进行部署。返回一个 DeploymentBuilder 对象,可以进行更多的设置和操作,之后可以通过调用 deploy 方法进行真正的部署操作。
deleteDeployment(String var1);
deleteDeployment(String var1, boolean var2);
删除指定的流程部署。可以选择级联删除相关的流程实例、历史数据等。如果指定了级联删除选项,则会同时删除与该部署相关的流程实例、历史数据、任务等。
setDeploymentCategory(String var1, String var2); 为指定的流程部署设置分类。可以用来给部署定义一个分类,便于对部署进行归类和组织管理。
setProcessDefinitionCategory(String var1, String var2); 设置指定流程定义的分类。可以为流程定义设置一个分类,便于对流程进行归类和组织。
setDeploymentKey(String var1, String var2); 为指定的流程部署设置关键字。可以用来给部署定义一个唯一的关键字,便于后续对部署进行标识和引用。
getDeploymentResourceNames(String var1); 获取指定流程部署的资源名称列表。返回一个包含资源名称的列表,如 BPMN 文件、表单文件、图片等。
getResourceAsStream(String var1, String var2); 获取指定流程部署中的资源流。通过资源名称(如 BPMN 文件名)可以获取资源的输入流,实现对资源的读取和处理。

changeDeploymentTenantId(String var1, String var2);
changeDeploymentTenantId(String var1, String var2,

                                                MergeMode var3);
changeDeploymentTenantId(String var1, String var2,

                                                DeploymentMergeStrategy var3);

修改指定流程部署的租户 ID。可以将一个流程部署从一个租户迁移到另一个租户,或者为一个流程部署设置租户 ID。
changeDeploymentParentDeploymentId(String var1, String var2); 修改指定流程部署的父部署 ID。可以将一个流程部署设为另一个流程部署的子部署,实现流程部署的组织和管理。
createProcessDefinitionQuery(); 创建一个流程定义查询对象。可以通过该查询对象对流程定义进行条件过滤、排序等操作。
createNativeProcessDefinitionQuery(); 创建一个原生 SQL 的流程定义查询。可以使用原生的 SQL 语句对流程定义进行查询。
createDeploymentQuery(); 创建一个流程部署查询对象。可以通过该查询对象对流程部署进行条件过滤、排序等操作。
createNativeDeploymentQuery(); 创建一个原生 SQL 的流程部署查询。可以使用原生的 SQL 语句对流程部署进行查询。
suspendProcessDefinitionById(String var1);
suspendProcessDefinitionById(String var1, boolean var2, Date var3);
暂停指定 ID 的流程定义。暂停后,将无法启动该流程定义的新流程实例,已经运行中的流程实例将继续执行。
activateProcessDefinitionById(String var1);
activateProcessDefinitionById(String var1, boolean var2, Date var3);
激活指定 ID 的流程定义。激活后,可以启动该流程定义的新流程实例。

suspendProcessDefinitionByKey(String var1);
suspendProcessDefinitionByKey(String var1, boolean var2, Date var3);
suspendProcessDefinitionByKey(String var1, String var2);
suspendProcessDefinitionByKey(String var1, boolean var2,

                                                     Date var3, String var4);

暂停指定Key 的流程定义。

activateProcessDefinitionByKey(String var1);
activateProcessDefinitionByKey(String var1, boolean var2, Date var3);
activateProcessDefinitionByKey(String var1, String var2);
activateProcessDefinitionByKey(String var1, boolean var2,

                                                    Date var3, String var4);

激活指定Key 的流程定义。
getProcessModel(String var1); 获取指定流程定义的 BPMN 模型。返回一个对象表示流程定义的 BPMN 模型,可用于解析和处理流程定义的各个元素。
getProcessDiagram(String var1); 获取指定流程定义的流程图。返回一个流程图的输入流,通常可用于展示和显示流程定义的流程图。
getProcessDefinition(String var1); 获取指定流程定义的详细信息。返回一个 ProcessDefinition 对象,包含了流程定义的各个属性和元数据。
isFlowable5ProcessDefinition(String var1); 判断指定流程定义是否为 Flowable 5 版本的流程定义。
isProcessDefinitionSuspended(String var1); 判断指定流程定义是否被暂停。
getBpmnModel(String var1); 获取指定流程定义的 BPMN 模型。
getProcessDiagramLayout(String var1); 获取指定流程定义的流程图布局信息,包括各个节点的位置和连线的路由信息。
getAppResourceObject(String var1); 获取指定 App 部署的资源文件。
getAppResourceModel(String var1); 获取指定 App 部署的资源文件,并解析为 AppModel 对象。

newModel();

saveModel(Model var1);

deleteModel(String var1);

创建、保存、删除指定模型。
addModelEditorSource(String var1, byte[] var2); 向指定模型添加编辑器源码。
addModelEditorSourceExtra(String var1, byte[] var2); 向指定模型添加附加的编辑器源码。
createModelQuery(); 创建一个模型查询对象。
createNativeModelQuery(); 创建一个原生 SQL 的模型查询。
getModel(String var1); 获取指定 ID 的模型。
getModelEditorSource(String var1); 获取指定模型的编辑器源码。
getModelEditorSourceExtra(String var1); 获取指定模型的附加编辑器源码。
addCandidateStarterUser(String var1, String var2); 为指定流程定义添加候选启动用户。
deleteCandidateStarterUser(String var1, String var2); 从指定流程定义中删除候选启动用户。
addCandidateStarterGroup(String var1, String var2); 为指定流程定义添加候选启动用户组。
deleteCandidateStarterGroup(String var1, String var2); 从指定流程定义中删除候选启动用户组。
getIdentityLinksForProcessDefinition(String var1); 获取与指定流程定义相关的身份链接。
validateProcess(BpmnModel var1); 验证指定的流程定义的 BPMN 文件是否有效。
getDecisionsForProcessDefinition(String var1); 获取与指定流程定义相关的决策表。
getFormDefinitionsForProcessDefinition(String var1); 获取与指定流程定义相关的表单定义。

3. RuntimeService

        RuntimeService是Flowable引擎中的一个服务接口,用于管理流程实例的运行时状态和相关操作。

方法 描述

createProcessInstanceBuilder();

创建一个流程实例构建器,用于构建流程实例的启动参数。

startProcessInstanceByKey(String var1);
startProcessInstanceByKey(String var1, String var2);
startProcessInstanceByKey(String var1, Map var2);
startProcessInstanceByKey(String var1, String var2,

                                            Map var3);

根据流程定义的键启动一个流程实例。该方法会自动选择最新版本的流程定义进行启动。

startProcessInstanceByKeyAndTenantId(String var1, String var2);
startProcessInstanceByKeyAndTenantId(String var1, String var2,

                                                                String var3);
startProcessInstanceByKeyAndTenantId(String var1,

                                                        Map var2, String var3);
startProcessInstanceByKeyAndTenantId(String var1,

                                        String var2, Map var3, String var4)

根据流程定义的键和租户ID启动一个流程实例。租户ID可用于多租户环境中对流程实例进行区分。

startProcessInstanceById(String var1);
startProcessInstanceById(String var1, String var2);
startProcessInstanceById(String var1, Map var2);
startProcessInstanceById(String var1, String var2,

                                         Map var3);

根据流程定义的ID启动一个流程实例。

startProcessInstanceWithForm(String var1, String var2,

                                                  Map var3, String var4);

根据带有表单数据的流程定义启动一个流程实例。启动时可以传入表单数据作为流程实例的初始变量。

startProcessInstanceByMessage(String var1);
startProcessInstanceByMessage(String var1, String var2);
startProcessInstanceByMessage(String var1, Map var2);
startProcessInstanceByMessage(String var1, String var2,

                                                                        Map var3);

根据消息触发启动一个流程实例。通过指定消息名称来触发相应的流程实例启动事件。

startProcessInstanceByMessageAndTenantId(String var1, String var2);

startProcessInstanceByMessageAndTenantId(String var1,

                                                                        String var2, String var3);

startProcessInstanceByMessageAndTenantId(String var1,

                                                         Map var2, String var3);

startProcessInstanceByMessageAndTenantId(String var1, String var2,

                                                          Map var3, String var4)

根据消息和租户id触发启动一个流程实例。
getStartFormModel(String var1, String var2);

deleteProcessInstance(String var1, String var2);

删除指定ID的流程实例。该方法会删除对应流程实例的所有相关数据,包括运行时数据、历史数据等。
bulkDeleteProcessInstances(Collection var1, String var2); 批量删除符合条件的流程实例。可以根据不同的查询条件删除满足条件的多个流程实例。
getActiveActivityIds(String var1); 获取指定流程实例ID当前活动的活动ID列表。可用于查询当前正在执行的活动节点。
trigger(String var1);
trigger(String var1, Map var2);
trigger(String var1, Map var2, Map var3);
触发指定ID的流程实例的等待状态。用于向等待或暂停状态的流程实例发送信号,使其继续执行。

triggerAsync(String var1);

triggerAsync(String var1, Map var2);

evaluateConditionalEvents(String var1);
evaluateConditionalEvents(String var1, Map var2);
根据给定的条件评估触发事件的流程实例。根据条件判断是否满足触发事件的条件,并返回满足条件的流程实例列表。

updateBusinessKey(String var1, String var2);

更新指定ID的流程实例的业务键。业务键用于标识流程实例的业务关联信息。
updateBusinessStatus(String var1, String var2); 更新指定ID的流程实例的业务状态。用于更新流程实例的业务状态信息。
setOwner(String var1, String var2); 设置指定ID的流程实例的所有者。可以将流程实例分配给某个用户作为所有者。
removeOwner(String var1); 移除指定ID的流程实例的所有者。将所有者从流程实例中移除。
setAssignee(String var1, String var2); 设置指定ID的流程实例的办理人。指定某个用户作为流程实例的负责人。
removeAssignee(String var1); 移除指定ID的流程实例的办理人。将流程实例的负责人信息清空。
addUserIdentityLink(String var1, String var2, String var3); 给指定ID的流程实例添加用户身份链接。可以将用户与流程实例建立关联,如候选人、参与者等。
deleteUserIdentityLink(String var1, String var2, String var3); 删除指定ID的流程实例的用户身份链接。删除与用户之间的关联关系。
addGroupIdentityLink(String var1, String var2, String var3); 给指定ID的流程实例添加用户组身份链接。可以将用户组与流程实例建立关联,如候选组、参与组等。
deleteGroupIdentityLink(String var1, String var2, String var3); 删除指定ID的流程实例的用户组身份链接。删除与用户组之间的关联关系。
addParticipantUser(String var1, String var2);
addParticipantGroup(String var1, String var2);
deleteParticipantUser(String var1, String var2);
deleteParticipantGroup(String var1, String var2);
getIdentityLinksForProcessInstance(String var1); 获取指定ID的流程实例的身份链接。查询与流程实例相关的所有身份链接信息。
getEntityLinkChildrenForProcessInstance(String var1);
getEntityLinkChildrenWithSameRootAsProcessInstance(String var1);
getEntityLinkChildrenForTask(String var1);
getEntityLinkParentsForProcessInstance(String var1);
getEntityLinkParentsForTask(String var1);

getVariables(String var1);

setVariables(String var1, Map var2);

获取或设置指定ID的流程实例的流程变量。查询流程实例的所有流程变量。

getVariableInstances(String var1);

getVariableInstances(String var1, Collection var2);

getVariableInstancesByExecutionIds(Set var1);

getVariablesLocal(String var1);

getVariablesLocal(String var1, Collection var2);

setVariablesLocal(String var1, Map var2);

getVariableInstancesLocal(String var1);

getVariableInstancesLocal(String var1, Collection var2);

getVariables(String var1, Collection var2);

getVariable(String var1, String var2);
getVariable(String var1, String var2, Class var3);

setVariable(String var1, String var2, Object var3);

hasVariable(String var1, String var2);

getVariableLocal(String var1, String var2);

getVariableLocal(String var1, String var2, Class var3);

setVariableLocal(String var1, String var2, Object var3);

getVariableInstanceLocal(String var1, String var2);
getVariableInstance(String var1, String var2);
hasVariableLocal(String var1, String var2);
removeVariable(String var1, String var2);
removeVariableLocal(String var1, String var2);
removeVariables(String var1, Collection var2);
removeVariablesLocal(String var1, Collection var2);
createVariableInstanceQuery();
createNativeVariableInstanceQuery();

getDataObjects(String var1);
getDataObjects(String var1, String var2, boolean var3);

getDataObjects(String var1, Collection var2);
getDataObjects(String var1, Collection var2,

                          String var3, boolean var4);

getDataObject(String var1, String var2);
getDataObject(String var1, String var2, String var3, boolean var4);

getDataObjectsLocal(String var1);
getDataObjectsLocal(String var1, String var2, boolean var3);
getDataObjectsLocal(String var1, Collection var2);
getDataObjectsLocal(String var1, Collection var2,

                                  String var3, boolean var4);

getDataObjectLocal(String var1, String var2);
getDataObjectLocal(String var1, String var2, String var3, boolean var4);
createExecutionQuery();
createNativeExecutionQuery();
createProcessInstanceQuery();
createNativeProcessInstanceQuery();
createActivityInstanceQuery();
createNativeActivityInstanceQuery();
createEventSubscriptionQuery();
suspendProcessInstanceById(String var1);
activateProcessInstanceById(String var1);
signalEventReceivedWithTenantId(String var1, String var2);
signalEventReceivedAsync(String var1);
signalEventReceivedAsyncWithTenantId(String var1, String var2);

signalEventReceivedWithTenantId(String var1,

                                                        Map var2, String var3);

signalEventReceived(String var1);

signalEventReceived(String var1, String var2);

signalEventReceived(String var1, Map var2);

signalEventReceived(String var1, String var2, Map var3);

signalEventReceivedAsync(String var1, String var2);

messageEventReceived(String var1, String var2);
messageEventReceived(String var1, String var2,

                                        Map var3);

messageEventReceivedAsync(String var1, String var2);

addEventListener(FlowableEventListener var1);
addEventListener(FlowableEventListener var1,

                             FlowableEngineEventType... var2);

removeEventListener(FlowableEventListener var1);
dispatchEvent(FlowableEvent var1);
addEventRegistryConsumer(EventRegistryEventConsumer var1);
removeEventRegistryConsumer(EventRegistryEventConsumer var1);
setProcessInstanceName(String var1, String var2);
getAdhocSubProcessExecutions(String var1);
getEnabledActivitiesFromAdhocSubProcess(String var1);
executeActivityInAdhocSubProcess(String var1, String var2);
completeAdhocSubProcess(String var1);
createChangeActivityStateBuilder();

addMultiInstanceExecution(String var1, String var2,

                                            Map var3);

deleteMultiInstanceExecution(String var1, boolean var2);
getProcessInstanceEvents(String var1);

4. TaskService

        TaskService是Flowable引擎中的一个服务接口,用于处理任务相关的操作和数据。

方法 描述

newTask();
newTask(String var1);

创建一个新的任务。该方法返回一个新创建的Task对象,可以通过该对象设置任务的属性。

createTaskBuilder();

创建一个任务构建器。可以使用该构建器来设置任务的各个属性,并最终创建一个新的任务。

createTaskCompletionBuilder();

创建一个任务完成构建器。可以使用该构建器来设置任务完成时的附加参数,如表单数据、注释等。

saveTask(Task var1);

保存任务的更新。该方法将任务对象的属性变化保存到数据库中。

bulkSaveTasks(Collection var1);

批量保存多个任务的更新。将多个任务的属性变化批量保存到数据库中。

deleteTask(String var1);
deleteTask(String var1, boolean var2);
deleteTask(String var1, String var2);

删除指定ID的任务。该方法将删除指定ID的任务及其相关数据。

deleteTasks(Collection var1);

deleteTasks(Collection var1, boolean var2);

deleteTasks(Collection var1, String var2);

批量删除多个任务。将满足条件的多个任务及其相关数据删除。

claim(String var1, String var2);

认领指定ID的任务。该方法将指定ID的任务分配给当前用户。

unclaim(String var1);

取消认领指定ID的任务。将指定ID的任务从当前用户那取消分配。

complete(String var1);

complete(String var1, Map var2);
complete(String var1, Map var2,

                Map var3);
complete(String var1, Map var2, boolean var3);

完成指定ID的任务。将指定ID的任务设置为已完成状态。

delegateTask(String var1, String var2);

委派指定ID的任务给另一个用户。将指定ID的任务转交给另一个用户处理。

resolveTask(String var1);
resolveTask(String var1, Map var2);
resolveTask(String var1, Map var2,

                   Map var3);

解决指定ID的任务。将指定ID的任务从委派状态转回到正常处理状态。

completeTaskWithForm(String var1, String var2,

                                String var3, Map var4);
completeTaskWithForm(String var1, String var2,

                                       String var3, Map var4,

                                       Map var5);
completeTaskWithForm(String var1, String var2, String var3,                                       Map var4, boolean var5);

使用表单数据完成指定ID的任务。将表单数据作为变量,完成指定ID的任务。

getTaskFormModel(String var1);
getTaskFormModel(String var1, boolean var2);

获取指定任务的表单模型。可以获取任务的表单字段、属性等信息。

setAssignee(String var1, String var2);

设置指定ID的任务的负责人。将指定ID的任务分配给指定用户。

setOwner(String var1, String var2);

设置指定ID的任务的所有者。将指定ID的任务设置为指定用户的所有者。

getIdentityLinksForTask(String var1);

获取指定ID的任务的身份链接。查询与指定任务相关的所有身份链接信息。

addCandidateUser(String var1, String var2);

deleteCandidateUser(String var1, String var2);

为指定ID的任务添加候选用户。将指定用户添加为指定任务的候选人。

addCandidateGroup(String var1, String var2);

deleteCandidateGroup(String var1, String var2);

为指定ID的任务添加候选用户组。将指定用户组添加为指定任务的候选组。

addUserIdentityLink(String var1, String var2, String var3);

deleteUserIdentityLink(String var1, String var2, String var3);

为指定ID的任务添加用户身份链接。将指定用户与指定任务建立关联。

addGroupIdentityLink(String var1, String var2, String var3);

deleteGroupIdentityLink(String var1, String var2, String var3);

为指定ID的任务添加用户组身份链接。将指定用户组与指定任务建立关联。

setPriority(String var1, int var2);

设置指定ID的任务的优先级。设置任务的优先级属性。

setDueDate(String var1, Date var2);

设置指定ID的任务的截止日期。设置任务的截止日期属性。

createTaskQuery();

创建一个任务查询对象。用于条件查询任务。

createNativeTaskQuery();

创建一个原生SQL的任务查询对象。使用原生SQL语句查询任务。

setVariable(String var1, String var2, Object var3);
getVariable(String var1, String var2);
getVariable(String var1, String var2, Class var3);

设置指定ID的任务的变量。为指定任务设置一个变量。

setVariables(String var1, Map var2);

设置指定ID的任务的多个变量。为指定任务设置多个变量。

setVariableLocal(String var1, String var2, Object var3);

设置指定ID的任务的本地变量。为指定任务设置一个本地变量。

setVariablesLocal(String var1,

                                Map var2);

设置指定ID的任务的多个本地变量。为指定任务设置多个本地变量。

getVariableInstance(String var1, String var2);

获取指定ID的任务的变量实例。获取指定任务的一个变量实例。

getVariableLocal(String var1, String var2);
getVariableLocal(String var1, String var2, Class var3);

根据作用范围获取指定ID的任务的变量。获取指定任务的一个本地变量。

hasVariable(String var1, String var2);

判断指定ID的任务是否包含某个变量。判断指定任务是否包含某个变量。

getVariableInstanceLocal(String var1, String var2);

hasVariableLocal(String var1, String var2);

getVariables(String var1);

getVariables(String var1, Collection var2);

获取指定ID的流程实例的流程变量。查询流程实例的所有流程变量。

getVariableInstances(String var1);
getVariableInstances(String var1, Collection var2);

获取指定ID的任务的所有变量实例。获取指定任务的所有变量实例。

getVariablesLocal(String var1);

getVariablesLocal(String var1, Collection var2);

getVariableInstancesLocalByTaskIds(Set var1);

getVariableInstancesLocal(String var1);
getVariableInstancesLocal(String var1, Collection var2);

getDataObjects(String var1);
getDataObjects(String var1, String var2, boolean var3);
getDataObjects(String var1, Collection var2);
getDataObjects(String var1, Collection var2,

                         String var3, boolean var4);

获取指定ID的任务的数据对象。获取指定任务的所有数据对象。

getDataObject(String var1, String var2);
getDataObject(String var1, String var2, String var3, boolean var4);

获取指定ID的任务的数据对象。获取指定任务的一个数据对象。

addComment(String var1, String var2, String var3);
addComment(String var1, String var2, String var3, String var4);

为指定ID的任务添加注释。为指定任务添加一条注释。

saveComment(Comment var1);

保存注释的更新。将注释对象的属性变化保存到数据库中。

getComment(String var1);

获取指定ID的注释。根据注释的ID获取注释对象。

deleteComments(String var1, String var2);

批量删除多个注释。将满足条件的多个注释及其相关数据删除。

deleteComment(String var1);

删除指定任务注释。

getTaskComments(String var1);
getTaskComments(String var1, String var2);

获取指定ID的任务的注释。查询与指定任务相关的所有注释信息。

getCommentsByType(String var1);

根据注释类型获取指定ID的任务的注释。根据注释类型查询指定任务的注释信息。
getTaskEvents(String var1); 获取指定ID的任务的事件。查询与指定任务相关的所有事件信息。
getEvent(String var1); 获取指定ID的事件。根据事件的ID获取事件对象。
getProcessInstanceComments(String var1);
getProcessInstanceComments(String var1, String var2);
createAttachment(String var1, String var2, String var3, String var4,                                String var5, InputStream var6);
createAttachment(String var1, String var2, String var3, String var4,                              String var5, String var6);
创建一个附件。创建一个任务附件。
saveAttachment(Attachment var1);
getAttachment(String var1); 获取指定ID的附件。根据附件的ID获取附件对象。
getAttachmentContent(String var1); 获取指定ID的附件的内容。根据附件的ID获取附件的内容。
getTaskAttachments(String var1); 获取指定ID的任务的附件。查询与指定任务相关的所有附件信息。
getProcessInstanceAttachments(String var1);
deleteAttachment(String var1);
getSubTasks(String var1); 获取指定ID的任务的子任务。查询指定任务的所有子任务。

5. HistoryService

方法 描述

createHistoricProcessInstanceQuery();

创建一个历史流程实例查询对象。用于条件查询历史流程实例。

createHistoricActivityInstanceQuery();

创建一个历史活动实例查询对象。用于条件查询历史活动实例。

createHistoricTaskInstanceQuery();
createHistoricTaskInstanceQuery();

创建一个历史任务实例查询对象。用于条件查询历史任务实例。

createHistoricDetailQuery();

创建一个历史明细查询对象。用于条件查询历史明细数据。

createNativeHistoricDetailQuery();

创建一个原生SQL的历史明细查询对象。使用原生SQL语句查询历史明细数据。

createHistoricVariableInstanceQuery();

创建一个历史变量实例查询对象。用于条件查询历史变量实例。

createNativeHistoricVariableInstanceQuery();

创建一个原生SQL的历史变量实例查询对象。使用原生SQL语句查询历史变量实例。

deleteHistoricTaskInstance(String var1);

删除指定ID的历史任务实例。删除历史任务实例及其相关数据。

deleteHistoricProcessInstance(String var1);

删除指定ID的历史流程实例。删除历史流程实例及其相关数据。

bulkDeleteHistoricProcessInstances(Collection var1);

批量删除多个历史流程实例。删除满足条件的多个历史流程实例及其相关数据。

deleteTaskAndActivityDataOfRemovedHistoricProcessInstances();

删除已删除历史流程实例的任务和活动数据。

deleteRelatedDataOfRemovedHistoricProcessInstances();

删除已删除历史流程实例的相关数据。

createNativeHistoricProcessInstanceQuery();

创建一个原生SQL的历史流程实例查询对象。使用原生SQL语句查询历史流程实例数据。

createNativeHistoricTaskInstanceQuery();

创建一个原生SQL的历史任务实例查询对象。使用原生SQL语句查询历史任务实例数据。

createNativeHistoricActivityInstanceQuery();

创建一个原生SQL的历史活动实例查询对象。使用原生SQL语句查询历史活动实例数据。

getHistoricIdentityLinksForTask(String var1);

获取指定ID的任务的历史身份链接。查询与指定任务相关的所有历史身份链接信息。

getHistoricIdentityLinksForProcessInstance(String var1);

获取指定ID的流程实例的历史身份链接。查询与指定流程实例相关的所有历史身份链接信息。

getHistoricEntityLinkChildrenForProcessInstance(String var1);

获取指定ID的流程实例的历史实体链接的子链接。查询与指定流程实例相关的所有历史实体链接的子链接信息。

getHistoricEntityLinkChildrenWithSameRootAsProcessInstance(

                                                                                        String var1);

获取与指定流程实例根链接具有相同根链接的历史实体链接的子链接。

getHistoricEntityLinkChildrenForTask(String var1);

获取指定ID的任务的历史实体链接的子链接。查询与指定任务相关的所有历史实体链接的子链接信息。

getHistoricEntityLinkParentsForProcessInstance(String var1);

获取指定ID的流程实例的历史实体链接的父链接。查询与指定流程实例相关的所有历史实体链接的父链接信息。

getHistoricEntityLinkParentsForTask(String var1);

获取指定ID的任务的历史实体链接的父链接。查询与指定任务相关的所有历史实体链接的父链接信息。

createProcessInstanceHistoryLogQuery(String var1);

创建一个流程实例历史日志查询对象。用于条件查询流程实例历史日志。

deleteHistoricTaskLogEntry(long var1);

删除指定ID的历史任务日志条目。删除历史任务日志条目及其相关数据。

createHistoricTaskLogEntryBuilder(TaskInfo var1);

createHistoricTaskLogEntryBuilder();

创建一个历史任务日志条目构建器。用于创建自定义的历史任务日志条目。

createHistoricTaskLogEntryQuery();

创建一个历史任务日志查询对象。用于条件查询历史任务日志。

createNativeHistoricTaskLogEntryQuery();

创建一个原生SQL的历史任务日志查询对象。使用原生SQL语句查询历史任务日志数据。

6. FormService

        FormService是Flowable引擎中的一个服务接口,用于处理表单相关的操作和数据。

方法 描述

getStartFormData(String var1);

获取给定流程定义的启动表单数据。该方法返回一个StartFormData对象,可以用于获取表单字段、表单属性等信息。

getRenderedStartForm(String var1);
getRenderedStartForm(String var1, String var2);

获取给定流程定义的启动表单的HTML渲染结果。该方法返回一个String类型的HTML字符串,可以直接在前端页面展示。

submitStartFormData(String var1, Map var2);
submitStartFormData(String var1, String var2,

                                   Map var3);

提交给定流程定义的启动表单数据。该方法将表单数据作为变量,启动一个新的流程实例。

getTaskFormData(String var1);

获取给定任务的表单数据。该方法返回一个TaskFormData对象,用于获取表单字段、表单属性等信息。

getRenderedTaskForm(String var1);
getRenderedTaskForm(String var1, String var2);

获取给定任务的表单的HTML渲染结果。该方法返回一个String类型的HTML字符串,可以直接在前端页面展示。

submitTaskFormData(String var1, Map var2);

提交给定任务的表单数据。该方法将表单数据更新到相关任务,并推进流程的执行。

saveFormData(String var1, Map var2);

保存给定任务的表单数据。该方法将数据保存到任务的表单字段中,但不推进流程的执行。

getStartFormKey(String var1);

获取给定流程定义的启动表单的表单Key。表单Key对应于流程定义的启动节点中配置的表单。

getTaskFormKey(String var1, String var2);

获取给定任务的表单的表单Key。表单Key对应于流程定义中任务节点中配置的表单。

7. IdentityService

方法 描述

newUser(String var1);
saveUser(User var1);
deleteUser(String var1);

创建、保存、删除一个新的用户对象。

newGroup(String var1);

saveGroup(Group var1);
deleteGroup(String var1);

创建、保存、删除一个新的用户组对象。

updateUserPassword(User var1);

更新用户的密码。
checkPassword(String var1, String var2); 检查用户密码是否正确。

reateUserQuery();

创建一个用户查询对象。用于条件查询用户

createNativeUserQuery();

创建一个原生SQL的用户查询对象。使用原生SQL语句查询用户。

createGroupQuery();

创建一个用户组查询对象。用于条件查询用户组。

createNativeGroupQuery();

创建一个原生SQL的用户组查询对象。使用原生SQL语句查询用户组。

getPotentialStarterGroups(String var1);

获取指定流程定义的潜在启动用户组。用于获取可以启动指定流程定义的用户组。

getPotentialStarterUsers(String var1);

获取指定流程定义的潜在启动用户。用于获取可以启动指定流程定义的用户。

createMembership(String var1, String var2);
deleteMembership(String var1, String var2);

创建或删除用户与用户组之间的成员关系。

setAuthenticatedUserId(String var1);

设置当前用户的身份标识。

setUserPicture(String var1, Picture var2);
getUserPicture(String var1);

设置或获取用户的头像图片。

setUserInfo(String var1, String var2, String var3);
getUserInfo(String var1, String var2);

deleteUserInfo(String var1, String var2);

设置、获取、删除用户的自定义信息。

getUserInfoKeys(String var1);

获取用户的自定义信息键列表。

8. ManagementService

        ManagementService是Flowable引擎中的一个服务接口,用于管理和操作引擎的一些管理任务和操作。它提供了管理和监控流程实例、任务、作业等的功能。

方法 描述

getTableCount();

获取指定表名的记录数。

getTableName(Class var1);
getTableName(Class var1, boolean var2);

获取指定实体类对应的数据库表名。
getTableMetaData(String var1); 获取指定表名的元数据信息。

createTablePageQuery();

创建一个表分页查询对象。用于分页查询指定表的数据。
createJobQuery(); 创建一个作业查询对象。用于条件查询作业。

createExternalWorkerJobQuery();

创建一个外部工作者作业查询对象。用于条件查询外部工作者作业。
createTimerJobQuery(); 创建一个定时器作业查询对象。用于条件查询定时器作业。

createSuspendedJobQuery();

创建一个挂起作业查询对象。用于条件查询挂起作业。
createDeadLetterJobQuery(); 创建一个死信作业查询对象。用于条件查询死信作业。

createHistoryJobQuery();

创建一个历史作业查询对象。用于条件查询历史作业。
findJobByCorrelationId(String var1); 根据关联ID查找作业。

executeJob(String var1);

执行指定ID的作业。
executeHistoryJob(String var1); 执行指定ID的历史作业。

getHistoryJobHistoryJson(String var1);

moveTimerToExecutableJob(String var1); 将定时器作业转为可执行作业。

moveJobToDeadLetterJob(String var1);

将作业转为死信作业。
moveDeadLetterJobToExecutableJob(String var1, int var2); 将死信作业转为可执行作业。

moveDeadLetterJobToHistoryJob(String var1, int var2);

将死信作业转为历史作业。
bulkMoveDeadLetterJobs(Collection var1, int var2); 批量将死信作业转为可执行作业。

bulkMoveDeadLetterJobsToHistoryJobs(Collection var1,

                                                                 int var2);

批量将死信作业转为历史作业。
moveSuspendedJobToExecutableJob(String var1); 将挂起作业转为可执行作业。

deleteJob(String var1);

删除指定ID的作业。
deleteTimerJob(String var1); 删除指定ID的定时器作业。

deleteSuspendedJob(String var1);

删除指定ID的挂起作业。
deleteDeadLetterJob(String var1); 删除指定ID的死信作业。
deleteExternalWorkerJob(String var1); 删除指定ID的外部工作者作业。
deleteHistoryJob(String var1); 删除指定ID的历史作业。

setJobRetries(String var1, int var2);

设置作业的重试次数。
setTimerJobRetries(String var1, int var2); 设置定时器作业的重试次数。
rescheduleTimeDateJob(String var1, String var2); 重新调度时间/日期作业。
rescheduleTimeDurationJob(String var1, String var2); 重新调度时间间隔作业。
rescheduleTimeCycleJob(String var1, String var2); 重新调度时间循环作业。

rescheduleTimerJob(String var1, String var2, String var3,

                                 String var4, String var5, String var6);

重新调度定时器作业。
getJobExceptionStacktrace(String var1); 获取作业的异常堆栈轨迹。
getTimerJobExceptionStacktrace(String var1); 获取定时器作业的异常堆栈轨迹。
getSuspendedJobExceptionStacktrace(String var1); 获取挂起作业的异常堆栈轨迹。
getDeadLetterJobExceptionStacktrace(String var1); 获取死信作业的异常堆栈轨迹。
getExternalWorkerJobErrorDetails(String var1); 获取外部工作者作业的错误详情。
handleHistoryCleanupTimerJob(); 处理历史数据清理的定时作业。
getAllBatches(); 获取所有批量操作。
findBatchesBySearchKey(String var1); 根据搜索关键字查找批量操作。
getBatchDocument(String var1); 获取批量操作的文档信息。
getBatchPart(String var1); 获取批量操作的部分信息。
findBatchPartsByBatchId(String var1); 根据批量操作ID查找部分信息。
findBatchPartsByBatchIdAndStatus(String var1, String var2); 根据批量操作ID和状态查找部分信息。
getBatchPartDocument(String var1); 获取批量操作的部分文档信息。
createBatchQuery(); 创建一个批量操作查询对象。用于条件查询批量操作。
createBatchBuilder(); 创建一个批量操作构建器。用于创建自定义的批量操作。
createBatchPartQuery(); 创建一个批量操作部分查询对象。用于条件查询批量操作的部分信息。
createBatchPartBuilder(Batch var1); 创建一个批量操作部分构建器。用于创建自定义的批量操作的部分信息。
deleteBatch(String var1); 删除指定ID的批量操作。
getProperties(); 获取Flowable引擎的属性配置。
databaseSchemaUpgrade(Connection var1, String var2, String var3); 执行数据库模式升级。
executeCommand(Command var1);
executeCommand(CommandConfig var1, Command var2);
执行命令。
getLockManager(String var1); 获取锁管理器。
executeCustomSql(CustomSqlExecution var1); 执行自定义SQL语句。
getEventLogEntries(Long var1, Long var2); 获取事件日志条目。
getEventLogEntriesByProcessInstanceId(String var1); 根据流程实例ID获取相关的事件日志条目。
deleteEventLogEntry(long var1); 删除指定ID的事件日志条目。
createExternalWorkerJobAcquireBuilder(); 创建一个外部工作者作业获取构建器。
createExternalWorkerJobFailureBuilder(String var1, String var2); 创建一个外部工作者作业获取构建器。
createExternalWorkerCompletionBuilder(String var1, String var2); 创建一个外部工作者任务完成构建器。
createChangeTenantIdBuilder(String var1, String var2); 创建一个改变租户ID的构建器。

9. DynamicBpmnService

方法 描述

injectUserTaskInProcessInstance(String var1,                                                       DynamicUserTaskBuilder var2);

向指定的流程实例动态添加用户任务。

injectParallelUserTask(String var1, DynamicUserTaskBuilder var2);

向指定流程实例中添加并行的用户任务。

injectEmbeddedSubProcessInProcessInstance(String var1, 

                                    DynamicEmbeddedSubProcessBuilder var2);

向指定的流程实例动态添加嵌入式子流程。

injectParallelEmbeddedSubProcess(String var1,

                                    DynamicEmbeddedSubProcessBuilder var2);

向指定的流程实例中添加并行的嵌入式子流程。
getProcessDefinitionInfo(String var1);
saveProcessDefinitionInfo(String var1, ObjectNode var2);
获取或保存流程定义的详细信息,包括各个流程元素的属性和结构。

changeServiceTaskClassName(String var1, String var2);
changeServiceTaskClassName(String var1, String var2,

                                                   ObjectNode var3);

修改服务任务的类名。
changeServiceTaskExpression(String var1, String var2); 修改服务任务的表达式。

changeServiceTaskDelegateExpression(String var1, String var2);
changeServiceTaskDelegateExpression(String var1, String var2,

                                                                ObjectNode var3);

修改服务任务的委托表达式。
changeScriptTaskScript(String var1, String var2);
changeScriptTaskScript(String var1, String var2, ObjectNode var3);
修改脚本任务的脚本。

changeSkipExpression(String var1, String var2);
changeSkipExpression(String var1, String var2, ObjectNode var3);

removeSkipExpression(String var1, ObjectNode var2);

修改或移除跳过任务的表达式。

enableSkipExpression();
enableSkipExpression(ObjectNode var1);

removeEnableSkipExpression(ObjectNode var1);

启用或移除任务的跳过表达式。
changeUserTaskName(String var1, String var2);
changeUserTaskName(String var1, String var2, ObjectNode var3);
修改用户任务的名称。

changeUserTaskDescription(String var1, String var2);
changeUserTaskDescription(String var1, String var2,

                                              ObjectNode var3);

修改用户任务的描述。
changeUserTaskDueDate(String var1, String var2);
changeUserTaskDueDate(String var1, String var2, ObjectNode var3);
修改用户任务的到期时间。
changeUserTaskPriority(String var1, String var2);
changeUserTaskPriority(String var1, String var2, ObjectNode var3);
修改用户任务的优先级。
changeUserTaskCategory(String var1, String var2);
changeUserTaskCategory(String var1, String var2, ObjectNode var3);
修改用户任务的分类。
changeUserTaskFormKey(String var1, String var2);
changeUserTaskFormKey(String var1, String var2, ObjectNode var3);
修改用户任务的表单键。

changeUserTaskAssignee(String var1, String var2);
changeUserTaskAssignee(String var1, String var2, ObjectNode var3);

修改用户任务的指派人。
changeUserTaskOwner(String var1, String var2);
changeUserTaskOwner(String var1, String var2, ObjectNode var3);
修改用户任务的所有者。

changeUserTaskCandidateUser(String var1, String var2,

                                                    boolean var3);
changeUserTaskCandidateUser(String var1, String var2,

                                                   boolean var3, ObjectNode var4);

修改用户任务的候选用户。

changeUserTaskCandidateGroup(String var1, String var2,

                                                     boolean var3);
changeUserTaskCandidateGroup(String var1, String var2,

                                                     boolean var3, ObjectNode var4);

修改用户任务的候选用户组。

changeUserTaskCandidateUsers(String var1, List var2);
changeUserTaskCandidateUsers(String var1, List var2,

                                                     ObjectNode var3);

changeUserTaskCandidateGroups(String var1, List var2);
changeUserTaskCandidateGroups(String var1, List var2,

                                                         ObjectNode var3);

changeMultiInstanceCompletionCondition(String var1, String var2);
changeMultiInstanceCompletionCondition(String var1, String var2,

                                                                    ObjectNode var3);

修改多实例任务的完成条件。

changeDmnTaskDecisionTableKey(String var1, String var2);
changeDmnTaskDecisionTableKey(String var1, String var2,

                                                         ObjectNode var3);

修改DMN任务的决策表键。

changeSequenceFlowCondition(String var1, String var2);
changeSequenceFlowCondition(String var1, String var2,

                                                    ObjectNode var3);

修改连线的条件。

changeCallActivityCalledElement(String var1, String var2);
changeCallActivityCalledElement(String var1, String var2,

                                                     ObjectNode var3);

修改调用活动的被调用流程定义。
getBpmnElementProperties(String var1, ObjectNode var2); 获取流程定义中指定元素的属性。

changeLocalizationName(String var1, String var2, String var3);
changeLocalizationName(String var1, String var2, String var3,

                                         ObjectNode var4);

修改本地化名称。

changeLocalizationDescription(String var1, String var2, String var3);
changeLocalizationDescription(String var1, String var2, String var3,

                                                  ObjectNode var4);

修改本地化描述。

getLocalizationElementProperties(String var1, String var2,

                                                       ObjectNode var3);

获取指定本地化元素的属性。
resetProperty(String var1, String var2, ObjectNode var3); 重置属性。
getDynamicProcessDefinitionSummary(String var1); 获取动态流程定义的摘要信息。

10. ProcessMigrationService

        ProcessMigrationService是Flowable引擎中的一个服务接口,用于支持流程实例的迁移和升级。它提供了一系列方法,用于创建和执行流程实例的迁移操作。

方法 描述

createProcessInstanceMigrationBuilder();

创建一个流程实例迁移的构建器,用于定义迁移的细节和配置。

createProcessInstanceMigrationBuilderFromProcessInstanceMigrationDocument(

                                                             ProcessInstanceMigrationDocument var1);

从已有的流程实例迁移文档创建迁移构建器,用于对流程实例进行迁移。

validateMigrationForProcessInstance(String var1,

                                                         ProcessInstanceMigrationDocument var2);

验证单个流程实例是否可以进行迁移操作,检查迁移的合法性和可行性。

validateMigrationForProcessInstancesOfProcessDefinition(String var1,

                                                         ProcessInstanceMigrationDocument var2);

validateMigrationForProcessInstancesOfProcessDefinition(

                                                        String var1, int var2, String var3,

                                                        ProcessInstanceMigrationDocument var4);

验证给定流程定义下所有流程实例的迁移的合法性。
migrateProcessInstance(String var1, ProcessInstanceMigrationDocument var2); 执行单个流程实例的迁移操作。

migrateProcessInstancesOfProcessDefinition(String var1,

                                                             ProcessInstanceMigrationDocument var2);
migrateProcessInstancesOfProcessDefinition(String var1, int var2, String var3,

                                                             ProcessInstanceMigrationDocument var4);

迁移给定流程定义下的一批流程实例。

batchMigrateProcessInstancesOfProcessDefinition(String var1,

                                                      ProcessInstanceMigrationDocument var2);
batchMigrateProcessInstancesOfProcessDefinition(String var1, int var2,

                                                          String var3,

                                                          ProcessInstanceMigrationDocument var4);

批量迁移给定流程定义下的多个流程实例。
getResultsOfBatchProcessInstanceMigration(String var1); 获取批量流程实例迁移操作的结果。

11. ProcessEngineConfiguration

方法 描述

buildProcessEngine()

通过该方法,可以创建 Flowable 引擎,并进行流程管理、执行、监控等操作。

createProcessEngineConfigurationFromResourceDefault()

从默认的配置文件(flowable.cfg.xml)创建 ProcessEngineConfiguration 对象。该方法会读取并解析默认配置文件,生成对应的配置对象。

createProcessEngineConfigurationFromResource(

                                                                String resource)

createProcessEngineConfigurationFromResource(

                                String resource, String beanName)

从指定的配置文件中创建 ProcessEngineConfiguration 对象。通过提供配置文件路径,可以自定义 Flowable 引擎的配置。

createProcessEngineConfigurationFromInputStream(

                                                InputStream inputStream)

createProcessEngineConfigurationFromInputStream(

                                                InputStream inputStream,

                                                String beanName)

从输入流中创建 ProcessEngineConfiguration 对象。该方法可以通过读取流程配置文件的方式创建配置对象。
createStandaloneProcessEngineConfiguration() 创建一个独立的(standalone)的 ProcessEngineConfiguration 对象。独立引擎可以在单独的 Java 程序中使用,不需要依赖外部容器。
createStandaloneInMemProcessEngineConfiguration() 用于创建一个独立于数据库的内存中的流程引擎配置。
getRepositoryService() 获取流程仓库(RepositoryService)对象,用于管理流程定义的部署、查询等操作。
getRuntimeService(); 获取流程运行时(RuntimeService)对象,用于启动、完成、查询流程实例和执行流程任务等操作。
getFormService(); 获取表单(FormService)对象,用于操作流程定义的表单信息,包括表单的渲染和提交。
getTaskService(); 获取任务(TaskService)对象,用于管理流程任务的创建、分配、办理等操作。
getHistoryService(); 获取历史数据(HistoryService)对象,用于查询和管理流程的历史数据,如已完成的流程实例、任务等。
getIdentityService(); 获取身份验证(IdentityService)对象,用于管理用户、组、角色等身份验证和权限相关的操作。
getManagementService(); 获取管理服务(ManagementService)对象,用于执行底层的流程管理和操作,如作业执行、引擎配置等。
getProcessEngineConfiguration(); 获取流程引擎配置对象。

getEngineName()

setEngineName(String processEngineName)

获取或设置流程引擎的名称。

getIdBlockSize()

setIdBlockSize(int idBlockSize)

获取或设置 ID 块大小。。ID 块大小是在创建流程引擎时用于生成和管理各种对象(如任务、事件等)的唯一标识符(ID)的块大小。

getHistory()

setHistory(String history)

获取或设置历史记录级别,用于配置引擎对流程历史数据的记录程度。

getMailServerHost()

setMailServerHost(String mailServerHost)

邮件服务器的主机名。默认为localhost

getMailServerUsername()

setMailServerUsername(String mailServerUsername)

获取或设置邮件服务器的用户名,以便在流程引擎中使用邮件服务。

getMailServerPassword()

setMailServerPassword(String mailServerPassword)

获取或设置邮件服务器的密码,以便在流程引擎中使用邮件服务。

getMailServerPort()

setMailServerPort(int mailServerPort)

邮件服务器的SMTP端口。默认值为25

getMailServerDefaultCharset()

setMailServerDefaultCharset(Charset defaultCharset)

获取或设置邮件服务器的默认字符集。

getMailServerSSLPort()

setMailServerSSLPort(int mailServerSSLPort)

获取或设置邮件服务器的 SSL 端口

getMailServerUseSSL()

setMailServerUseSSL(boolean useSSL)

邮件服务器要求ssl通信。默认为false。

getMailServerUseTLS()

setMailServerUseTLS(boolean useTLS)

邮件服务器要求TLS通信。默认为false。

getMailServerDefaultFrom()

setMailServerDefaultFrom(String defaultFrom)

获取或设置邮件服务器的默认发件人地址

getMailServerForceTo()

setMailServerForceTo(String mailServerForceTo)

获取或设置邮件服务器强制发送邮件的收件人地址

getMailServer(String tenantId)

getMailServers()

setMailServers(Map mailServers)

获取或设置邮件服务器的相关信息

getMailSessionJndi(String tenantId)

setMailSessionJndi(String mailSessionJndi)

getMailSessionsJndi()

setMailSessionsJndi(Map sessionsJndi)

获取或设置邮件会话的 JNDI 名称。

getHttpClientConfig()

setHttpClientConfig(HttpClientConfig httpClientConfig)

用于获取或设置 HttpClient 配置对象。

setDatabaseType(String databaseType)

通常不需要专门设置这个参数,因为它可以从数据库连接信息中自动检测得出。
setDatabaseSchemaUpdate(String databaseSchema)

用于设置流程引擎启动关闭时使用的数据库表结构控制策略。

false (默认): 当引擎启动时,检查数据库表结构的版本是否匹配库文件版本。版本不匹配时抛出异常。

true: 构建引擎时,检查并在需要时更新表结构。表结构不存在则会创建。

create-drop: 引擎创建时创建表结构,并在引擎关闭时删除表结构。

setDataSource(DataSource dataSource) 用于设置数据源
setJdbcDriver(String jdbcDriver) 对应数据库类型的驱动。
setJdbcUrl(String jdbcUrl) 数据库的JDBC URL
setJdbcUsername(String jdbcUsername) 用于连接数据库的用户名。
setJdbcPassword(String jdbcPassword) 用于连接数据库的密码。
setTransactionsExternallyManaged(boolean managed) 用于设置是否让外部管理事务

getHistoryLevel()

setHistoryLevel(HistoryLevel historyLevel)

用于获取或设置历史记录级别。

isEnableProcessDefinitionHistoryLevel()

setEnableProcessDefinitionHistoryLevel(boolean enable)

判断或设置是否启用流程定义历史记录级别。
setJdbcMaxActiveConnections(int maxActiveConnections) 连接池能够容纳的最大活动连接数量。默认值为10.
setJdbcMaxIdleConnections(int maxIdleConnections) 连接池能够容纳的最大空闲连接数量。
setJdbcMaxCheckoutTime(int maxCheckoutTime) 连接从连接池“取出”后,被强制返回前的最大时间间隔,单位为毫秒。默认值为20000(20秒)
setJdbcMaxWaitTime(int maxWaitTime) 在连接池获取连接的时间异常长时,打印日志并尝试重新获取连接。默认值为20000(20秒)
setJdbcPingEnabled(boolean pingEnabled) 用于设置是否启用 JDBC ping 检测。
setJdbcPingQuery(String jdbcPingQuery) 用于设置数据库的连接信息
setJdbcPingConnectionNotUsedFor(int pingNotUsedFor) 设置是否提供了正确的API名称或可能有其他途径来设置JDBC连接的空闲时间。
setJdbcDefaultTransactionIsolationLevel(int level) 设置JDBC事务的默认隔离级别。

isAsyncExecutorActivate()

setAsyncExecutorActivate(boolean activate)

激活或停用异步执行器

isAsyncHistoryExecutorActivate()

setAsyncHistoryExecutorActivate(boolean activate)

激活或停用异步历史事件执行器
setClassLoader(ClassLoader classLoader) 设置类加载器
setUseClassForNameClassLoading(boolean useClass) 设置是否使用Class.forName()方法来加载类。

getJpaEntityManagerFactory()

setJpaEntityManagerFactory(Object factory)

配置BPM引擎的各种参数和属性。
isJpaHandleTransaction()
setJpaHandleTransaction(boolean handleTransaction)
设置是否让BPM来管理JPA事务的
isJpaCloseEntityManager()
setJpaCloseEntityManager(boolean manager)
是否关闭EntityManager
getJpaPersistenceUnitName()
setJpaPersistenceUnitName(String persistenceUnitName)
用来指定JPA持久化单元的名称
setDataSourceJndiName(String dataSourceJndiName) 设置JNDI名称,以在Java命名和目录接口(JNDI)中查找数据源。
getDefaultCamelContext()
setDefaultCamelContext(String defaultCamelContext)
获取或设置Camel上下文
isCreateDiagramOnDeploy()
setCreateDiagramOnDeploy(boolean deploy)
设置是否在部署流程定义时自动创建流程图。
isDrawSequenceFlowNameWithNoLabelDI()
setDrawSequenceFlowNameWithNoLabelDI(boolean d)
设置是否绘制序列流名称与无标签
getActivityFontName() {
setActivityFontName(String activityFontName)
设置或获取活动字体

getLabelFontName()

setLabelFontName(String labelFontName)

设置或获取标签字体

getAnnotationFontName()

setAnnotationFontName(String annotationFontName)

设置或获取注释字体名称
setDatabaseTablePrefix(String databaseTablePrefix) 设置数据库表前缀
setTablePrefixIsSchema(boolean tablePrefixIsSchema) 设置数据库Schema前缀
setDatabaseWildcardEscapeCharacter(String character) 设置数据库通配符转义字符
setDatabaseCatalog(String databaseCatalog) 设置数据库目录
setDatabaseSchema(String databaseSchema) 设置数据库模式
setXmlEncoding(String xmlEncoding) 设置Xml编码
setClock(Clock clock) 设置时钟

getProcessDiagramGenerator()
setProcessDiagramGenerator(ProcessDiagramGenerator

                                                 process)

获取或设置ProcessEngine的流程图生成器

getAsyncExecutor()

setAsyncExecutor(AsyncExecutor asyncExecutor)

获取或设置异步执行器的实例

getAsyncTaskExecutor()

setAsyncTaskExecutor(AsyncTaskExecutor executor)

获取或设置异步任务执行器的实例

getAsyncTaskInvokerTaskExecutor()

setAsyncTaskInvokerTaskExecutor(AsyncTaskExecutor executor)

获取或设置异步任务调用器的任务执行器实例

getAsyncTaskInvoker()

setAsyncTaskInvoker(AsyncTaskInvoker invoker) 

获取或设置异步任务执行器的实例。

getAsyncHistoryExecutor()

setAsyncHistoryExecutor(AsyncExecutor executor)

获取或设置异步历史事件执行器的实例

getAsyncHistoryTaskExecutor()

setAsyncHistoryTaskExecutor(AsyncTaskExecutor

                                                 executor)

获取或设置异步历史任务执行器的实例。

getDefaultFailedJobWaitTime()

setDefaultFailedJobWaitTime(int time)

获取或设置默认失败任务等待时间的属性值

getAsyncFailedJobWaitTime()

setAsyncFailedJobWaitTime(int time)

获取或设置异步失败任务等待时间的属性值。

isEnableProcessDefinitionInfoCache()

setEnableProcessDefinitionInfoCache(boolean enable)

设置是否启用流程定义信息缓存的配置选项。启用流程定义信息缓存可以提高流程定义的访问性能,避免频繁地查询数据库或其他数据源。

getTaskPostProcessor()

setTaskPostProcessor(TaskPostProcessor processor

获取或设置任务后置处理器

isEnableHistoryCleaning()

setEnableHistoryCleaning(boolean enable)

设置是否启用历史数据清理的配置选项。

getHistoryCleaningTimeCycleConfig()

setHistoryCleaningTimeCycleConfig(String config)

获取历史数据清理时间周期配置的实例。

getCleanInstancesEndedAfter()

setCleanInstancesEndedAfter(Duration endedAfter)

启用历史数据清理,并使用相关的调度策略来配置何时执行清理任务。

getCleanInstancesBatchSize()

setCleanInstancesBatchSize(int batchSize)

清洁实例批量大小

isCleanInstancesSequentially()

setCleanInstancesSequentially(boolean sequentially)

清理实例是顺序

getHistoryCleaningManager()

setHistoryCleaningManager(HistoryCleaningManager

                                              manager)

历史清理管理器

isAlwaysUseArraysForDmnMultiHitPolicies()

setAlwaysUseArraysForDmnMultiHitPolicies(boolean

                                                                         policies)

是否为Dmn多命中策略设置始终使用数组

你可能感兴趣的:(Flowable,flowable)