BusinessFlowManagerService 接口公布可以由客户机应用程序调用的业务流程函数。
可以由 BusinessFlowManagerService 接口调用的方法取决于流程状态或活动状态,并取决于包含该方法的应用程序的用户所具有的权限。下面列示了业务流程对象的主要处理方法。要了解有关这些方法以及 BusinessFlowManagerService 接口中提供的其他方法的更多信息,请参阅 com.ibm.bpe.api 包中的 Javadoc。
流程模板是已版本化、已部署并且已安装的流程模型,它包含业务流程的规范。可以通过发出适当的请求(例如 initiate())来将流程模板实例化并启动它。流程实例的执行是由服务器自动驱动的。
方法 | 描述 |
---|---|
getProcessTemplate | 检索指定的流程模板。 |
queryProcessTemplate | 检索数据库中存储的流程模板。 |
下列 API 方法用于启动流程实例。
方法 | 描述 |
---|---|
call | 创建并运行微流程。 |
callWithReplyContext | 根据指定的流程模板创建并运行具有唯一启动服务的微流程或者具有唯一启动服务的长期流程。该调用将以异步方式等待结果。 |
callWithUISettings | 创建并运行微流程,然后返回输出消息和客户机用户界面(UI)设置。 |
initiate | 创建流程实例并启动该流程实例的处理。此方法适用于长期流程。也可以对要激发并忘记的微流程使用此方法。 |
sendMessage | 将指定的消息发送至指定的活动服务和流程实例。该流程实例可以是微流程或长期流程。这些流程可以有唯一的启动服务,也可以有不唯一的启动服务。 |
getStartActivities | 返回有关可以根据所指定流程模板启动流程实例的活动的信息。 |
getActivityServiceTemplate | 检索指定的活动服务模板。 |
方法 | 描述 |
---|---|
suspend | 暂停执行处于“正在运行”或“正在失败”状态的顶级长期流程实例。 |
resume | 继续执行处于“已暂挂”状态的顶级长期流程实例。 |
restart | 重新启动处于“已完成”、“已失败”或“已终止”状态的顶级长期流程实例。 |
forceTerminate | 终止指定的顶级流程实例、其 autonomy 属性值为 child 的子流程及其处于“正在运行”、“已声明”或“正在等待”状态的活动。 |
delete | 删除指定的顶级流程实例及其 autonomy 属性值为 child 的子流程。 |
query | 从数据库中检索与搜索条件匹配的属性。 |
对于调用活动来说,可以在流程模型中指定这些活动在出错时将继续执行。如果将 continueOnError 标志设置为 false,并且发生了未处理的错误,该活动就会进入“已停止”状态。于是,流程管理员就可以修复该活动。例如,在调用活动偶尔失败但补偿建模和故障处理成本过高的长期流程中,可以使用 continueOnError 标志和相关联的修复函数。
下列方法可用于处理和修复活动。
方法 | 描述 |
---|---|
claim | 声明已就绪的活动实例,以便用户处理该活动。 |
cancelClaim | 取消声明活动实例。 |
complete | 完成活动实例。 |
forceComplete | 强制完成处于“正在运行”或“已停止”状态的活动实例。 |
forceRetry | 强制重复处于“正在运行”或“已停止”状态的活动实例。 |
query | 从数据库中检索与搜索条件匹配的属性。 |
接口提供了用于检索和设置变量值的 get 和 set 方法。还可以使指定的属性与流程实例和活动实例相关联,并可以从这些实例中检索指定的属性。定制属性名和属性值的类型必须是 java.lang.String。
方法 | 描述 |
---|---|
getVariable | 检索指定的变量。 |
setVariable | 设置指定的变量。 |
getCustomProperty | 从指定的活动实例或流程实例中检索指定的定制属性。 |
getCustomProperties | 从指定的活动实例或流程实例中检索指定的多个定制属性。 |
getCustomPropertyNames | 从指定的活动实例或流程实例中检索定制属性的名称。 |
setCustomProperty | 为指定的活动实例或流程实例存储特定定制属性的值。 |