com.actionsoft.bpms.bpmn.engine.core.delegate

接口 ProcessExecutionContext

public interface ProcessExecutionContext

流程事件监听器为开发者提供的上下文对象（如流程事件、流程表单事件等）

方法概要

限定符和类型	方法和说明
ProcessExecutionContext	addAlertMessage(java.lang.String boName, java.lang.String msg) 给指定的BO表增加一个横幅提醒信息，默认为青色背景
ProcessExecutionContext	addAlertMessage(java.lang.String boName, java.lang.String msg, java.lang.String bgColor, java.lang.String fontColor) 给指定的BO表增加一个横幅提醒信息
ProcessExecutionContext	addAlertMessageError(java.lang.String boName, java.lang.String msg) 给指定的BO表增加一个横幅错误信息，默认为红色背景
ProcessExecutionContext	addAlertMessageInfo(java.lang.String boName, java.lang.String msg) 给指定的BO表增加一个横幅提醒信息，默认为蓝色背景
ProcessExecutionContext	addAlertMessageWarn(java.lang.String boName, java.lang.String msg) 给指定的BO表增加一个横幅警告信息，默认为黄色背景
ProcessExecutionContext	addFormDisplayPolicy(java.lang.String boName, java.lang.String boItemName) 程序指定BO字段显示（优先级最高）。
ProcessExecutionContext	addFormEditablePolicy(java.lang.String boName) 程序指定BO可编辑（优先级最高）。
ProcessExecutionContext	addFormEditablePolicy(java.lang.String boName, java.lang.String boItemName) 程序指定BO字段可编辑（优先级最高）。
ProcessExecutionContext	addFormHiddenPolicy(java.lang.String boName, java.lang.String boItemName) 程序指定BO字段隐藏（优先级最高）。
ProcessExecutionContext	addFormNotNullPolicy(java.lang.String boName, java.lang.String boItemName) 程序指定BO字段必填（优先级最高）。
ProcessExecutionContext	addFormNullablePolicy(java.lang.String boName, java.lang.String boItemName) 程序指定BO字段选填（优先级最高）。
ProcessExecutionContext	addFormReadOnlyPolicy(java.lang.String boName) 程序指定BO操作只读（优先级最高）。
ProcessExecutionContext	addFormReadOnlyPolicy(java.lang.String boName, java.lang.String boItemName) 程序指定BO字段只读（优先级最高）。
ProcessExecutionContext	addGridColumnPolicy(java.lang.String boName, java.util.List<java.lang.String> gridColumnPolicy) 程序指定子表列头的字段信息（可控制显示顺序，优先级最高，高于子表列字段的显示隐藏策略）。
ProcessExecutionContext	addGridDisplayPolicy(java.lang.String boName, java.lang.String boItemName) 程序指定子表列的BO字段显示（优先级最高）。
ProcessExecutionContext	addGridHiddenPolicy(java.lang.String boName, java.lang.String boItemName) 程序指定子表列的BO字段隐藏（优先级最高）。
java.lang.String	execAtScript(java.lang.String script) 执行@公式脚本
java.lang.String	getAlertMessage(java.lang.String boName) 返回指定的BO表的警告信息
BO	getBO(java.lang.String boName) 根据当前上下文，快速获得主表BO对象
BOQueryAPI	getBOQuery(java.lang.String boName) 根据当前上下文，快速获得查询子表BO的操作对象。
BO	getFormData() 获得当前Form引擎的主表单数据对象
java.util.List<SequenceFlowModel>	getIncoming() 获得当前节点的前置汇聚分支，来自流程结构定义
java.util.List<SequenceFlowModel>	getOutgoing() 获得当前节点后继连线分支，来自流程结构定义
boolean	getParameterOfBoolean(java.lang.String paraName) 读取一个上下文提供的boolean类型临时参数值，如果未初始化或类型匹配错误，返回false
double	getParameterOfDouble(java.lang.String paraName) 读取一个上下文提供的Double类型临时参数值，如果未初始化或类型匹配错误，返回0
int	getParameterOfInteger(java.lang.String paraName) 读取一个上下文提供的Integer类型临时参数值，如果未初始化或类型匹配错误，返回0
java.util.List<T>	getParameterOfList(java.lang.String paraName) 读取一个上下文提供的List类型临时参数值，如果未初始化或类型匹配错误，返回null
long	getParameterOfLong(java.lang.String paraName) 读取一个上下文提供的Long类型临时参数值，如果未初始化或类型匹配错误，返回0
java.util.Map<java.lang.String,java.lang.Object>	getParameterOfMap(java.lang.String paraName) 读取一个上下文提供的Map类型临时参数值，如果未初始化或类型匹配错误，返回null
java.lang.String	getParameterOfString(java.lang.String paraName) 读取一个上下文提供的String类型临时参数值，如果未初始化或类型匹配错误，返回null
ProcessDefinition	getProcessDef() 获得当前流程结构定义
ProcessElement	getProcessElement() 获得当前流程元素（任务、网关、事件）定义
java.util.List<ProcessExecutionTrack>	getProcessExecutionTracks() 获得在自动化执行路径过程中的结果集
ProcessInstance	getProcessInstance() 获得当前流程实例对象
TaskInstance	getTaskInstance() 获得当前任务实例对象
UserContext	getUserContext() 获得当前用户上下文对象
java.lang.Object	getVariable(java.lang.String varName) 读取指定的流程变量
java.util.Map<java.lang.String,java.lang.Object>	getVariables() 读取全部流程变量
boolean	isAsync() 是否异步执行
boolean	isChoiceActionMenu(java.lang.String actionName) 当前人工任务是否选中了指定的审核菜单。
ProcessExecutionContext	removeAlertMessage(java.lang.String boName, java.lang.String msg) 删除指定BO表的警告信息
ProcessExecutionContext	setFieldTitlePolicy(java.lang.String boName, java.lang.String boItemName, java.lang.String newTitle) 程序指定BO字段标题（优先级最高）。
void	setVariable(java.lang.String varName, java.lang.Object varValue) 设置流程变量
void	setVariables(java.util.Map<java.lang.String,java.lang.Object> vars) 批量设置流程变量

方法详细资料

getProcessInstance

ProcessInstance getProcessInstance()

获得当前流程实例对象

返回:

getTaskInstance

TaskInstance getTaskInstance()

获得当前任务实例对象

返回:

getUserContext

UserContext getUserContext()

获得当前用户上下文对象

返回:

getProcessExecutionTracks

java.util.List<ProcessExecutionTrack> getProcessExecutionTracks()

获得在自动化执行路径过程中的结果集

返回:

getProcessDef

ProcessDefinition getProcessDef()

获得当前流程结构定义

返回:

getProcessElement

ProcessElement getProcessElement()

获得当前流程元素（任务、网关、事件）定义

返回:

getIncoming

java.util.List<SequenceFlowModel> getIncoming()

获得当前节点的前置汇聚分支，来自流程结构定义

返回:

getOutgoing

java.util.List<SequenceFlowModel> getOutgoing()

获得当前节点后继连线分支，来自流程结构定义

返回:

setVariable

void setVariable(java.lang.String varName,
                 java.lang.Object varValue)
          throws AWSException

设置流程变量

参数:

varName - 变量名

varValue - 值

抛出:

AWSException

setVariables

void setVariables(java.util.Map<java.lang.String,java.lang.Object> vars)
           throws AWSException

批量设置流程变量

参数:

vars - key,value列表

抛出:

AWSException

getVariable

java.lang.Object getVariable(java.lang.String varName)
                      throws AWSException

读取指定的流程变量

参数:

varName - 变量名

抛出:

AWSException

getVariables

java.util.Map<java.lang.String,java.lang.Object> getVariables()
                                                       throws AWSException

读取全部流程变量

抛出:

AWSException

addFormReadOnlyPolicy

ProcessExecutionContext addFormReadOnlyPolicy(java.lang.String boName)

程序指定BO操作只读（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

返回:

返回当前对象，方便继续添加

addFormReadOnlyPolicy

ProcessExecutionContext addFormReadOnlyPolicy(java.lang.String boName,
                                              java.lang.String boItemName)

程序指定BO字段只读（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

boItemName - 字段名

返回:

返回当前对象，方便继续添加

addFormEditablePolicy

ProcessExecutionContext addFormEditablePolicy(java.lang.String boName)

程序指定BO可编辑（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

返回:

返回当前对象，方便继续添加

addFormEditablePolicy

ProcessExecutionContext addFormEditablePolicy(java.lang.String boName,
                                              java.lang.String boItemName)

程序指定BO字段可编辑（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

boItemName - 字段名

返回:

返回当前对象，方便继续添加

addFormHiddenPolicy

ProcessExecutionContext addFormHiddenPolicy(java.lang.String boName,
                                            java.lang.String boItemName)

程序指定BO字段隐藏（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

boItemName - 字段名

返回:

返回当前对象，方便继续添加

addFormDisplayPolicy

ProcessExecutionContext addFormDisplayPolicy(java.lang.String boName,
                                             java.lang.String boItemName)

程序指定BO字段显示（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

boItemName - 字段名

返回:

返回当前对象，方便继续添加

addGridHiddenPolicy

ProcessExecutionContext addGridHiddenPolicy(java.lang.String boName,
                                            java.lang.String boItemName)

程序指定子表列的BO字段隐藏（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

boItemName - 字段名

newTitle - 新的标题

返回:

返回当前对象，方便继续添加

addGridDisplayPolicy

ProcessExecutionContext addGridDisplayPolicy(java.lang.String boName,
                                             java.lang.String boItemName)

程序指定子表列的BO字段显示（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

boItemName - 字段名

返回:

返回当前对象，方便继续添加

addFormNotNullPolicy

ProcessExecutionContext addFormNotNullPolicy(java.lang.String boName,
                                             java.lang.String boItemName)

程序指定BO字段必填（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

boItemName - 字段名

返回:

返回当前对象，方便继续添加

addFormNullablePolicy

ProcessExecutionContext addFormNullablePolicy(java.lang.String boName,
                                              java.lang.String boItemName)

程序指定BO字段选填（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

boItemName - 字段名

返回:

返回当前对象，方便继续添加

setFieldTitlePolicy

ProcessExecutionContext setFieldTitlePolicy(java.lang.String boName,
                                            java.lang.String boItemName,
                                            java.lang.String newTitle)

程序指定BO字段标题（优先级最高）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

boItemName - 字段名

newTitle - 新的标题

返回:

返回当前对象，方便继续添加

addGridColumnPolicy

ProcessExecutionContext addGridColumnPolicy(java.lang.String boName,
                                            java.util.List<java.lang.String> gridColumnPolicy)

程序指定子表列头的字段信息（可控制显示顺序，优先级最高，高于子表列字段的显示隐藏策略）。仅适用于人工节点的表单权限场景

参数:

boName - BO表名

gridColumnPolicy - 一个存放BO表字段列表的有序List

返回:

返回当前对象，方便继续添加

addAlertMessage

ProcessExecutionContext addAlertMessage(java.lang.String boName,
                                        java.lang.String msg,
                                        java.lang.String bgColor,
                                        java.lang.String fontColor)

给指定的BO表增加一个横幅提醒信息

参数:

boName - BO表名

msg - 要显示的信息

bgColor - 背景颜色

fontColor - 字体颜色

返回:

返回当前对象，方便继续添加

addAlertMessage

ProcessExecutionContext addAlertMessage(java.lang.String boName,
                                        java.lang.String msg)

给指定的BO表增加一个横幅提醒信息，默认为青色背景

参数:

boName - BO表名

msg - 要显示的信息

返回:

返回当前对象，方便继续添加

addAlertMessageInfo

ProcessExecutionContext addAlertMessageInfo(java.lang.String boName,
                                            java.lang.String msg)

给指定的BO表增加一个横幅提醒信息，默认为蓝色背景

参数:

boName - BO表名

msg - 要显示的信息

返回:

返回当前对象，方便继续添加

addAlertMessageWarn

ProcessExecutionContext addAlertMessageWarn(java.lang.String boName,
                                            java.lang.String msg)

给指定的BO表增加一个横幅警告信息，默认为黄色背景

参数:

boName - BO表名

msg - 要显示的信息

返回:

返回当前对象，方便继续添加

addAlertMessageError

ProcessExecutionContext addAlertMessageError(java.lang.String boName,
                                             java.lang.String msg)

给指定的BO表增加一个横幅错误信息，默认为红色背景

参数:

boName - BO表名

msg - 要显示的信息

返回:

返回当前对象，方便继续添加

removeAlertMessage

ProcessExecutionContext removeAlertMessage(java.lang.String boName,
                                           java.lang.String msg)

删除指定BO表的警告信息

参数:

boName - BO表名

返回:

返回当前对象，方便继续添加

getAlertMessage

java.lang.String getAlertMessage(java.lang.String boName)

返回指定的BO表的警告信息

参数:

boName - BO表名

返回:

一个JSON数组结构，格式为[{"boName":"","msg":"","bgColor":"","fontColor":""}]

isChoiceActionMenu

boolean isChoiceActionMenu(java.lang.String actionName)

当前人工任务是否选中了指定的审核菜单。如果该上下文的任务实例是一个非人工任务（如服务任务），那么会递归的向前寻找最近的那个人工任务

参数:

actionName - 审核菜单名，如果要判断用户是否未选择任何菜单，可以-替代

返回:

如果被选中返回true

isAsync

boolean isAsync()

是否异步执行

返回:

execAtScript

java.lang.String execAtScript(java.lang.String script)

执行@公式脚本

参数:

script -

返回:

getParameterOfString

java.lang.String getParameterOfString(java.lang.String paraName)

读取一个上下文提供的String类型临时参数值，如果未初始化或类型匹配错误，返回null

参数:

paraName - 参数名

返回:

一个String值或null

getParameterOfMap

java.util.Map<java.lang.String,java.lang.Object> getParameterOfMap(java.lang.String paraName)

读取一个上下文提供的Map类型临时参数值，如果未初始化或类型匹配错误，返回null

参数:

paraName - 参数名

返回:

一个Map值或null

getParameterOfList

java.util.List<T> getParameterOfList(java.lang.String paraName)

读取一个上下文提供的List类型临时参数值，如果未初始化或类型匹配错误，返回null

参数:

paraName - 参数名

返回:

一个List值或null

getParameterOfBoolean

boolean getParameterOfBoolean(java.lang.String paraName)

读取一个上下文提供的boolean类型临时参数值，如果未初始化或类型匹配错误，返回false

参数:

paraName -

返回:

getParameterOfInteger

int getParameterOfInteger(java.lang.String paraName)

读取一个上下文提供的Integer类型临时参数值，如果未初始化或类型匹配错误，返回0

参数:

paraName - 参数名

返回:

一个Integer值

getParameterOfLong

long getParameterOfLong(java.lang.String paraName)

读取一个上下文提供的Long类型临时参数值，如果未初始化或类型匹配错误，返回0

参数:

paraName - 参数名

返回:

一个Long值

getParameterOfDouble

double getParameterOfDouble(java.lang.String paraName)

读取一个上下文提供的Double类型临时参数值，如果未初始化或类型匹配错误，返回0

参数:

paraName - 参数名

返回:

一个Double值

getBO

BO getBO(java.lang.String boName)

根据当前上下文，快速获得主表BO对象

getBOQuery

BOQueryAPI getBOQuery(java.lang.String boName)

根据当前上下文，快速获得查询子表BO的操作对象。可以继续增加排序、返回List等操作

getFormData

BO getFormData()

获得当前Form引擎的主表单数据对象

返回: