com.actionsoft.sdk.local.api

接口 FormAPI

public interface FormAPI

表单访问和操作接口

方法概要

限定符和类型	方法和说明
java.lang.String	getDWFormMainPage(UserContext userContext, ProcessInstance processInst, int openState) 返回完整的带有工具栏的表单
java.lang.String	getDWFormMainPage(UserContext userContext, java.lang.String processInstId, int openState) 返回完整的带有工具栏的表单
java.lang.String	getDWFormURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId, java.lang.String formDefId) 返回完整的带有工具栏的表单URL
java.lang.String	getDWFormURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId, java.lang.String formDefId, int openState) 返回完整的带有工具栏的表单URL
java.lang.String	getFormExtendsButtonsJSON(UserContext userContext, ProcessInstance processInst, TaskInstance taskInst, java.lang.String userTaskDefId) 获取节点配置的扩展按钮JSON结构
java.lang.String	getFormExtendsButtonsJSON(UserContext userContext, java.lang.String processInstId, java.lang.String taskInstId, java.lang.String userTaskDefId) 获取节点配置的扩展按钮JSON结构
java.lang.String	getFormHistoryOpinionHTML(UserContext userContext, java.lang.String processInstId) 获取流程实例审批的记录的平台默认提供的HTML片段
java.lang.String	getFormHistoryOpinionJSON(UserContext userContext, java.lang.String processInstId) 获取流程实例审批的记录的JSON结构
java.lang.String	getFormMainPage(UserContext userContext, ProcessInstance processInst, TaskInstance taskInst) 已过时。 被getFormPage方法替代，后期会删除，请注意重构
java.lang.String	getFormMainPage(UserContext userContext, ProcessInstance processInst, TaskInstance taskInst, int openState) 已过时。 被getFormPage方法替代，后期会删除，请注意重构
java.lang.String	getFormMainPage(UserContext userContext, java.lang.String processInstId, java.lang.String taskInstId) 已过时。 被getFormPage方法替代，后期会删除，请注意重构
java.lang.String	getFormMainPage(UserContext userContext, java.lang.String processInstId, java.lang.String taskInstId, int openState) 已过时。 被getFormPage方法替代，后期会删除，请注意重构
java.lang.String	getFormMainURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId, java.lang.String taskInstId, java.lang.String formDefId, int openState) 已过时。 被getFormURL方法替代，后期会删除，请注意重构
java.lang.String	getFormMainURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId, java.lang.String taskInstId, java.lang.String formDefId, int openState, boolean displayToolbar) 已过时。 被getFormURL方法替代，后期会删除，请注意重构
java.lang.String	getFormPage(UserContext userContext, ProcessInstance processInst, TaskInstance taskInst, java.lang.Integer openState, java.lang.Integer currentPage, java.lang.String formDefId, java.lang.String boId) 返回表单页面，包含按钮工具条
java.lang.String	getFormPage(UserContext userContext, ProcessInstance processInst, TaskInstance taskInst, java.lang.Integer openState, java.lang.Integer currentPage, java.lang.String formDefId, java.lang.String boId, java.lang.String lang, boolean displayToolbar) 返回表单页面
java.lang.String	getFormPage(UserContext userContext, ProcessInstance processInst, TaskInstance taskInst, int openState, int currentPage, java.lang.String formDefId, java.lang.String boId) 返回表单页面，包含按钮工具条
java.lang.String	getFormPage(UserContext userContext, ProcessInstance processInst, TaskInstance taskInst, int openState, int currentPage, java.lang.String formDefId, java.lang.String boId, java.lang.String lang, boolean displayToolbar) 返回表单页面
java.lang.String	getFormPage(UserContext userContext, java.lang.String processInstId, java.lang.String taskInstId, java.lang.Integer openState, java.lang.Integer currentPage, java.lang.String formDefId, java.lang.String boId) 返回表单页面，包含按钮工具条
java.lang.String	getFormPage(UserContext userContext, java.lang.String processInstId, java.lang.String taskInstId, java.lang.Integer openState, java.lang.Integer currentPage, java.lang.String formDefId, java.lang.String boId, java.lang.String lang, boolean displayToolbar) 返回表单页面
java.lang.String	getFormPage(UserContext userContext, java.lang.String processInstId, java.lang.String taskInstId, java.lang.Integer openState, java.lang.Integer currentPage, java.lang.String formDefId, java.lang.String boId, java.lang.String lang, boolean displayToolbar, java.util.Map<java.lang.String,java.lang.Object> extParams) 返回表单页面
java.lang.String	getFormPage(UserContext userContext, java.lang.String processInstId, java.lang.String taskInstId, int openState, int currentPage, java.lang.String formDefId, java.lang.String boId) 返回表单页面，包含按钮工具条
java.lang.String	getFormPage(UserContext userContext, java.lang.String processInstId, java.lang.String taskInstId, int openState, int currentPage, java.lang.String formDefId, java.lang.String boId, java.lang.String lang, boolean displayToolbar) 返回表单页面
java.lang.String	getFormSysButtonsJSON(UserContext userContext, ProcessInstance processInst, TaskInstance taskInst, java.lang.String userTaskDefId, int openState) 获取表单系统提供的按钮JSON结构
java.lang.String	getFormSysButtonsJSON(UserContext userContext, java.lang.String processInstId, java.lang.String taskInstId, java.lang.String userTaskDefId, int openState) 获取表单系统提供的按钮JSON结构
java.lang.String	getFormTokenUrl(java.lang.String taskInstId) 获取任务的无会话请求的表单URL，其中包含TokenID，Token有效期默认3天 6.2.8以前的版本可以调用com.actionsoft.sdk.local.api.PortalAPI#getTaskInstTokenUrl(java.lang.String)方法
java.lang.String	getFormTrackURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId) 获取流程跟踪URL，平台默认调用流程设计图样式的跟踪图，该模式要求IE10及以上浏览器支持，除非流程实施时候修改了设置
java.lang.String	getFormTrackURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId, boolean supportCanvas, java.lang.String formInfo) 获取流程跟踪URL
java.lang.String	getFormURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId, java.lang.String taskInstId, java.lang.Integer openState, java.lang.String formDefId, java.lang.String boId, java.lang.String lang) 返回表单页面URL，包含按钮工具条
java.lang.String	getFormURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId, java.lang.String taskInstId, java.lang.Integer openState, java.lang.String formDefId, java.lang.String boId, java.lang.String lang, boolean displayToolbar) 返回表单页面URL
java.lang.String	getFormURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId, java.lang.String taskInstId, int openState, java.lang.String formDefId, java.lang.String boId, java.lang.String lang) 返回表单页面URL，包含按钮工具条
java.lang.String	getFormURL(java.lang.String bpmPortalHost, java.lang.String sid, java.lang.String processInstId, java.lang.String taskInstId, int openState, java.lang.String formDefId, java.lang.String boId, java.lang.String lang, boolean displayToolbar) 返回表单页面URL
java.io.File	getLastSnapshotPDFFile(java.lang.String processInstId, java.lang.String processDefId, java.lang.String userTaskDefId) 返回最新的一个表单快照的PDF文件

方法详细资料

getDWFormMainPage

java.lang.String getDWFormMainPage(UserContext userContext,
                                   java.lang.String processInstId,
                                   int openState)

返回完整的带有工具栏的表单

参数:

userContext - 用户上下文对象

processInstId - DW模型对应的流程实例ID

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态，参考UserTaskRuntimeConst中STATE为起始命名的常量

返回:

完整的HTML页面，可用于CMD中

getDWFormMainPage

java.lang.String getDWFormMainPage(UserContext userContext,
                                   ProcessInstance processInst,
                                   int openState)

返回完整的带有工具栏的表单

参数:

userContext - 用户上下文对象

processInst - DW模型对应的流程实例对象

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态，参考UserTaskRuntimeConst中STATE为起始命名的常量

返回:

完整的HTML页面，可用于CMD中

getDWFormURL

java.lang.String getDWFormURL(java.lang.String bpmPortalHost,
                              java.lang.String sid,
                              java.lang.String processInstId,
                              java.lang.String formDefId)

返回完整的带有工具栏的表单URL

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl。如果为空，默认提供相对路径的URL，如./w

processInstId - DW模型对应的流程实例ID

formDefId - 表单定义ID。如果为空，系使用默认的表单

返回:

表单的URL

另请参阅:

PlatformAPI.getPortalUrl()

getDWFormURL

java.lang.String getDWFormURL(java.lang.String bpmPortalHost,
                              java.lang.String sid,
                              java.lang.String processInstId,
                              java.lang.String formDefId,
                              int openState)

返回完整的带有工具栏的表单URL

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl。如果为空，默认提供相对路径的URL，如./w

processInstId - DW模型对应的流程实例ID

formDefId - 表单定义ID。如果为空，系使用默认的表单

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态，参考UserTaskRuntimeConst中STATE为起始命名的常量

返回:

表单的URL

另请参阅:

只读, 常规, PlatformAPI.getPortalUrl()

getFormPage

java.lang.String getFormPage(UserContext userContext,
                             java.lang.String processInstId,
                             java.lang.String taskInstId,
                             java.lang.Integer openState,
                             java.lang.Integer currentPage,
                             java.lang.String formDefId,
                             java.lang.String boId)

返回表单页面，包含按钮工具条

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

taskInstId - 任务实例ID

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。可为空，默认读取任务实例状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

currentPage - 子表当前页数，默认值为1

formDefId - 表单定义ID，可为空，系统会使用默认的表单

boId - BO表记录ID，可为空

返回:

返回完整的表单页面

从以下版本开始:

6.2.7.0426

另请参阅:

UserTaskRuntimeConst

getFormPage

java.lang.String getFormPage(UserContext userContext,
                             java.lang.String processInstId,
                             java.lang.String taskInstId,
                             int openState,
                             int currentPage,
                             java.lang.String formDefId,
                             java.lang.String boId)

返回表单页面，包含按钮工具条

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

taskInstId - 任务实例ID

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

currentPage - 子表当前页数，默认值为1

formDefId - 表单定义ID，可为空，系统会使用默认的表单

boId - BO表记录ID，可为空

返回:

返回完整的表单页面

另请参阅:

UserTaskRuntimeConst

getFormPage

java.lang.String getFormPage(UserContext userContext,
                             ProcessInstance processInst,
                             TaskInstance taskInst,
                             java.lang.Integer openState,
                             java.lang.Integer currentPage,
                             java.lang.String formDefId,
                             java.lang.String boId)

返回表单页面，包含按钮工具条

参数:

userContext - 用户上下文对象

processInst - 流程实例

taskInst - 任务实例

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。可为空，默认读取任务实例状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

currentPage - 子表当前页数，默认值为1

formDefId - 表单定义ID，可为空，系统会使用默认的表单

boId - BO表记录ID，可为空

返回:

返回完整的表单页面

从以下版本开始:

6.2.7.0426

另请参阅:

UserTaskRuntimeConst

getFormPage

java.lang.String getFormPage(UserContext userContext,
                             ProcessInstance processInst,
                             TaskInstance taskInst,
                             int openState,
                             int currentPage,
                             java.lang.String formDefId,
                             java.lang.String boId)

返回表单页面，包含按钮工具条

参数:

userContext - 用户上下文对象

processInst - 流程实例

taskInst - 任务实例

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

currentPage - 子表当前页数，默认值为1

formDefId - 表单定义ID，可为空，系统会使用默认的表单

boId - BO表记录ID，可为空

返回:

返回完整的表单页面

另请参阅:

UserTaskRuntimeConst

getFormPage

java.lang.String getFormPage(UserContext userContext,
                             java.lang.String processInstId,
                             java.lang.String taskInstId,
                             java.lang.Integer openState,
                             java.lang.Integer currentPage,
                             java.lang.String formDefId,
                             java.lang.String boId,
                             java.lang.String lang,
                             boolean displayToolbar)

返回表单页面

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

taskInstId - 任务实例ID

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。可为空，默认读取任务实例状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

currentPage - 子表当前页数，默认值为1

formDefId - 表单定义ID，可为空，系统会使用默认的表单

boId - BO表记录ID，可为空

lang - 需要表单显示的语言，不指定使用系统默认语言

displayToolbar - 是否展示按钮工具条

返回:

返回表单页面

从以下版本开始:

6.2.7.0426

另请参阅:

UserTaskRuntimeConst

getFormPage

java.lang.String getFormPage(UserContext userContext,
                             java.lang.String processInstId,
                             java.lang.String taskInstId,
                             java.lang.Integer openState,
                             java.lang.Integer currentPage,
                             java.lang.String formDefId,
                             java.lang.String boId,
                             java.lang.String lang,
                             boolean displayToolbar,
                             java.util.Map<java.lang.String,java.lang.Object> extParams)

返回表单页面

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

taskInstId - 任务实例ID

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。可为空，默认读取任务实例状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

currentPage - 子表当前页数，默认值为1

formDefId - 表单定义ID，可为空，系统会使用默认的表单

boId - BO表记录ID，可为空

lang - 需要表单显示的语言，不指定使用系统默认语言

displayToolbar - 是否展示按钮工具条

extParams - 扩展参数

返回:

返回表单页面

从以下版本开始:

6.3.GA

另请参阅:

UserTaskRuntimeConst

getFormPage

java.lang.String getFormPage(UserContext userContext,
                             java.lang.String processInstId,
                             java.lang.String taskInstId,
                             int openState,
                             int currentPage,
                             java.lang.String formDefId,
                             java.lang.String boId,
                             java.lang.String lang,
                             boolean displayToolbar)

返回表单页面

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

taskInstId - 任务实例ID

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

currentPage - 子表当前页数，默认值为1

formDefId - 表单定义ID，可为空，系统会使用默认的表单

boId - BO表记录ID，可为空

lang - 需要表单显示的语言，不指定使用系统默认语言

displayToolbar - 是否展示按钮工具条

返回:

返回表单页面

另请参阅:

UserTaskRuntimeConst

getFormPage

java.lang.String getFormPage(UserContext userContext,
                             ProcessInstance processInst,
                             TaskInstance taskInst,
                             java.lang.Integer openState,
                             java.lang.Integer currentPage,
                             java.lang.String formDefId,
                             java.lang.String boId,
                             java.lang.String lang,
                             boolean displayToolbar)

返回表单页面

参数:

userContext - 用户上下文对象

processInst - 流程实例

taskInst - 任务实例

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。可为空，默认读取任务实例状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

currentPage - 子表当前页数，默认值为1

formDefId - 表单定义ID，可为空，系统会使用默认的表单

boId - BO表记录ID，可为空

lang - 需要表单显示的语言，不指定使用系统默认语言

displayToolbar - 是否展示按钮工具条

返回:

返回表单页面

从以下版本开始:

6.2.7.0426

另请参阅:

UserTaskRuntimeConst

getFormPage

java.lang.String getFormPage(UserContext userContext,
                             ProcessInstance processInst,
                             TaskInstance taskInst,
                             int openState,
                             int currentPage,
                             java.lang.String formDefId,
                             java.lang.String boId,
                             java.lang.String lang,
                             boolean displayToolbar)

返回表单页面

参数:

userContext - 用户上下文对象

processInst - 流程实例

taskInst - 任务实例

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

currentPage - 子表当前页数，默认值为1

formDefId - 表单定义ID，可为空，系统会使用默认的表单

boId - BO表记录ID，可为空

lang - 需要表单显示的语言，不指定使用系统默认语言

displayToolbar - 是否展示按钮工具条

返回:

返回表单页面

另请参阅:

UserTaskRuntimeConst

getFormURL

java.lang.String getFormURL(java.lang.String bpmPortalHost,
                            java.lang.String sid,
                            java.lang.String processInstId,
                            java.lang.String taskInstId,
                            java.lang.Integer openState,
                            java.lang.String formDefId,
                            java.lang.String boId,
                            java.lang.String lang)

返回表单页面URL，包含按钮工具条

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl

sid - SessionId，必须传入

processInstId - 流程实例ID

taskInstId - 任务实例ID，可为空

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。可为空，默认读取任务实例状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

formDefId - 表单定义ID，该参数用于多表单时，不指定使用默认表单，可为空

boId - BO表记录ID，可为空

lang - 需要表单显示的语言，不指定使用系统默认语言，可为空

返回:

返回表单页面URL，包含按钮工具条

从以下版本开始:

6.2.7.0426

另请参阅:

UserTaskRuntimeConst, PlatformAPI.getPortalUrl()

getFormURL

java.lang.String getFormURL(java.lang.String bpmPortalHost,
                            java.lang.String sid,
                            java.lang.String processInstId,
                            java.lang.String taskInstId,
                            int openState,
                            java.lang.String formDefId,
                            java.lang.String boId,
                            java.lang.String lang)

返回表单页面URL，包含按钮工具条

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl

sid - SessionId，必须传入

processInstId - 流程实例ID

taskInstId - 任务实例ID，可为空

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

formDefId - 表单定义ID，该参数用于多表单时，不指定使用默认表单，可为空

boId - BO表记录ID，可为空

lang - 需要表单显示的语言，不指定使用系统默认语言，可为空

返回:

返回表单页面URL，包含按钮工具条

另请参阅:

UserTaskRuntimeConst, PlatformAPI.getPortalUrl()

getFormURL

java.lang.String getFormURL(java.lang.String bpmPortalHost,
                            java.lang.String sid,
                            java.lang.String processInstId,
                            java.lang.String taskInstId,
                            java.lang.Integer openState,
                            java.lang.String formDefId,
                            java.lang.String boId,
                            java.lang.String lang,
                            boolean displayToolbar)

返回表单页面URL

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl

sid - SessionId

processInstId - 流程实例ID

taskInstId - 任务实例ID，可为空

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。可为空，默认读取任务实例状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

formDefId - 表单定义ID，该参数用于多表单时，不指定使用默认表单，可为空

boId - BO表记录ID，可为空

lang - 需要表单显示的语言，不指定使用系统默认语言，可为空

displayToolbar - 是否展示按钮工具条

返回:

返回表单页面URL

从以下版本开始:

6.2.7.0426

另请参阅:

UserTaskRuntimeConst, PlatformAPI.getPortalUrl()

getFormURL

java.lang.String getFormURL(java.lang.String bpmPortalHost,
                            java.lang.String sid,
                            java.lang.String processInstId,
                            java.lang.String taskInstId,
                            int openState,
                            java.lang.String formDefId,
                            java.lang.String boId,
                            java.lang.String lang,
                            boolean displayToolbar)

返回表单页面URL

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl

sid - SessionId

processInstId - 流程实例ID

taskInstId - 任务实例ID，可为空

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态。如果使用TaskQueryAPI查询的数据，可直接传入TaskInstance对象的getState方法的返回值。参考UserTaskRuntimeConst中STATE为起始命名的常量

formDefId - 表单定义ID，该参数用于多表单时，不指定使用默认表单，可为空

boId - BO表记录ID，可为空

lang - 需要表单显示的语言，不指定使用系统默认语言，可为空

displayToolbar - 是否展示按钮工具条

返回:

返回表单页面URL

另请参阅:

UserTaskRuntimeConst, PlatformAPI.getPortalUrl()

getFormTokenUrl

java.lang.String getFormTokenUrl(java.lang.String taskInstId)

获取任务的无会话请求的表单URL，其中包含TokenID，Token有效期默认3天

6.2.8以前的版本可以调用com.actionsoft.sdk.local.api.PortalAPI#getTaskInstTokenUrl(java.lang.String)方法

参数:

taskInstId - 任务实例ID

返回:

返回表单无会话且包含有效期的URL

从以下版本开始:

6.2.9

getFormMainPage

java.lang.String getFormMainPage(UserContext userContext,
                                 java.lang.String processInstId,
                                 java.lang.String taskInstId)

已过时。 被getFormPage方法替代，后期会删除，请注意重构

返回完整的带有工具栏的表单

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

taskInstId - 任务实例ID

返回:

完整的HTML页面，可用于CMD中

getFormMainPage

java.lang.String getFormMainPage(UserContext userContext,
                                 ProcessInstance processInst,
                                 TaskInstance taskInst)

已过时。 被getFormPage方法替代，后期会删除，请注意重构

返回完整的带有工具栏的表单

参数:

userContext - 用户上下文对象

processInst - 流程实例

taskInst - 任务实例

返回:

完整的HTML页面，可用于CMD中

getFormMainPage

java.lang.String getFormMainPage(UserContext userContext,
                                 java.lang.String processInstId,
                                 java.lang.String taskInstId,
                                 int openState)

已过时。 被getFormPage方法替代，后期会删除，请注意重构

返回指定表单状态的完整的带有工具栏的表单

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

taskInstId - 任务实例

openState - 表单打开状态，参考UserTaskRuntimeConst

返回:

完整的HTML页面，可用于CMD中

另请参阅:

UserTaskRuntimeConst

getFormMainPage

@Deprecated
java.lang.String getFormMainPage(UserContext userContext,
                                              ProcessInstance processInst,
                                              TaskInstance taskInst,
                                              int openState)

已过时。 被getFormPage方法替代，后期会删除，请注意重构

返回指定表单状态的完整的带有工具栏的表单

参数:

userContext - 用户上下文对象

processInst - 流程实例

taskInst - 任务实例

openState - 表单打开状态，参考UserTaskRuntimeConst

返回:

完整的HTML页面，可用于CMD中

另请参阅:

UserTaskRuntimeConst

getFormMainURL

@Deprecated
java.lang.String getFormMainURL(java.lang.String bpmPortalHost,
                                             java.lang.String sid,
                                             java.lang.String processInstId,
                                             java.lang.String taskInstId,
                                             java.lang.String formDefId,
                                             int openState)

已过时。 被getFormURL方法替代，后期会删除，请注意重构

返回带有工具栏的表单URL

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl

sid - SessionId

processInstId - 流程实例ID

taskInstId - 任务实例ID

formDefId - 表单定义ID，如果为空，则使用默认的表单

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态，参考UserTaskRuntimeConst中STATE为起始命名的常量

返回:

返回带有工具栏的表单URL

另请参阅:

UserTaskRuntimeConst, PlatformAPI.getPortalUrl()

getFormMainURL

@Deprecated
java.lang.String getFormMainURL(java.lang.String bpmPortalHost,
                                             java.lang.String sid,
                                             java.lang.String processInstId,
                                             java.lang.String taskInstId,
                                             java.lang.String formDefId,
                                             int openState,
                                             boolean displayToolbar)

已过时。 被getFormURL方法替代，后期会删除，请注意重构

返回表单URL

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl

sid - SessionId

processInstId - 流程实例ID

taskInstId - 任务实例ID

formDefId - 表单定义ID，如果为空，则使用默认的表单

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态，参考UserTaskRuntimeConst中STATE为起始命名的常量

displayToolbar - 是否展示按钮工具条

返回:

返回表单URL

另请参阅:

UserTaskRuntimeConst, PlatformAPI.getPortalUrl()

getFormTrackURL

java.lang.String getFormTrackURL(java.lang.String bpmPortalHost,
                                 java.lang.String sid,
                                 java.lang.String processInstId)

获取流程跟踪URL，平台默认调用流程设计图样式的跟踪图，该模式要求IE10及以上浏览器支持，除非流程实施时候修改了设置

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl

sid - SessionId

processInstId - 流程实例ID

返回:

一个流程跟踪页面的URL

另请参阅:

PlatformAPI.getPortalUrl()

getFormTrackURL

java.lang.String getFormTrackURL(java.lang.String bpmPortalHost,
                                 java.lang.String sid,
                                 java.lang.String processInstId,
                                 boolean supportCanvas,
                                 java.lang.String formInfo)

获取流程跟踪URL

参数:

bpmPortalHost - AWS Web服务URL地址，见PlatformAPI.getPortalUrl

sid - 用户会话ID

processInstId - 流程实例ID

supportCanvas - 平台默认调用流程设计图样式的跟踪图，该模式要求IE10及以上浏览器支持，如果开发者知道应用场景不支持，可将该参数传入false

formInfo - 平台默认提供的流程跟踪场景可返回该实例的表单，如果开发者需要该功能，需要传入表单信息以便在跟踪图中提供返回表单按钮，一个JSON数据，格式：{"taskInstId":"","openState":""}

返回:

一个流程跟踪页面的URL

另请参阅:

PlatformAPI.getPortalUrl()

getFormHistoryOpinionJSON

java.lang.String getFormHistoryOpinionJSON(UserContext userContext,
                                           java.lang.String processInstId)

获取流程实例审批的记录的JSON结构

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

返回:

返回流程实例审批的记录的JSON结构

getFormHistoryOpinionHTML

java.lang.String getFormHistoryOpinionHTML(UserContext userContext,
                                           java.lang.String processInstId)

获取流程实例审批的记录的平台默认提供的HTML片段

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

返回:

返回流程实例审批的记录的平台默认提供的HTML片段

getFormSysButtonsJSON

java.lang.String getFormSysButtonsJSON(UserContext userContext,
                                       java.lang.String processInstId,
                                       java.lang.String taskInstId,
                                       java.lang.String userTaskDefId,
                                       int openState)

获取表单系统提供的按钮JSON结构

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

taskInstId - 任务实例ID

userTaskDefId - 节点定义ID，可为空，如果为空，将根据任务实例查找

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态，参考UserTaskRuntimeConst中STATE为起始命名的常量

返回:

返回表单系统提供的按钮JSON结构

另请参阅:

UserTaskRuntimeConst

getFormSysButtonsJSON

java.lang.String getFormSysButtonsJSON(UserContext userContext,
                                       ProcessInstance processInst,
                                       TaskInstance taskInst,
                                       java.lang.String userTaskDefId,
                                       int openState)

获取表单系统提供的按钮JSON结构

参数:

userContext - 用户上下文对象

processInst - 流程实例对象

taskInst - 任务实例对象

userTaskDefId - 节点定义ID，可为空，如果为空，将根据任务实例查找

openState - 表单打开状态，通过该参数，可控制表单的编辑或者只读状态，参考UserTaskRuntimeConst中STATE为起始命名的常量

返回:

返回表单系统提供的按钮JSON结构

另请参阅:

UserTaskRuntimeConst

getFormExtendsButtonsJSON

java.lang.String getFormExtendsButtonsJSON(UserContext userContext,
                                           java.lang.String processInstId,
                                           java.lang.String taskInstId,
                                           java.lang.String userTaskDefId)

获取节点配置的扩展按钮JSON结构

参数:

userContext - 用户上下文对象

processInstId - 流程实例ID

taskInstId - 任务实例ID

userTaskDefId - 节点定义ID，可为空，如果为空，将根据任务实例查找

返回:

返回节点配置的扩展按钮JSON结构

getFormExtendsButtonsJSON

java.lang.String getFormExtendsButtonsJSON(UserContext userContext,
                                           ProcessInstance processInst,
                                           TaskInstance taskInst,
                                           java.lang.String userTaskDefId)

获取节点配置的扩展按钮JSON结构

参数:

userContext - 用户上下文对象

processInst - 流程实例对象

taskInst - 任务实例对象

userTaskDefId - 节点定义ID，可为空，如果为空，将根据任务实例查找

返回:

返回节点配置的扩展按钮JSON结构

getLastSnapshotPDFFile

java.io.File getLastSnapshotPDFFile(java.lang.String processInstId,
                                    java.lang.String processDefId,
                                    java.lang.String userTaskDefId)

返回最新的一个表单快照的PDF文件

参数:

processInstId - 流程实例ID

processDefId - 流程定义ID

userTaskDefId - 节点定义ID

返回:

如果存在PDF文件，则返回空