API
Component

Process ($UI/system/components/justep/process/process)

使用范围:UI2

Contents

component Process ($UI/system/components/justep/process/process) extends ViewComponent

<b>使用场景</b>:页面需要流程介入时; <b>使用方法</b>:添加process组件,指定流程操作的data;

	流程组件主要包括以下内容:
	1. 流程的一些配置选项
	dialogWindow:流程对话框页面;
	data:流程关联的数据组件;
	autoClose:是否自动关闭功能页面;
	autoStart:是否自动启动流程;
	autoSave:是否自动保存业务数据;
	autoFilter:是否自动过虑业务数据;
	
	2. 流程动作的js api
	启动流程、终止查询、终止、流转查询、流转、回退、回退查询、暂停查询、暂停、转发查询、转发、定制查询、定制和回收任务都
可以调用流程组件上的相应api来实现。
	例如:

	var p = this.comp("process1"); //process1是流程组件的id
	p.advanceQuery(); //流转查询
	

	3. 流程动作的js事件
	对于查询类的流程动作,流程组件公布了三个事件:执行前事件、执行后事件和执行失败事件,查询类的流程动作不启动事务;
	对于非查询类的流程动作,流程组件公布了四个事件:执行前事件、执行后事件、动作提交事件和执行失败事件,其中,执行前事件和执行后
事件与流程动作处于同一个事务中,动作提交事件和执行失败事件在事务之后。
	
	案例:
	1. 在界面中,流转之前检查业务数据是否符合业务要求(比如金额必须大于100),否则弹出提示

	Model.prototype.flwBeforeAdvanceQuery = function(event){
		var data = this.comp("mainData"); //mainData是业务数据关联的bizData的id
		var fAmount = data.getValue("fAmount"); //fAmount是金额字段
		if (fAmout < 100){
			event.cancel = true; //取消后续的流程动作
			alert("订单的金额必须大小100");
		}
	};
	

See 流程动作

Constructor Top

  Process ()
  Process ( options)

Properties Top

Boolean autoClose = true

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

Boolean autoFilter = true

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

Boolean autoSave = true

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

Boolean autoStart = true

是否在save(即insert)之后自动启动流程,启动流程时,默认sData1的值是data的rowid。

String data

关联的data

String dialog

流程对话框页面

String dialogHeight

流程对话框高度

String dialogWidth

流程对话框宽度

Attributes Top

Boolean autoClose = true

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

Boolean autoFilter = true

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

Boolean autoSave = true

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

Boolean autoStart = true

是否在save(即insert)之后自动启动流程,启动流程时,默认sData1的值是data的rowid。

String component = "$UI/system/components/justep/process/process"

组件标识

String data

关联的data

String dialog

流程对话框页面

String dialogHeight

流程对话框高度

String dialogWidth

流程对话框宽度

String xid

xid标识

Methods Top

boolean abort ( options)
boolean abortExt (String task, ProcessControl processControl, options)
boolean abortQuery ( options)
boolean abortQueryExt (String task, options)
boolean advance ( options)
boolean advanceExt (String task, ProcessControl processControl, options)
boolean advanceQuery ( options)
boolean advanceQueryExt (String task, options)
boolean back ( options)
boolean backExt (String task, ProcessControl processControl, options)
boolean backQuery ( options)
boolean backQueryExt (String task, options)
Boolean canModifyExecutor ()
Boolean canModifyExecutorExt (String task)
Object get (String name)
boolean isAutoClose ()
boolean isAutoFilter ()
boolean isAutoSave ()
boolean isAutoStart ()
void modifyExecutor ()
void modifyExecutorExt (String task, check)
void openProcessRecordDialog (String task, String process, String sData)
void processRecord (String task, String process, String sData)
void set (json arg)
void setAutoClose ( v)
void setAutoFilter ( v)
void setAutoSave ( v)
void setAutoStart ( v)
void showChart (String process, String sData, String task)
boolean special ( options)
boolean specialExt (String task, ProcessControl processControl, options)
boolean specialQuery ( options)
boolean specialQueryExt (String task, options)
boolean start ( process, name, data, options)
boolean startByTemplate ( process, templateID, name, data, options)
boolean startCustomizedQuery ( options)
boolean startExt ( process, relations, options)
boolean suspend ( options)
boolean suspendExt (String task, ProcessControl processControl, options)
boolean suspendQuery ( options)
boolean suspendQueryExt (String task, options)
boolean transfer ( options)
boolean transferExt (String task, ProcessControl processControl, options)
boolean transferQuery ( options)
boolean transferQueryExt (String task, options)
void withdrawTask ()
void withdrawTaskExt (String task)

Operations Top

void abort (String task, Function onSuccess)
void advance (String task, Function onSuccess)
void back (String task, Function onSuccess)
void modifyExecutor (String task, Function onSuccess)
void processRecord (String process, String data, String task)
void showChart (String process, String data, String task)
void special (String task, Function onSuccess)
void suspend (String task, Function onSuccess)
void transfer (String task, Function onSuccess)
void withdrawTask (String task, Function onSuccess)

Events Top

void onAbortCommit (AbortCommitEvent event)
void onAbortError (AbortErrorEvent event)
void onAbortQueryError (AbortQueryErrorEvent event)
void onAdvanceCommit (AdvanceCommitEvent event)
void onAdvanceError (AdvanceErrorEvent event)
void onAdvanceQueryError (AdvanceQueryErrorEvent event)
void onAfterAbort (AfterAbortEvent event)
void onAfterAbortQuery (AfterAbortQueryEvent event)
void onAfterAdvance (AfterAdvanceEvent event)
void onAfterAdvanceQuery (AfterAdvanceQueryEvent event)
void onAfterBack (AfterBackEvent event)
void onAfterBackQuery (AfterBackQueryEvent event)
void onAfterStart (AfterStartEvent event)
void onAfterStartCustomizedQuery (AfterStartCustomizedQueryEvent event)
void onAfterSuspend (AfterSuspendEvent event)
void onAfterSuspendQuery (AfterSuspendQueryEvent event)
void onAfterTransfer (AfterTransferEvent event)
void onAfterTransferQuery (AfterTransferQueryEvent event)
void onBackCommit (BackCommitEvent event)
void onBackError (BackErrorEvent event)
void onBackQueryError (BackQueryErrorEvent event)
void onBeforeAbort (BeforeAbortEvent event)
void onBeforeAbortQuery (BeforeAbortQueryEvent event)
void onBeforeAdvance (BeforeAdvanceEvent event)
void onBeforeAdvanceQuery (BeforeAdvanceQueryEvent event)
void onBeforeBack (BeforeBackEvent event)
void onBeforeBackQuery (BeforeBackQueryEvent event)
void onBeforeOpenDialog (BeforeOpenDialogEvent event)
void onBeforeStart (BeforeStartEvent event)
void onBeforeStartCustomizedQuery (BeforeStartCustomizedQueryEvent event)
void onBeforeSuspend (BeforeSuspendEvent event)
void onBeforeSuspendQuery (BeforeSuspendQueryEvent event)
void onBeforeTransfer (BeforeTransferEvent event)
void onBeforeTransferQuery (BeforeTransferQueryEvent event)
void onCloseDialog (CloseDialogEvent event)
void onStartCommit (StartCommitEvent event)
void onStartCustomizedQueryError (StartCustomizedQueryErrorEvent event)
void onStartError (StartErrorEvent event)
void onSuspendCommit (SuspendCommitEvent event)
void onSuspendError (SuspendErrorEvent event)
void onSuspendQueryError (SuspendQueryErrorEvent event)
void onTransferCommit (TransferCommitEvent event)
void onTransferError (TransferErrorEvent event)
void onTransferQueryError (TransferQueryErrorEvent event)

Constructor details Top

public Process ()

<b>使用场景</b>:页面需要流程介入时; <b>使用方法</b>:添加process组件,指定流程操作的data;

	流程组件主要包括以下内容:
	1. 流程的一些配置选项
	dialogWindow:流程对话框页面;
	data:流程关联的数据组件;
	autoClose:是否自动关闭功能页面;
	autoStart:是否自动启动流程;
	autoSave:是否自动保存业务数据;
	autoFilter:是否自动过虑业务数据;
	
	2. 流程动作的js api
	启动流程、终止查询、终止、流转查询、流转、回退、回退查询、暂停查询、暂停、转发查询、转发、定制查询、定制和回收任务都
可以调用流程组件上的相应api来实现。
	例如:

	var p = this.comp("process1"); //process1是流程组件的id
	p.advanceQuery(); //流转查询
	

	3. 流程动作的js事件
	对于查询类的流程动作,流程组件公布了三个事件:执行前事件、执行后事件和执行失败事件,查询类的流程动作不启动事务;
	对于非查询类的流程动作,流程组件公布了四个事件:执行前事件、执行后事件、动作提交事件和执行失败事件,其中,执行前事件和执行后
事件与流程动作处于同一个事务中,动作提交事件和执行失败事件在事务之后。
	
	案例:
	1. 在界面中,流转之前检查业务数据是否符合业务要求(比如金额必须大于100),否则弹出提示

	Model.prototype.flwBeforeAdvanceQuery = function(event){
		var data = this.comp("mainData"); //mainData是业务数据关联的bizData的id
		var fAmount = data.getValue("fAmount"); //fAmount是金额字段
		if (fAmout < 100){
			event.cancel = true; //取消后续的流程动作
			alert("订单的金额必须大小100");
		}
	};
	

See 流程动作

public Process ( options)

构造函数

Inherited from ViewComponent

	
		参数options格式类似{parent:xx, config:{}},parent是组件的父节点,允许为空或不指定,config是组件的参数选项
	 

Parameters

options

参数选项

Properties Detail Top

public Boolean autoClose = true

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

public Boolean autoFilter = true

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

public Boolean autoSave = true

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

public Boolean autoStart = true

是否在save(即insert)之后自动启动流程,启动流程时,默认sData1的值是data的rowid。

public String data

关联的data

public String dialog

流程对话框页面

public String dialogHeight

流程对话框高度

public String dialogWidth

流程对话框宽度

Attributes Detail Top

public Boolean autoClose = true

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

public Boolean autoFilter = true

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

public Boolean autoSave = true

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

public Boolean autoStart = true

是否在save(即insert)之后自动启动流程,启动流程时,默认sData1的值是data的rowid。

public String component = "$UI/system/components/justep/process/process"

组件标识

public String data

关联的data

public String dialog

流程对话框页面

public String dialogHeight

流程对话框高度

public String dialogWidth

流程对话框宽度

public String xid

xid标识

Methods Detail Top

public boolean abort ( options)

终止

See 流程动作.externalAbortProcessAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示终止成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示终止失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean abortExt (String task, ProcessControl processControl, options)

终止(扩展)

See 流程动作.externalAbortProcessAction

Parameters

String task

[required]基于指定的任务执行abort

ProcessControl processControl

[required]流转信息

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示终止成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示终止失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean abortQuery ( options)

终止查询

See 流程动作.externalAbortProcessQueryAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示终止查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示终止查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean abortQueryExt (String task, options)

终止查询(扩展)

See 流程动作.externalAbortProcessQueryAction

Parameters

String task

[required]基于指定的任务执行abortQuery

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示终止查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示终止查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean advance ( options)

流转

See 流程动作.externalAdvanceProcessAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示流转成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示流转失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean advanceExt (String task, ProcessControl processControl, options)

流转(扩展)

See 流程动作.externalAdvanceProcessAction

Parameters

String task

[required]基于指定的任务执行advance

ProcessControl processControl

[required]流转信息

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示流转成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示流转失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean advanceQuery ( options)

流转查询

See 流程动作.externalAdvanceProcessQueryAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示流转查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示流转查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean advanceQueryExt (String task, options)

流转查询(扩展)

See 流程动作.externalAdvanceProcessQueryAction

Parameters

String task

[required]基于指定的任务执行advanceQuery

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示流转查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示流转查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean back ( options)

回退

See 流程动作.externalBackProcessAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示回退成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示回退失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean backExt (String task, ProcessControl processControl, options)

回退(扩展)

See 流程动作.externalBackProcessAction

Parameters

String task

[required]基于指定的任务执行back

ProcessControl processControl

[required]流转信息

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示回退成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示回退失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean backQuery ( options)

回退查询

See 流程动作.externalBackProcessQueryAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示回退查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示回退查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean backQueryExt (String task, options)

回退查询(扩展)

See 流程动作.externalBackProcessQueryAction

Parameters

String task

[required]基于指定的任务执行backQuery

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示回退查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示回退查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public Boolean canModifyExecutor ()

是否允许修改任务的执行者

Return Value

Boolean

public Boolean canModifyExecutorExt (String task)

是否允许修改任务的执行者

Parameters

String task

任务

Return Value

Boolean

public Object get (String name)

获取属性值

Parameters

String name

属性名称,取值范围:"data"、"autoClose"、"autoStart"、"autoFilter"、"autoSave"、"dialogWindow"、"task"

Return Value

Object

public boolean isAutoClose ()

是否自动关闭功能页面

Return Value

boolean

public boolean isAutoFilter ()

是否自动过虑业务数据

Return Value

boolean

public boolean isAutoSave ()

是否自动保存业务数据

Return Value

boolean

public boolean isAutoStart ()

是否自动启动流程

Return Value

boolean

public void modifyExecutor ()

修改任务的执行者

Return Value

void

public void modifyExecutorExt (String task, check)

修改任务的执行者

Parameters

String task

任务

check

是否需要检查任务是否是自己的

Return Value

void

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

显示流程记录对话框

Parameters

String task

任务

String process

业务流程(可选参数)

String sData

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

Return Value

void

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

显示流程记录对话框

Parameters

String task

任务

String process

业务流程(可选参数)

String sData

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

Return Value

void

public void set (json arg)

设置属性值

Parameters

json arg

属性值对
结构如下:

{ "autoClose": 是否自动关闭功能, "dialogWindow": 流程对话框页面, "task": 任务标识 }

Return Value

void

public void setAutoClose ( v)

设置是否自动关闭功能页面

Parameters

v

Return Value

void

public void setAutoFilter ( v)

设置是否自动过虑业务数据

Parameters

v

Return Value

void

public void setAutoSave ( v)

设置是否自动保存业务数据

Parameters

v

Return Value

void

public void setAutoStart ( v)

设置是否自动启动流程

Parameters

v

Return Value

void

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

显示流程图

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

Parameters

String process

业务流程(可选参数)

String sData

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

String task

任务标识(可选参数)

Return Value

void

public boolean special ( options)

特送

See 流程动作.externalSpecialProcessAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示特送成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示特送失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean specialExt (String task, ProcessControl processControl, options)

特送(扩展)

See 流程动作.externalSpecialProcessAction

Parameters

String task

[required]基于指定的任务执行特送

ProcessControl processControl

[required] 流转信息

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示特送成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示特送失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean specialQuery ( options)

特送查询

See 流程动作.externalSpecialProcessQueryAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示特送查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示特送查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean specialQueryExt (String task, options)

特送查询(扩展)

See 流程动作.externalSpecialProcessQueryAction

Parameters

String task

[required]基于指定的任务执行特送查询

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示特送查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示特送查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean start ( process, name, data, options)

启动流程

See 流程动作.externalStartProcessAction

Parameters

process

[required]流程标识的全称, 值可以为null

name

[required]流程实例名称, 值可以为null

data

[required]流程关联的业务数据, 必须有值

options

可选参数

是一个json格式, 有以下三个参数executor,onSuccess和onError, executor: 表示首环节的执行者,可以不指定, 这时默认就是当前人员成员; onSuccess: 表示启动流程成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示启动流程失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "executor": {String}, "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean startByTemplate ( process, templateID, name, data, options)

根据模板启动流程

See 流程动作.externalStartProcessAction

Parameters

process

[required]流程标识的全称, 值可以为null

templateID

[required]流程模板标识,必须有值

name

[required]流程实例名称, 值可以为null

data

[required]流程关联的业务数据, 必须有值

options

可选参数

是一个json格式, 有以下三个参数executor,onSuccess和onError, executor: 表示首环节的执行者,可以不指定, 这时默认就是当前人员成员; onSuccess: 表示启动流程成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示启动流程失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "executor": {String}, "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean startCustomizedQuery ( options)

定制流程查询

See 流程动作.externalStartCustomizedProcessQueryAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示定制流程查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示定制流程查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean startExt ( process, relations, options)

启动流程(扩展)

See 流程动作.externalStartProcessAction

Parameters

process

[required]流程标识的全称

relations

[required]流程实例属性值对,是一个数组,数组的下标是属性名,相应的是属性值

options

可选参数

是一个json格式, 有以下三个参数executor,onSuccess和onError, executor: 表示首环节的执行者,可以不指定, 这时默认就是当前人员成员; onSuccess: 表示启动流程成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示启动流程失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "executor": {String}, "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean suspend ( options)

暂停

See 流程动作.externalSuspendProcessAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示暂停成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示暂停失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean suspendExt (String task, ProcessControl processControl, options)

暂停(扩展)

See 流程动作.externalSuspendProcessAction

Parameters

String task

[required]基于指定的任务执行suspend

ProcessControl processControl

[required]流转信息

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示暂停成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示暂停失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean suspendQuery ( options)

暂停查询

See 流程动作.externalSuspendProcessQueryAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示暂停查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示暂停查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean suspendQueryExt (String task, options)

暂停查询(扩展)

See 流程动作.externalSuspendProcessQueryAction

Parameters

String task

[required]基于指定的任务执行suspendQuery

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示暂停查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示暂停查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean transfer ( options)

转发

See 流程动作.externalTransferTaskAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示转发成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示转发失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean transferExt (String task, ProcessControl processControl, options)

转发(扩展)

See 流程动作.externalTransferTaskAction

Parameters

String task

[required]基于指定的任务执行transfer

ProcessControl processControl

[required] 流转信息

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示转发成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示转发失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean transferQuery ( options)

转发查询

See 流程动作.externalTransferTaskQueryAction

Parameters

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示转发查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示转发查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public boolean transferQueryExt (String task, options)

转发查询(扩展)

See 流程动作.externalTransferTaskQueryAction

Parameters

String task

[required]基于指定的任务执行transferQuery

options

可选参数

是一个json格式, 有以下两个参数onSuccess和onError, onSuccess: 表示转发查询成功后的回调函数, 回调函数的参数event结构如下:{"source":组件的js对象}; onError: 表示转发查询失败后的回调函数 回调函数的参数event结构如下:{"source":组件的js对象}; 格式如下: { "onSuccess": {Function}, "onError": {Function} }

Return Value

boolean

public void withdrawTask ()

回收任务

See 流程动作.externalWithdrawTaskAction

Return Value

void

public void withdrawTaskExt (String task)

回收任务

See 流程动作.externalWithdrawTaskAction

Parameters

String task

任务

Return Value

void

Operations Detail Top

public void abort (String task, Function onSuccess)

终止

Parameters

String task

任务

Function onSuccess

操作执行成功后的回调

Return Value

void

public void advance (String task, Function onSuccess)

流转

Parameters

String task

任务

Function onSuccess

操作执行成功后的回调

Return Value

void

public void back (String task, Function onSuccess)

回退

Parameters

String task

任务

Function onSuccess

操作执行成功后的回调

Return Value

void

public void modifyExecutor (String task, Function onSuccess)

修改执行者

Parameters

String task

任务

Function onSuccess

操作执行成功后的回调

Return Value

void

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

显示流程记录

Parameters

String process

流程标识

String data

业务数据

String task

任务

Return Value

void

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

显示流程图

Parameters

String process

流程标识

String data

业务数据

String task

任务

Return Value

void

public void special (String task, Function onSuccess)

特送

Parameters

String task

任务

Function onSuccess

操作执行成功后的回调

Return Value

void

public void suspend (String task, Function onSuccess)

暂停

Parameters

String task

任务

Function onSuccess

操作执行成功后的回调

Return Value

void

public void transfer (String task, Function onSuccess)

转发

Parameters

String task

任务

Function onSuccess

操作执行成功后的回调

Return Value

void

public void withdrawTask (String task, Function onSuccess)

任务回收

Parameters

String task

任务

Function onSuccess

操作执行成功后的回调

Return Value

void

Events Detail Top

public void onAbortCommit (AbortCommitEvent event)

[回调型事件]终止成功(终止事务外)

Parameters

AbortCommitEvent event

它的结构如下:

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

Return Value

void

public void onAbortError (AbortErrorEvent event)

[回调型事件]终止失败(终止事务外)

Parameters

AbortErrorEvent event

它的结构如下:

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

Return Value

void

public void onAbortQueryError (AbortQueryErrorEvent event)

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

Parameters

AbortQueryErrorEvent event

它的结构如下:

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

Return Value

void

public void onAdvanceCommit (AdvanceCommitEvent event)

[回调型事件]流转成功(流转事务外)

Parameters

AdvanceCommitEvent event

它的结构如下:

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

Return Value

void

public void onAdvanceError (AdvanceErrorEvent event)

[回调型事件]流转失败(流转事务外)

Parameters

AdvanceErrorEvent event

它的结构如下:

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

Return Value

void

public void onAdvanceQueryError (AdvanceQueryErrorEvent event)

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

Parameters

AdvanceQueryErrorEvent event

它的结构如下:

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

Return Value

void

public void onAfterAbort (AfterAbortEvent event)

[回调型事件]终止之后(终止事务内)

Parameters

AfterAbortEvent event

它的结构如下:

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

Return Value

void

public void onAfterAbortQuery (AfterAbortQueryEvent event)

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

Parameters

AfterAbortQueryEvent event

它的结构如下:

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

Return Value

void

public void onAfterAdvance (AfterAdvanceEvent event)

[回调型事件]流转之后(流转事务内)

Parameters

AfterAdvanceEvent event

它的结构如下:

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

Return Value

void

public void onAfterAdvanceQuery (AfterAdvanceQueryEvent event)

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

Parameters

AfterAdvanceQueryEvent event

它的结构如下:

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

Return Value

void

public void onAfterBack (AfterBackEvent event)

[回调型事件]回退之后(回退事务内)

Parameters

AfterBackEvent event

它的结构如下:

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

Return Value

void

public void onAfterBackQuery (AfterBackQueryEvent event)

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

Parameters

AfterBackQueryEvent event

它的结构如下:

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

Return Value

void

public void onAfterStart (AfterStartEvent event)

[回调型事件]启动流程之后(流程启动事务内)

Parameters

AfterStartEvent event

它的结构如下:

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

Return Value

void

public void onAfterStartCustomizedQuery (AfterStartCustomizedQueryEvent event)

[回调型事件]定制流程查询之后

Parameters

AfterStartCustomizedQueryEvent event

它的结构如下:

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

Return Value

void

public void onAfterSuspend (AfterSuspendEvent event)

[回调型事件]暂停之后(暂停事务内)

Parameters

AfterSuspendEvent event

它的结构如下:

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

Return Value

void

public void onAfterSuspendQuery (AfterSuspendQueryEvent event)

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

Parameters

AfterSuspendQueryEvent event

它的结构如下:

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

Return Value

void

public void onAfterTransfer (AfterTransferEvent event)

[回调型事件]转发之后(转发事务内)

Parameters

AfterTransferEvent event

它的结构如下:

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

Return Value

void

public void onAfterTransferQuery (AfterTransferQueryEvent event)

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

Parameters

AfterTransferQueryEvent event

它的结构如下:

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

Return Value

void

public void onBackCommit (BackCommitEvent event)

[回调型事件]回退成功(回退事务外)

Parameters

BackCommitEvent event

它的结构如下:

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

Return Value

void

public void onBackError (BackErrorEvent event)

[回调型事件]回退失败(回退事务外)

Parameters

BackErrorEvent event

它的结构如下:

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

Return Value

void

public void onBackQueryError (BackQueryErrorEvent event)

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

Parameters

BackQueryErrorEvent event

它的结构如下:

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

Return Value

void

public void onBeforeAbort (BeforeAbortEvent event)

[回调型事件]终止之前(终止事务内)

Parameters

BeforeAbortEvent event

它的结构如下:

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

Return Value

void

public void onBeforeAbortQuery (BeforeAbortQueryEvent event)

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

Parameters

BeforeAbortQueryEvent event

它的结构如下:

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

Return Value

void

public void onBeforeAdvance (BeforeAdvanceEvent event)

[回调型事件]流转之前(流转事务内)

Parameters

BeforeAdvanceEvent event

它的结构如下:

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

Return Value

void

public void onBeforeAdvanceQuery (BeforeAdvanceQueryEvent event)

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

Parameters

BeforeAdvanceQueryEvent event

它的结构如下:

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

Return Value

void

public void onBeforeBack (BeforeBackEvent event)

[回调型事件]回退之前(回退事务内)

Parameters

BeforeBackEvent event

它的结构如下:

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

Return Value

void

public void onBeforeBackQuery (BeforeBackQueryEvent event)

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

Parameters

BeforeBackQueryEvent event

它的结构如下:

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

Return Value

void

public void onBeforeOpenDialog (BeforeOpenDialogEvent event)

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

Parameters

BeforeOpenDialogEvent event

它的结构如下:

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

Return Value

void

public void onBeforeStart (BeforeStartEvent event)

启动流程之前(流程启动事务内)

Parameters

BeforeStartEvent event

它的结构如下:

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

Return Value

void

public void onBeforeStartCustomizedQuery (BeforeStartCustomizedQueryEvent event)

[回调型事件]定制流程查询之前

Parameters

BeforeStartCustomizedQueryEvent event

它的结构如下:

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

Return Value

void

public void onBeforeSuspend (BeforeSuspendEvent event)

[回调型事件]暂停之前(暂停事务内)

Parameters

BeforeSuspendEvent event

它的结构如下:

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

Return Value

void

public void onBeforeSuspendQuery (BeforeSuspendQueryEvent event)

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

Parameters

BeforeSuspendQueryEvent event

它的结构如下:

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

Return Value

void

public void onBeforeTransfer (BeforeTransferEvent event)

[回调型事件]转发之前(转发事务内)

Parameters

BeforeTransferEvent event

它的结构如下:

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

Return Value

void

public void onBeforeTransferQuery (BeforeTransferQueryEvent event)

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

Parameters

BeforeTransferQueryEvent event

它的结构如下:

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

Return Value

void

public void onCloseDialog (CloseDialogEvent event)

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

Parameters

CloseDialogEvent event

它的结构如下:

{ "source":组件的js对象, "action":当前执行的操作, "task":当前任务ID, "isOK": 是否是"确定" }

Return Value

void

public void onStartCommit (StartCommitEvent event)

[回调型事件]启动流程成功(流程启动事务外)

Parameters

StartCommitEvent event

它的结构如下:

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

Return Value

void

public void onStartCustomizedQueryError (StartCustomizedQueryErrorEvent event)

[回调型事件]定制流程查询失败

Parameters

StartCustomizedQueryErrorEvent event

它的结构如下:

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

Return Value

void

public void onStartError (StartErrorEvent event)

[回调型事件]启动流程失败(流程启动事务外)

Parameters

StartErrorEvent event

它的结构如下:

{ "source":组件的js对象, "process":流程, "relations":{ 关系名称:关系值 }, "executor":首环节的执行者, "cancel":false, "errorType": "client"或"server", "error": js异常对象, "errorNode": 服务端错误信息 }

Return Value

void

public void onSuspendCommit (SuspendCommitEvent event)

[回调型事件]暂停成功(暂停事务外)

Parameters

SuspendCommitEvent event

它的结构如下:

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

Return Value

void

public void onSuspendError (SuspendErrorEvent event)

[回调型事件]暂停失败(暂停事务外)

Parameters

SuspendErrorEvent event

它的结构如下:

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

Return Value

void

public void onSuspendQueryError (SuspendQueryErrorEvent event)

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

Parameters

SuspendQueryErrorEvent event

它的结构如下:

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

Return Value

void

public void onTransferCommit (TransferCommitEvent event)

[回调型事件]转发成功(转发事务外)

Parameters

TransferCommitEvent event

它的结构如下:

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

Return Value

void

public void onTransferError (TransferErrorEvent event)

[回调型事件]转发失败(转发事务外)

Parameters

TransferErrorEvent event

它的结构如下:

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

Return Value

void

public void onTransferQueryError (TransferQueryErrorEvent event)

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

Parameters

TransferQueryErrorEvent event

它的结构如下:

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

Return Value

void