API
Component

Wfmui ($UI/comp/wfmui/components/wfmui/wfmui)

使用范围：UI2

Contents

component Wfmui ($UI/comp/wfmui/components/wfmui/wfmui) extends Component

流程界面组件

<b>使用场景</b>：开启流程。 <b>使用方法</b>：需先部署企业流程服务，并绑定一个数据集使用。

Constructor Top

  Wfmui ()
  Wfmui ( config)

Properties Top

Boolean autoClose = true

执行完流程相关操作(流转，回退，转发，中止，暂停，终止)后，是否自动关闭当前页面。
Boolean autoFilter = true

是否自动为数据集添加相关的过虑条件(数据集的的rowid为sData1)。
Boolean autoSave = true

执行流程相关操作(流转查询，回退查询，转发查询，中止查询，暂停查询，终止查询)之前，是否自动保存业务数据。
Boolean autoStart = true

是否在数据集插入数据保存之后自动启动流程，启动流程时，默认sData1的值是数据集的当前行的rowid。
String data

关联的数据集

Attributes Top

Boolean autoClose = true

执行完流程相关操作(流转，回退，转发，中止，暂停，终止)后，是否自动关闭当前页面。
Boolean autoFilter = true

是否自动为数据集添加相关的过虑条件(数据集的的rowid为sData1)。
Boolean autoSave = true

执行流程相关操作(流转查询，回退查询，转发查询，中止查询，暂停查询，终止查询)之前，是否自动保存业务数据。
Boolean autoStart = true

是否在数据集插入数据保存之后自动启动流程，启动流程时，默认sData1的值是数据集的当前行的rowid。
String component = "$UI/comp/wfmui/components/wfmui/wfmui"

组件标识
String data

关联的数据集
String xid

xid标识

Methods Top

Promise abort (String task, Object processControl, String vars)
Promise abortQuery (String task, String vars)
Promise addSignUser (String task, Object processControl, String vars)
Promise addSignUserQuery (String task, String vars)
Promise advance (String task, Object processControl, String vars)
Promise advanceQuery (String task, String vars)
Promise back (String task, Object processControl, String vars)
Promise backQuery (String task, String vars)
void batchAdvanceQuery (String task, String vars)
String getBusinessKey ()
String getBusinessLabel ()
Object getVar (String name)
void remindTask (String task)
Promise resume (String task, String vars)
void, void | void showChart (String task, String process, String data)
void showRecord (String task, String process, String sData)
Promise special (String task, Object processControl, String vars)
Promise specialQuery (String task, String vars)
Promise start ( process, name, data, formUrl, options)
Promise startByTemplate ( process, name, data, templateID, formUrl, options)
Promise startExt ( process, relations, options)
Promise suspend (String task, Object processControl, String vars)
Promise suspendQuery (String task, String vars)
Promise transfer (String task, Object processControl, String vars)
Promise transferQuery (String task, String vars)
Promise withdrawTask (String task, String vars)

Operations Top

Promise abort (String task)
Promise addSignUser (String task)
Promise advance (String task)
Promise back (String task)
Promise backRoot (String task)
Promise batchAdvance (String task)
Promise customized (String task)
void modifyExecutor (String task, String fid)
void remindTask (String task)
Promise resume (String task)
void showChart (String task, String process, String data)
void showRecord (String task, String process, String data)
Promise special (String task)
Promise suspend (String task)
Promise transfer (String task)
Promise withdrawTask (String task)

Events Top

void abortBefore (AbortBeforeEvent event)
void abortError (AbortErrorEvent event)
void abortQueryBefore (AbortQueryBeforeEvent event)
void abortQueryError (AbortQueryErrorEvent event)
void abortQuerySuccess (AbortQuerySuccessEvent event)
void abortSuccess (AbortSuccessEvent event)
void advanceBefore (AdvanceBeforeEvent event)
void advanceError (AdvanceErrorEvent event)
void advanceQueryBefore (AdvanceQueryBeforeEvent event)
void advanceQueryError (AdvanceQueryErrorEvent event)
void advanceQuerySuccess (AdvanceQuerySuccessEvent event)
void advanceSuccess (AdvanceSuccessEvent event)
void afterTransfer (AfterTransferEvent event)
void afterTransferQuery (AfterTransferQueryEvent event)
void backBefore (BackBeforeEvent event)
void backError (BackErrorEvent event)
void backQueryBefore (BackQueryBeforeEvent event)
void backQueryError (BackQueryErrorEvent event)
void backQuerySuccess (BackQuerySuccessEvent event)
void backSuccess (BackSuccessEvent event)
void beforeTransfer (BeforeTransferEvent event)
void beforeTransferQuery (BeforeTransferQueryEvent event)
void openDialogBefore (OpenDialogBeforeEvent event)
void startBefore (StartBeforeEvent event)
void startError (StartErrorEvent event)
void startSuccess (StartSuccessEvent event)
void suspendBefore (SuspendBeforeEvent event)
void suspendError (SuspendErrorEvent event)
void suspendQueryBefore (SuspendQueryBeforeEvent event)
void suspendQueryError (SuspendQueryErrorEvent event)
void suspendQuerySuccess (SuspendQuerySuccessEvent event)
void suspendSuccess (SuspendSuccessEvent event)
void transferCommit (TransferCommitEvent event)
void transferError (TransferErrorEvent event)
void transferQueryError (TransferQueryErrorEvent event)

Constructor details Top

public Wfmui ()

流程界面组件

<b>使用场景</b>：开启流程。 <b>使用方法</b>：需先部署企业流程服务，并绑定一个数据集使用。

public Wfmui ( config)

构造函数

Inherited from Operational

Parameters

config

操作配置

Properties Detail Top

public Boolean autoClose = true

执行完流程相关操作(流转，回退，转发，中止，暂停，终止)后，是否自动关闭当前页面。

public Boolean autoFilter = true

是否自动为数据集添加相关的过虑条件(数据集的的rowid为sData1)。

public Boolean autoSave = true

执行流程相关操作(流转查询，回退查询，转发查询，中止查询，暂停查询，终止查询)之前，是否自动保存业务数据。

public Boolean autoStart = true

是否在数据集插入数据保存之后自动启动流程，启动流程时，默认sData1的值是数据集的当前行的rowid。

public String data

关联的数据集

Attributes Detail Top

public Boolean autoClose = true

执行完流程相关操作(流转，回退，转发，中止，暂停，终止)后，是否自动关闭当前页面。

public Boolean autoFilter = true

是否自动为数据集添加相关的过虑条件(数据集的的rowid为sData1)。

public Boolean autoSave = true

执行流程相关操作(流转查询，回退查询，转发查询，中止查询，暂停查询，终止查询)之前，是否自动保存业务数据。

public Boolean autoStart = true

是否在数据集插入数据保存之后自动启动流程，启动流程时，默认sData1的值是数据集的当前行的rowid。

public String component = "$UI/comp/wfmui/components/wfmui/wfmui"

组件标识

public String data

关联的数据集

public String xid

xid标识

Methods Detail Top

public Promise abort (String task, Object processControl, String vars)

终止

Parameters

String task

任务标识, 为空时使用默认任务
Object processControl

终止信息
String vars

变量

Return Value

Promise

public Promise abortQuery (String task, String vars)

终止查询

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

Promise

public Promise addSignUser (String task, Object processControl, String vars)

加签

Parameters

String task

任务标识, 为空时使用默认任务
Object processControl

回退信息
String vars

变量

Return Value

Promise

public Promise addSignUserQuery (String task, String vars)

加签查询(扩展)

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

Promise

public Promise advance (String task, Object processControl, String vars)

流转

Parameters

String task

任务标识, 为空时使用默认任务
Object processControl

流转信息
String vars

变量

Return Value

Promise

public Promise advanceQuery (String task, String vars)

流转查询

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

Promise

public Promise back (String task, Object processControl, String vars)

回退

Parameters

String task

任务标识, 为空时使用默认任务
Object processControl

回退信息
String vars

变量

Return Value

Promise

public Promise backQuery (String task, String vars)

回退查询(扩展)

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

Promise

public void batchAdvanceQuery (String task, String vars)

批量流转

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

void

public String getBusinessKey ()

获取流程上下文中的业务主键

Return Value

String

public String getBusinessLabel ()

获取流程上下文中的业务主键名称

Return Value

String

public Object getVar (String name)

获取变量

Parameters

String name

变量名

Return Value

Object

public void remindTask (String task)

催办任务

Parameters

String task

任务标识

Return Value

void

public Promise resume (String task, String vars)

唤醒流程

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

Promise

public void, void | void showChart (String task, String process, String data)

显示流程图

 如果process, sData, task(只需要给process, sData或者只给task)没有指定时, 默认使用当前上下文中的task和process

Parameters

String task

任务标识(可选参数)
String process

业务流程(可选参数)
String data

业务数据标识(可选参数)

Return Value

void
void

public void showRecord (String task, String process, String sData)

显示流程记录对话框

Parameters

String task

任务
String process

业务流程(可选参数)
String sData

业务数据标识(可选参数)

Return Value

void

public Promise special (String task, Object processControl, String vars)

特送

Parameters

String task

任务标识, 为空时使用默认任务
Object processControl

特送信息
String vars

变量

Return Value

Promise

public Promise specialQuery (String task, String vars)

特送查询

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

Promise

public Promise start ( process, name, data, formUrl, options)

启动流程

Parameters

process

流程标识
name

流程实例名称
data

流程关联的业务数据
formUrl

表单地址
options

可选参数

是一个json格式, 有以下三个参数firstActivityExecutor, firstActivityExecutor: 表示首环节的执行者，可以不指定, 这时默认就是当前人员成员; vars: 变量 格式如下： { "firstActivityExecutor": {String}, "vars": {var1: ""} }

Return Value

Promise

public Promise startByTemplate ( process, name, data, templateID, formUrl, options)

根据模板启动流程

Parameters

process

流程标识
name

流程实例名称
data

流程关联的业务数据
templateID

流程模板标识
formUrl

表单地址
options

可选参数

是一个json格式, 有以下三个参数firstActivityExecutor firstActivityExecutor: 表示首环节的执行者，可以不指定, 这时默认就是当前人员成员; vars: 变量 格式如下： { "firstActivityExecutor": {String} "vars": {var1: ""} }

Return Value

Promise

public Promise startExt ( process, relations, options)

启动流程(扩展)

Parameters

process

流程标识的全称
relations

流程实例属性值对，是一个数组，数组的下标是属性名，相应的是属性值
options

可选参数

是一个json格式, 有以下参数firstActivityExecutor, firstActivityExecutor: 表示首环节的执行者，可以不指定, 这时默认就是当前人员成员; formUrl: 表单地址 vars: 变量 格式如下： { firstActivityExecutor: {String} formUrl: {String}, vars: {var1: ""} }

Return Value

Promise

public Promise suspend (String task, Object processControl, String vars)

暂停

Parameters

String task

任务标识, 为空时使用默认任务
Object processControl

暂停信息
String vars

变量

Return Value

Promise

public Promise suspendQuery (String task, String vars)

暂停查询(扩展)

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

Promise

public Promise transfer (String task, Object processControl, String vars)

转发

Parameters

String task

任务标识, 为空时使用默认任务
Object processControl

转发信息
String vars

变量

Return Value

Promise

public Promise transferQuery (String task, String vars)

转发查询

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

Promise

public Promise withdrawTask (String task, String vars)

回收任务

Parameters

String task

任务标识, 为空时使用默认任务
String vars

变量

Return Value

Promise

Operations Detail Top

public Promise abort (String task)

终止

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public Promise addSignUser (String task)

加签

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public Promise advance (String task)

流转

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public Promise back (String task)

回退

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public Promise backRoot (String task)

回退到首环节

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public Promise batchAdvance (String task)

批量流转

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public Promise customized (String task)

定制流程

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public void modifyExecutor (String task, String fid)

修改执行者

Parameters

String task

任务标识, 为空时使用默认任务
String fid

执行者

Return Value

void

public void remindTask (String task)

催办任务

Parameters

String task

任务标识

Return Value

void

public Promise resume (String task)

唤醒流程

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public void showChart (String task, String process, String data)

显示流程图

Parameters

String task

任务标识, 为空时使用默认任务
String process

流程标识
String data

业务数据

Return Value

void

public void showRecord (String task, String process, String data)

显示流程记录

Parameters

String task

任务标识, 为空时使用默认任务
String process

流程标识
String data

业务数据

Return Value

void

public Promise special (String task)

特送

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public Promise suspend (String task)

暂停

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public Promise transfer (String task)

转发

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

public Promise withdrawTask (String task)

任务回收

Parameters

String task

任务标识, 为空时使用默认任务

Return Value

Promise

Events Detail Top

public void abortBefore (AbortBeforeEvent event)

[回调型事件]终止之前

Parameters

AbortBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":终止信息, "vars": 变量, "cancel":false }

Return Value

void

public void abortError (AbortErrorEvent event)

[回调型事件]终止失败

Parameters

AbortErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":终止信息, "vars": 变量, "cancel":false, "error": 异常对象 }

Return Value

void

public void abortQueryBefore (AbortQueryBeforeEvent event)

[回调型事件]终止查询之前

Parameters

AbortQueryBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false }

Return Value

void

public void abortQueryError (AbortQueryErrorEvent event)

[回调型事件]终止查询失败

Parameters

AbortQueryErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false, "error": 异常对象 }

Return Value

void

public void abortQuerySuccess (AbortQuerySuccessEvent event)

[回调型事件]终止查询成功

Parameters

AbortQuerySuccessEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":终止信息, "vars": 变量, "cancel":false }

Return Value

void

public void abortSuccess (AbortSuccessEvent event)

[回调型事件]终止成功

Parameters

AbortSuccessEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":终止信息, "vars": 变量, "cancel":false }

Return Value

void

public void advanceBefore (AdvanceBeforeEvent event)

[回调型事件]流转之前

Parameters

AdvanceBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":流转信息, "vars": 变量, "cancel":false }

Return Value

void

public void advanceError (AdvanceErrorEvent event)

[回调型事件]流转失败

Parameters

AdvanceErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":流转信息, "vars": 变量, "cancel":false, "error": 异常对象 }

Return Value

void

public void advanceQueryBefore (AdvanceQueryBeforeEvent event)

[回调型事件]流转查询之前

Parameters

AdvanceQueryBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false }

Return Value

void

public void advanceQueryError (AdvanceQueryErrorEvent event)

[回调型事件]流转查询失败

Parameters

AdvanceQueryErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false, "error": 异常对象 }

Return Value

void

public void advanceQuerySuccess (AdvanceQuerySuccessEvent event)

[回调型事件]流转查询成功

Parameters

AdvanceQuerySuccessEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":流转信息, "vars": 变量, "cancel":false }

Return Value

void

public void advanceSuccess (AdvanceSuccessEvent event)

[回调型事件]流转成功

Parameters

AdvanceSuccessEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":流转信息, "vars": 变量, "cancel":false }

Return Value

void

public void afterTransfer (AfterTransferEvent event)

[回调型事件]转发成功

Parameters

AfterTransferEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":转发信息, "vars": 变量, "cancel":false }

Return Value

void

public void afterTransferQuery (AfterTransferQueryEvent event)

[回调型事件]转发查询成功

Parameters

AfterTransferQueryEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":转发信息, "vars": 变量, "cancel":false }

Return Value

void

public void backBefore (BackBeforeEvent event)

[回调型事件]回退之前

Parameters

BackBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":回退信息, "vars": 变量, "cancel":false }

Return Value

void

public void backError (BackErrorEvent event)

[回调型事件]回退失败

Parameters

BackErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":回退信息, "vars": 变量, "cancel":false, "error": 异常对象 }

Return Value

void

public void backQueryBefore (BackQueryBeforeEvent event)

[回调型事件]回退查询之前

Parameters

BackQueryBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false }

Return Value

void

public void backQueryError (BackQueryErrorEvent event)

[回调型事件]回退查询失败

Parameters

BackQueryErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false, "error": 异常对象 }

Return Value

void

public void backQuerySuccess (BackQuerySuccessEvent event)

[回调型事件]回退查询成功

Parameters

BackQuerySuccessEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":回退信息, "vars": 变量, "cancel":false }

Return Value

void

public void backSuccess (BackSuccessEvent event)

[回调型事件]回退成功

Parameters

BackSuccessEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":回退信息, "vars": 变量, "cancel":false }

Return Value

void

public void beforeTransfer (BeforeTransferEvent event)

[回调型事件]转发之前

Parameters

BeforeTransferEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":转发信息, "vars": 变量, "cancel":false }

Return Value

void

public void beforeTransferQuery (BeforeTransferQueryEvent event)

[回调型事件]转发查询之前

Parameters

BeforeTransferQueryEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false }

Return Value

void

public void openDialogBefore (OpenDialogBeforeEvent event)

[回调型事件]打开流程对话框之前

Parameters

OpenDialogBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "action":当前执行的操作, "task":当前任务ID, "processControl":ProcessControl, "cancel":false }

Return Value

void

public void startBefore (StartBeforeEvent event)

启动流程之前

Parameters

StartBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "process":流程, "relations":{ "关系名称":"关系值" }, "vars": 变量, "executor":首环节的执行者, "cancel":false }

Return Value

void

public void startError (StartErrorEvent event)

[回调型事件]启动流程失败

Parameters

StartErrorEvent event

它的结构如下:

{ "source":组件的js对象, "process":流程, "relations":{ 关系名称:关系值 }, "executor":首环节的执行者, "vars": 变量, "cancel":false, "error": 异常对象 }

Return Value

void

public void startSuccess (StartSuccessEvent event)

[回调型事件]启动流程成功

Parameters

StartSuccessEvent event

它的结构如下:

{ "source":组件的js对象, "process":流程, "relations":{ 关系名称:关系值 }, "executor":首环节的执行者, "vars": 变量, "cancel":false, "task":活动环节对应的任务标识 }

Return Value

void

public void suspendBefore (SuspendBeforeEvent event)

[回调型事件]暂停之前

Parameters

SuspendBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":暂停信息, "vars": 变量, "cancel":false }

Return Value

void

public void suspendError (SuspendErrorEvent event)

[回调型事件]暂停失败

Parameters

SuspendErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":暂停信息, "vars": 变量, "cancel":false, "error": 异常对象 }

Return Value

void

public void suspendQueryBefore (SuspendQueryBeforeEvent event)

[回调型事件]暂停查询之前

Parameters

SuspendQueryBeforeEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false }

Return Value

void

public void suspendQueryError (SuspendQueryErrorEvent event)

[回调型事件]暂停查询失败

Parameters

SuspendQueryErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false, "errorType": "client"或"server", "error": js异常对象, "errorNode": 服务端错误信息 }

Return Value

void

public void suspendQuerySuccess (SuspendQuerySuccessEvent event)

[回调型事件]暂停查询成功

Parameters

SuspendQuerySuccessEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":暂停信息, "vars": 变量 "cancel":false }

Return Value

void

public void suspendSuccess (SuspendSuccessEvent event)

[回调型事件]暂停成功

Parameters

SuspendSuccessEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":暂停信息, "vars": 变量, "cancel":false }

Return Value

void

public void transferCommit (TransferCommitEvent event)

[回调型事件]转发成功

Parameters

TransferCommitEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":转发信息, "vars": 变量, "cancel":false }

Return Value

void

public void transferError (TransferErrorEvent event)

[回调型事件]转发失败

Parameters

TransferErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "processControl":转发信息, "vars": 变量, "cancel":false, "errorType": "client"或"server", "error": js异常对象, "errorNode": 服务端错误信息 }

Return Value

void

public void transferQueryError (TransferQueryErrorEvent event)

[回调型事件]转发查询失败

Parameters

TransferQueryErrorEvent event

它的结构如下:

{ "source":组件的js对象, "task":任务标识, "vars": 变量, "cancel":false, "error": 异常对象 }

Return Value

void