SZDBT 17.10-2008 深圳市电子政务应用服务规范 第10部分 业务流程服务接口规范.pdf

深 圳 市 标 准 化 指 导 性 技 术 文 件 SZDB/Z 17.10- 2008 深圳市电子政务应用服务规范 第 10 部分：业务流程服务接口规范 Electronic Government Application Service Specification Part 10 : Business Process Service API Specification 2008- 12- 01 实施 深圳市质量技术监督局发布 SZDB/Z ICS 35.080 L 77 2008- 11- 18 发布 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 SZDB/Z 17.102008 I 目 次 前 言.II 1 范围.1 2 规范性引用文件.1 3 术语和定义.1 4 状态定义.2 4.1 流程定义状态.2 4.2 流程实例/活动实例状态2 5 业务流程服务.3 5.1 流程服务总体概述.3 5.2 流程模型服务.4 5.3 流程实例服务.6 5.4 应用调用服务.14 5.5 流程互操作服务.16 5.6 流程管理服务.18 5.7 异常约定.20 参考文献.22 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 标准分享网 w w w .b z f x w .c o m 免费下载 SZDB/Z 17.102008 II 前 言 SZDB/Z 17-2008电子政务应用服务规范目前分为 10 个部分: 第 1 部分 总则 第 2 部分 应用系统分类及代码规范 第 3 部分 应用系统描述规范 第 4 部分 组织身份模型数据规范 第 5 部分 应用服务运行管理框架规范 第 6 部分 组织身份服务接口规范 第 7 部分 访问控制服务接口规范 第 8 部分 单点登录服务接口规范 第 9 部分 电子表单服务接口规范 第 10 部分 业务流程服务接口规范 本部分为 SZDB/Z 17-2008 的第 10 部分。 本技术规范适用于深圳市各级党政机关的信息化建设工作。 对于本部分未能涵盖的内容将依据本技 术规范的编写原则对本部分内容进行扩充。 本技术规范文件由深圳市信息化领导小组办公室、深圳市福田区信息中心提出。 本技术规范文件由深圳市信息化领导小组办公室归口。 本技术规范文件由深圳市信息化领导小组办公室、 深圳市福田区信息中心、 北京有生博大软件技术 有限公司共同起草。 本技术规范文件主要起草人：贾兴东、陈朝祥、张雁、高新辉、王克照、石卫宁、赵斌、李淼、周 礼洪、杨海波、王姝、张焕焕、刘用军、梁文龙等。 本技术规范文件为首次发布。 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 SZDB/Z 17.102008 1 深圳市电子政务应用服务规范 第 10 部分：业务流程服务接口 1 范围 本部分定义了业务流程服务的基本概念，规定了流程定义、流程实例和活动实例的基本状态，规范 了流程服务提供的服务接口，包括流程模型服务接口、流程实例服务接口、应用调用服务接口、流程互 操作服务接口、流程管理服务接口五部分内容，为应用系统提供统一的流程服务。 本部分主要用于深圳市各级党政机关的信息系统规划与建设， 以及电子政务信息系统建设的系统集 成商、软件开发商和监理单位进行信息化规划、建设。适用于规划与开发业务流程相关的应用系统，采 用业务流程进行任务的手工和自动办理， 实现应用系统和业务流程之间的互相调用， 以及不同业务流程 之间的互操作。 2 规范性引用文件 下列文件中的条款通过本部分的引用而成为本部分的条款。 凡是注日期的引用文件， 其随后所有的 修改单（不包括勘误的内容）或修订版均不适用于本部分，然而，鼓励根据本部分达成协议的各方研究 是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本部分。 GB/T 19487-2004 电子政务业务流程设计方法通用规范 SZDB/Z 17.1 -2008 电子政务应用服务规范 第 1 部分：总则 SZDB/Z 17.7 -2008 电子政务应用服务规范 第 7 部分：访问控制服务接口规范 3 术语和定义 资源节点资源节点UID（resourceUID）： 为方便查询、显示以及权限管理，对具有相同或相似业务功能的流程定义进行资源映射。一个资源 节点对应一个流程定义，资源节点可以递归包含，形成树状结构。对资源节点的操作请参照本规范第7 部分中“4.2.2 资源管理”。 流程定义版本流程定义版本(version)： 用来区分同一个流程定义在不同时间内的不同状态， 保存在流程服务器上。 版本的产生由客户端决 定，版本号是一个0或正整数，从0开始，以递增1为一个新版本号。 流程定义（流程定义（ProcessDefinition）：）： 是实现一个业务流转过程的自动化处理模型，包括活动及活动之间关系的网、过程和单独活动（参 与者、应用）开始和结束的约定，如发文流程。 流程实例（流程实例（ProcessInstacnce）：）： 一个流程定义过程单次执行的表示，如一份具体的发文。 活动实例（活动实例（ActivityInstance）：）： 一个流程定义中活动单次执行的表示。它属于一个流程实例，在某个时刻，一个流程实例可同时有 若干个ActivityInstance，但一个ActivityInstance只能与一个ProcessInstance相关。 工作项（工作项（WorkItem）：）： 活动实例对应的工作列表中的项。 一个活动实例中有一个以上的工作项， 通过工作列表展现给最终 用户。 流程实例数据（流程实例数据（InstanceVariable）：）： PDF 文件使用 “pdfFactory Pro“ 试用版本创建 标准分享网 w w w .b z f x w .c o m 免费下载 SZDB/Z 17.102008 2 包含单个流程实例中的所有流程相关数据的集合，如表单数据、意见、正文、附件、签名等。 4 状态定义 4.1 流程定义状态 1Edit：编辑状态，不能创建、运行流程实例，已有的流程实例可以被查询。 2Debug：调试状态，可以创建、运行流程实例，流程实例可以被查询。但在调试状态，创建和运 行的流程实例均带有debug标记，便于以后清除。 3Running：正常执行状态，可以创建、运行流程实例，流程实例可以被查询。 4Suspended：挂起状态，不能再创建新的流程实例，已有的流程实例可以继续执行。 5Freeze：冻结状态，不能创建新的流程实例，已有的流程实例也不能继续执行。 6Hide：隐藏状态，不能创建新的流程实例，已有的流程实例不能继续执行，而且隐藏状态下所 有的流程实例均不能被查询和显示。 流程定义状态与流程定义和流程实例的关系表： 流程定义 流程实例 状态 编辑 查询 创建 运行 查询 Debug 状态 Edit Debug Running Suspended Freeze Hide 注：表示可以执行 4.2 流程实例/活动实例状态 1open 流程实例是可以执行的 2open.running - 流程实例正在执行 3open.notRunning - 流程实例暂时不能执行 4open.notRunning.notStarted - 流程实例已经创建，但还没有启动 5open.notRunning.suspended - 流程实例处于挂起状态 6closed - 流程实例正常执行完毕 7closed.aborted - 流程实例被用户选择跳过 8closed.terminated - 流程实例被用户选择终止 9pleted - 流程实例正常执行完毕 如图1所示。 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 SZDB/Z 17.102008 3 图1 流程实例/活动实例状态示意图 5 业务流程服务 5.1 流程服务总体概述 图 2 业务流程服务示意图 如图 2 所示，业务流程服务的核心组件是流程服务器，流程服务器可以提供五类服务：流程模型服 务、流程实例服务、应用调用服务、流程互操作服务和流程管理服务。 流程模型服务：是对流程模型的管理服务。流程模型提供对业务流程的形式化描述，通过流程定义 工具输入或输出定义好的流程模型，以及图形化展示。 流程实例服务：是操作并控制流程实例、活动实例运行和状态的服务。本类服务访问和操作流程中 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 标准分享网 w w w .b z f x w .c o m 免费下载 SZDB/Z 17.102008 4 的实例数据。各应用系统主要使用的是本类服务，包括执行流程的客户端。 应用调用服务： 是调用其他应用程序实现任务自动化的服务。 本类服务来实现流程服务和各应用系 统间的调用，可在流程服务的各环节调用其他应用程序，实现业务流程贯通。 流程互操作服务： 是流程服务之间相互通讯和调用的服务。 本类服务实现流程服务器之间的协同工 作。 流程管理服务：是对流程服务器进行监控、管理的服务。本类服务可以启动、停止流程服务器，获 取流程运行的日志信息，导出或迁移流程定义等。 5.2 流程模型服务 是对流程模型的管理服务。 流程模型提供对业务流程的形式化描述， 通过流程定义工具输入或输出 定义好的流程模型，以及图形化展示。 包括部署、删除、更新、查找、获取流程定义、控制流程定义版本、获取和改变流程定义状态等服 务。 5.2.1 部署指定流程定义 服务名称 ProcessDefinitionService.deployProcessDefinition 服务说明 部署流程定义到指定的资源节点下，如果流程定义对象没有 UID，则自动生成新的流程定 义，作为新流程对待；否则，为此流程定义自动生成新版本。 参数名称 参数说明 processDefinition ProcessDefinition 对象，可以是自定义的流程定义对 象或者以 XML 格式描述的流程定义信息。 参数列表 resourceUID String 类型，流程定义所属的资源节点 UID。 NoSuchElementException 如果流程定义所属的资源节点不存在，则抛出此异常。 异常处理 ProcessDefinitionException 如果部署失败，则抛出此异常。 返回值 返回 ProcessDefinition 对象，是经过流程服务器处理的 ProcessDefinition 对象，具 有 uid 和版本号。 备注 5.2.2 更新指定版本流程定义 服务名称 ProcessDefinitionService.updateProcessDefinition 服务说明 更新指定版本的流程定义。 参数名称 参数说明 processDefinition ProcessDefinition 对象，可以是自定义的流程定义对 象或者以 XML 格式描述的流程定义信息。 传入的流程定 义对象需要有 uid。 参数列表 version int 类型，流程定义版本，从 0 开始，如果版本为-1， 则更新最高版本的流程定义。 NoSuchElementException 如果流程定义或相应版本不存在，则抛出此异常。 异常处理 ProcessDefinitionException 如果更新失败，则抛出此异常。 返回值 返回 ProcessDefinition 对象，是经过流程服务器处理的 ProcessDefinition 对象，具 有 uid 和版本号。 备注 5.2.3 删除流程定义 服务名称 ProcessDefinitionService.deleteProcessDefinition PDF 文件使用 “pdfFactory Pro“ 试用版本创建 SZDB/Z 17.102008 5 服务说明 删除指定版本的流程定义。 参数名称 参数说明 UID String 类型，流程定义唯一标识。 参数列表 version int 类型， 流程定义的版本号， 从 0 开始。 如果是 “-1” 则表示删除流程定义的所有版本。 NoSuchElementException 如果流程定义不存在，则抛出此异常。 异常处理 ProcessDefinitionException 如果删除失败，则抛出此异常。 返回值 无 备注 如果此流程定义指定的版本有对应的流程实例，则抛出异常，此流程定义不会被删除。 当版本号是“-1”时，表示删除流程定义的所有版本，如果此流程定义的任何版本有对 应的流程实例，将抛出异常，此流程定义的任何版本都不会被删除。 5.2.4 获取指定流程定义状态 服务名称 ProcessDefinitionService.getProcessDefinitionState 服务说明 获取指定流程定义的状态信息。 参数名称 参数说明 UID String 类型，流程定义唯一标识。 参数列表 version int 类型，指定流程定义的版本号，从 0 开始。 异常处理 NoSuchElementException 如果流程定义不存在， 或者版本不存在， 则抛出此异常。 返回值 String 类型，返回指定流程定义的状态值，参见“4.1 流程定义状态” 。 备注 5.2.5 改变指定流程定义状态 服务名称 ProcessDefinitionService.changeProcessDefinitionState 服务说明 改变指定流程定义的状态。 参数名称 参数说明 UID String 类型，流程定义唯一标识。 version int 类型，流程定义的版本号，从 0 开始。 参数列表 newState String 类型，新状态，参见“4.1 流程定义状态” 。 异常处理 NoSuchElementException 如果流程定义不存在，或者相应的版本不存在，则抛出 此异常。 返回值 无 备注 5.2.6 查找指定的流程定义 服务名称 ProcessDefinitionService.searchProcessDefinitions 服务说明 根据指定的范围、状态、筛选条件，获取流程定义列表。 参数名称 参数说明 resourceUIDs String 数组类型，查找流程定义唯一标识的范围，是 流程定义资源节点的 UID，用流程定义资源根节点的 UID 来表示所有范围。 参数列表 processDefinitionState String 类型，流程定义状态值。Null 表示所有状态。 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 标准分享网 w w w .b z f x w .c o m 免费下载 SZDB/Z 17.102008 6 whereCase String 类型，查询条件，不包含 where 字符串。查询 条件的格式应符合 ANSI SQL 92 中 where 子句对查询条 件的要求。 NoSuchElementException 如果指定范围不存在，则抛出此异常。 异常处理 SearchException 如果查询条件错误，或执行查询错误，则抛出此异常 返回值 返回 ProcessDefinition 对象数组。 备注 5.2.7 获取最新版本的流程定义 服务名称 ProcessDefinitionService.getProcessDefinition 服务说明 根据流程定义的 UID，获取最新版本的流程定义。 参数名称 参数说明 参数列表 UID String 类型，流程定义唯一标识。 异常处理 NoSuchElementException 如果指定流程定义对象不存在，或版本不存在，则抛出 此异常。 返回值 返回 ProcessDefinition 对象。 备注 5.2.8 获取指定版本的流程定义 服务名称 ProcessDefinitionService.getProcessDefinitionOneVersion 服务说明 根据流程定义的 UID，获取指定版本的流程定义。 参数名称 参数说明 UID String 类型，流程定义唯一标识。 参数列表 version int 类型，流程定义的版本号，从 0 开始。 异常处理 NoSuchElementException 如果指定流程定义对象不存在，或版本不存在，则抛出 此异常。 返回值 返回 ProcessDefinition 对象。 备注 5.2.9 获取流程定义的所有版本 服务名称 ProcessDefinitionService.getProcessDefinitionAllVersion 服务说明 根据流程定义的 UID，获取流程定义的所有版本。 参数名称 参数说明 参数列表 UID String 类型，流程定义唯一标识。 异常处理 NoSuchElementException 如果指定流程定义对象不存在，则抛出此异常。 返回值 返回 ProcessDefinitions 对象数组。 备注 5.3 流程实例服务 是操作并控制流程实例、活动实例运行和状态的服务。本类服务访问和操作流程中的实例数据。各 应用系统主要使用的是本类服务，包括执行流程的客户端。 包括创建并启动流程实例、删除流程实例、获取及改变流程实例的状态、获取活动列表和改变活动 状态、获取工作项列表、改变工作项状态、重新分配工作项等。 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 SZDB/Z 17.102008 7 5.3.1 获取流程实例对象 服务名称 ProcessInstanceService.getProcessInstance 服务说明 根据指定的流程实例的 UID，获取流程实例对象。 参数名称 参数说明 processInstanceUID String 类型，指定流程实例唯一标识。 参数列表 NoSuchElementException 如果没有对应的流程定义，则抛出此异常。 返回值 返回 ProcessInstance 对象。 备注 5.3.2 创建流程实例 服务名称 ProcessInstanceService.createProcessInstance 服务说明 创建指定流程定义的流程实例，如果没有指定流程定义版本，则创建处于可运行状态的 最高版本的流程定义实例。 参数名称 参数说明 processDefinitionUID String 类型，指定流程定义唯一标识。 参数列表 version int 类型，指定流程定义的版本号，从 0 开始，如果为 -1 表示自动选择处于可运行状态的最高版本。 ProcessInstanceException 如果创建流程实例失败，则抛出此异常 异常处理 NoSuchElementException 如果没有对应的流程定义，则抛出此异常。 返回值 返回已创建的 ProcessInstance 对象。 备注 5.3.3 创建流程实例并指定起始节点 服务名称 ProcessInstanceService.createProcessInstance 服务说明 创建指定流程定义的流程实例，并指定新建流程实例的起始节点。 参数名称 参数说明 processDefinitionUID String 类型，指定流程定义唯一标识。 version int 类型，指定流程定义的版本号。 参数列表 initActivityUID String 类型，流程定义活动节点唯一标识。 ProcessInstanceException 如果创建流程实例失败，则抛出此异常 异常处理 NoSuchElementException 如果没有对应的流程定义，则抛出此异常。 返回值 返回已创建的 ProcessInstance 对象。 备注 5.3.4 创建子流程实例 服务名称 ProcessInstanceService.createSubProcessInstance 服务说明 在指定的父流程实例下，创建一个指定子流程定义的流程实例，并指定新建子流程实例 的起始节点，如果为空，则为默认起始节点。 参数名称 参数说明 parentProcessInstanceUID String 类型，指定主流程实例唯一标识。 subProcessDefinitionUID String 类型，指定要创建的流程定义唯一标识。 version Int 类型，指定子流程定义的版本号 参数列表 initActivityUID String 类型，流程定义活动节点唯一标识，子流程起 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 标准分享网 w w w .b z f x w .c o m 免费下载 SZDB/Z 17.102008 8 始节点。 ProcessInstanceException 如果创建流程实例失败，则抛出此异常 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 异常处理 IllegalArgumentException 如果参数为空，则抛出此异常。 返回值 返回已创建的 ProcessInstance 对象。 备注 主流程实例可以是同步或异步方式，可用 changeProcessInstanceState 来设置主流程实 例的状态。 5.3.5 删除指定的流程实例 服务名称 ProcessInstanceService.deleteProcessInstance 服务说明 删除指定的流程实例，如果存在子流程，则同时删除关联的子流程。 参数名称 参数说明 参数列表 processInstanceUID String 类型，指定要删除流程实例唯一标识。 ProcessInstanceException 如果创建流程实例失败，则抛出此异常 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.3.6 获取指定流程实例状态 服务名称 ProcessInstanceService.getProcessInstanceState 服务说明 根据指定流程实例唯一标识，返回当前实例的状态。 参数名称 参数说明 参数列表 processInstanceUID String 类型，指定当前流程实例唯一标识。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 返回当前流程实例的状态信息。 备注 5.3.7 改变指定流程实例状态 服务名称 ProcessInstanceService.changeProcessInstanceState 服务说明 根据指定的流程实例唯一标识，改变流程实例状态。 参数名称 参数说明 processInstanceUID String 类型，指定要改变状态的流程实例唯一标识。 参数列表 newState String 类型，要变更的状态值 ProcessInstanceException 如果流程实例变更状态失败，则抛出此异常 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.3.8 改变指定流程实例依赖的定义版本 服务名称 ProcessInstanceService.changeProcessInstanceVersion 服务说明 改变指定流程实例所依赖的流程定义版本号属性。 参数名称 参数说明 参数列表 processInstanceUID String 类型，指定要修改流程实例唯一标识。 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 SZDB/Z 17.102008 9 newVersion int 类型，用于变更的流程定义版本号。 ProcessInstanceException 如果改变流程实例失败，则抛出此异常 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.3.9 查找指定流程实例 服务名称 ProcessInstanceService.searchProcessInstances 服务说明 根据条件查找流程实例。 参数名称 参数说明 processDefinitionUIDs String 数组类型，要查找的流程定义唯一标识范围。 Null 表示所有流程定义。 processInstanceStates String 数组类型，要查找的流程实例状态。Null 表示 所有状态。 actorUIDs String 数组类型，参与者列表。 whereCase String 类型，查询条件，不包含 where 字符串。查询 条件的格式应符合 ANSI SQL 92 中 where 子句对查询条 件的要求。 pageSize Int 类型，每页显示的数目。 参数列表 pageNo Int 类型，显示第几页。 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 ProcessInstanceException 如果流程实例查找过程失败，则抛出此异常 异常处理 SearchException 如果查找条件错误引起查找失败，则抛出此异常 返回值 返回符合条件的流程实例唯一标识数组。 备注 5.3.10 获取指定的活动实例 服务名称 ProcessInstanceService.getActivityInstance 服务说明 根据活动实例唯一标识，获得指定的活动实例对象。 参数名称 参数说明 参数列表 activityInstanceUID String 类型，指定的活动实例唯一标识。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 返回 ActivityInstance 对象。 备注 5.3.11 获取指定活动的后续活动 服务名称 ProcessInstanceService.getNextActivities 服务说明 获得指定活动的所有直接后续活动。 参数名称 参数说明 参数列表 activityInstanceUID String 类型，指定的活动实例唯一标识。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 返回所有后续活动的唯一标识数组。 备注 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 标准分享网 w w w .b z f x w .c o m 免费下载 SZDB/Z 17.102008 10 5.3.12 获取指定活动的前驱活动 服务名称 ProcessInstanceService.getPreviousActivities 服务说明 获得指定活动的所有前驱活动。 参数名称 参数说明 参数列表 activityInstanceUID String 类型，指定的活动实例唯一标识。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 返回所有前驱活动的唯一标识数组。 备注 5.3.13 获取指定流程实例的活动实例组 服务名称 ProcessInstanceService.getActivityInstances 服务说明 获得指定流程实例不同状态下的活动实例。 参数名称 参数说明 processInstanceUID String 类型，指定流程实例唯一标识。 参数列表 activityInstanceStates String 数组，活动实例状态。Null 表示所有状态。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 返回 ActivityInstance 对象数组。 备注 5.3.14 获取指定流程实例的子流程实例数组 服务名称 ProcessInstanceService.getSubProcessInstances 服务说明 获得流程实例所包含的子流程实例。 参数名称 参数说明 参数列表 processInstanceUID String 类型，指定的流程实例唯一标识。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 返回 ProcessInstance 对象数组。 备注 5.3.15 获取指定流程实例的父流程实例 服务名称 ProcessInstanceService.getParentProcessInstance 服务说明 获得流程实例的父流程实例。 参数名称 参数说明 参数列表 processInstanceUID String 类型，指定的流程实例唯一标识。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 返回 ProcessInstance 对象。 备注 5.3.16 获取指定活动实例状态 服务名称 ProcessInstanceService.getActivityInstanceState 服务说明 获取指定活动实例的状态。 参数名称 参数说明 参数列表 activityInstanceUID String 类型，指定当前活动实例唯一标识。 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 SZDB/Z 17.102008 11 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 返回当前活动实例的状态信息。 备注 5.3.17 改变指定活动实例状态 服务名称 ProcessInstanceService.changeActivityInstanceState 服务说明 改变指定活动实例的状态。 参数名称 参数说明 activityInstanceUID String 类型，要改变的状态流程实例唯一标识。 参数列表 newState String 类型，用于变更的状态值 ProcessInstanceException 如果流程实例变更状态失败，则抛出此异常 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.3.18 活动实例回退 服务名称 ProcessInstanceService.rollbackToActivity 服务说明 回收或者回退指定的活动实例对象。如果是回收，则回收所有后续活动实例，如果后续活 动实例已经处于运行状态，则不能被回收；如果是回退，则退回到上一前驱活动。 参数名称 参数说明 activityInstanceUID String 类型，要回退的活动实例唯一标识。 参数列表 rollbackToActivityDefinitionUID String 类型，要回退到的活动唯一标识。 ProcessInstanceException 如果活动实例回退失败，则抛出此异常。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.3.19 获取工作列表 服务名称 ProcessInstanceService.getWorkList 服务说明 获取流程工作列表，能够分页显示。 参数名称 参数说明 processDefinitionUIDs String 数组，要查找的流程定义唯一标识范围。Null 表示所有流程定义。 processInstanceStates String 数组，要查找的流程实例状态。Null 表示所有 状态。 actorUIDs String 数组，参与者列表。Null 表示所有参与者。 whereCase String 类型，查询条件，不包含 where 字符串。查询 条件的格式应符合 ANSI SQL 92 中 where 子句对查询条 件的要求。 pageSize int 类型，每页显示的数目。 参数列表 pageNo int 类型，显示第几页。 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 异常处理 SearchException 如果查找条件错误引起查找失败，则抛出此异常 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 标准分享网 w w w .b z f x w .c o m 免费下载 SZDB/Z 17.102008 12 返回值 返回 WorkItem 对象数组。 备注 5.3.20 更新指定的工作项 服务名称 ProcessInstanceService.updateWorkItem 服务说明 更新指定的工作项信息。 参数名称 参数说明 参数列表 workItem WorkItem 对象，用于更新的工作项对象。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 工作项的状态，例如： 待阅：此工作项还没有查看。 已阅：此工作项已经由收件人打开查看，但还没有开始办理。 暂存：此工作项已经由收件人查看并修改、保存，尚未办理完。 结束：此工作项已经办理完成。 5.3.21 结束指定的工作项 服务名称 ProcessInstanceService.finishWorkItem 服务说明 结束指定的工作项。 参数名称 参数说明 workItemUIDs String 数组，要结束的工作项唯一标识数组。 actorUID String 类型，工作项当前办理人唯一标识。 参数列表 agentActorUID String 类型，工作项代理办理人唯一标识。 ProcessInstanceException 如果结束工作项失败，则抛出此异常。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 如果代理人员不为空，则工作项标记为由代理人结束 5.3.22 获取流程实例数据 服务名称 ProcessInstanceService.getInstanceVariable 服务说明 获取指定流程实例的实例数据。 参数名称 参数说明 参数列表 processInstanceUID String 类型，流程实例唯一标识。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 返回 InstanceVariable 对象。 备注 5.3.23 设置流程实例数据 服务名称 ProcessInstanceService.setInstanceVariable 服务说明 设置指定流程实例的实例数据。 参数名称 参数说明 processInstanceUID String 类型，流程实例唯一标识。 参数列表 instanceVariable InstanceVariable 对象。 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 SZDB/Z 17.102008 13 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.3.24 指派活动参与者 服务名称 ProcessInstanceService.assignParticipant 服务说明 为指定流程实例的活动指派参与者。 参数名称 参数说明 processInstanceUID String 类型，流程实例唯一标识。 activityDefinitionUID String 类型，活动定义唯一标识。 参数列表 actorUIDs String 数组，参与者唯一标识数组 ProcessInstanceException 如果指派参与者失败，则抛出此异常。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 参与者的工作项是自动产生的，不需要用 API 创建。 5.3.25 运行指定的活动实例 服务名称 ProcessInstanceService.run 服务说明 运行指定的活动实例。 参数名称 参数说明 参数列表 activityInstanceUID String 类型，要运行的活动实例唯一标识。 ProcessInstanceException 如果活动实例运行失败，则抛出此异常。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.3.26 运行指定路径的活动实例 服务名称 ProcessInstanceService.run 服务说明 以指定路径运行活动实例。 参数名称 参数说明 activityInstanceUID String 类型，要运行的活动实例唯一标识。 参数列表 transitionName String 类型，活动实例运行的路径名称。 ProcessInstanceException 如果活动实例运行失败，则抛出此异常。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.3.27 启动流程实例 服务名称 ProcessInstanceService.start 服务说明 启动流程实例。 参数名称 参数说明 参数列表 processInstanceUID String 类型，要启动的流程实例唯一标识。 异常处理 ProcessInstanceException 如果活动实例启动失败，则抛出此异常。 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 标准分享网 w w w .b z f x w .c o m 免费下载 SZDB/Z 17.102008 14 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.3.28 结束流程实例 服务名称 ProcessInstanceService.finish 服务说明 正常结束流程实例。如果结束的是子流程，就返回主流程。 参数名称 参数说明 processInstanceUID String 类型，要结束的流程实例唯一标识。 参数列表 finishState String 类型，指定流程实例以何种状态结束 ProcessInstanceException 如果活动实例结束失败，则抛出此异常。 异常处理 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 返回值 无 备注 5.4 应用调用服务 是调用其他应用程序实现任务自动化的服务。 本类服务来实现流程服务和各应用系统间的调用， 可 在流程服务的各环节调用其他应用程序，实现业务流程贯通。 应用调用服务通常用来调用其他应用程序执行特定的任务，如调用 PDF 生成程序生成 PDF 文档、 调用打印服务器打印文档。 图 3 应用调用示意图 应用调用服务通过“应用代理”组件来完成调用。应用调用服务必须提供“双向”服务，既可以从 流程服务调用应用程序，也可以从应用程序调用流程服务。应用调用服务同时提供更新数据的功能，包 括应用程序更新流程服务数据以及流程服务更新应用程序数据。 5.4.1 同步调用应用程序 服务名称 AppInvocationService.invokeAppSync 服务说明 通过“应用代理”组件来调用应用程序， “应用代理”组件启动应用程序，并将流程服务 的相关参数信息传递给应用程序，待应用程序执行完成后，将应用程序的执行结果返回 给流程服务器。 本调用方式为同步调用，即流程服务器的线程将阻塞，等待返回结果。 参数列表 参数名称 参数说明 PDF 文件使用 “pdfFactory Pro“ 试用版本创建 SZDB/Z 17.102008 15 agent String 类型， “应用代理”组件名称。 applicationName String 类型，要执行的应用程序名称。 processInstanceUID String 类型，流程实例唯一标识 workItemUID String 类型，工作项唯一标识 parameters 对象数组，传入的参数数组 applicationMode int 类型，应用程序执行的基本方式： 1、 后台执行，缺省的方式。 2、 前台执行。 3、 批量执行。 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 异常处理 AppInvocationException 如果调用失败，无法返回对象，则抛出此异常 返回值 返回 RelevantData 对象，包含应用程序返回给流程服务器的相关数据。 备注 5.4.2 异步调用应用程序 服务名称 AppInvocationService.invokeAppAsync 服务说明 通过“应用代理”组件来调用应用程序， “应用代理”组件启动应用程序，并将流程服务 的相关参数信息传递给应用程序。 本调用方式为异步调用，即流程服务器执行调用后将立即返回，不等待应用程序返回结 果。 参数名称 参数说明 agent String 类型， “应用代理”组件名称。 applicationName String 类型，要执行的应用程序名称。 processInstanceUID String 类型，流程实例唯一标识 workItemUID String 类型，工作项唯一标识 parameters 对象数组，传入的参数数组 参数列表 applicationMode int 类型，应用程序执行的基本方式： 4、 后台执行，缺省的方式。 5、 前台执行。 1. 批量执行。 NoSuchElementException 如果根据参数获得对象为空，则抛出此异常。 异常处理 AppInvocationException 如果调用失败，无法返回对象，则抛出此异常 返回值 无 备注 5.4.3 获取异步应用程序调用结果 服务名称 AppInvocationService.getAsyncInvoked 服务说明 检查异步调用应用程序的情况，如果执行完成，返回异步调用的结果。 参数名称 参数说明