cn.schoolwow.quickflow.domain

接口 FlowContext

所有已知实现类:

FlowContextImpl

public interface FlowContext

上下文对象

方法概要

限定符和类型	方法和说明
void	broken(String reason) 中断流程
void	brokenCurrentCompositeBusiness(String reason) 中断当前复合流程
void	brokenCurrentFlow(String reason) 中断当前流程
Object	checkData(String key) 获取上下文数据,不存在时抛出异常
<T> T	checkData(String key, Class<T> clazz) 获取上下文数据,不存在时抛出异常
boolean	containKey(String key) 判断key是否存在
FlowContext	executeCompositeFlowList(CompositeBusinessFlow... compositeBusinessFlowList) 执行复合流程列表
FlowContext	executeFlowList(BusinessFlow... businessFlowList) 执行流程列表
FlowContext	executeFunctionFlowList(String... functionFlowNames) 执行内部函数
FlowContext	executeGlobalBeforeAfter(boolean executeGlobalBeforeAfter) 是否所有流程都执行全局beforeAfter处理器
FlowContext	executeGlobalSingleFlow(boolean executeGlobalSingleFlow) 是否所有流程都执行全局singleFlow处理器
FlowContext	executeGlobalTryCatchFinally(boolean executeGlobalTryCatchFinally) 是否所有流程都执行全局tryCatchFinally处理器
String	getBrokenReason() 获取流程中断原因
Map<String,Object>	getContextDataMap() 获取上下文数据
Map<String,Object>	getData() 获取上下文数据,不包含当前流程数据和当前复合流程数据,即通过putCurrentCompositeFlowData和putCurrentFlowData方法设置的数据
Object	getData(String key) 获取上下文数据
<T> T	getData(String key, Class<T> clazz) 获取上下文数据
<T> T	getData(String key, Class<T> clazz, T defaultValue) 获取上下文数据
Object	getData(String key, Object defaultValue) 获取上下文数据
Exception	getFlowException() 获取流程异常
FlowExecutorConfig	getFlowExecutorConfig() 获取配置项
FlowExecutorRootConfig	getFlowExecutorRootConfig() 获取配置项
String	getFlowName() 获取主流程名
List<String>	getFlowNameList() 获取流程列表
String	getFlowTrace() 获取流程日志
long	getId() 返回流程唯一标识
String	getLog() 获取自定义日志
QuickFlow	getQuickFlow() 获取流程
String	getRecord() 获取日志记录
Map<String,Object>	getRequestDataMap() 获取请求数据
Map<String,Object>	getTemporaryDataMap() 获取临时数据key
Map<String,Object>	getThreadLocalDataMap() 获取线程上下文数据
FlowContext	ignoreBroken(boolean ignoreBroken) 忽略中断
FlowContext	ignoreException(boolean ignoreException) 忽略异常
FlowContext	isDataNotExist(String key, String message) 检查数据是否存在,不存在时抛出异常
FlowContext	log(String logContent, Object... parameters) 记录自定义日志
FlowContext	printTrace(boolean printTrace) 打印日志
FlowContext	putContextData(String key, Object value) 设置全局上下文数据
FlowContext	putCurrentCompositeFlowData(String key, Object value) 设置当前复合流程数据
FlowContext	putCurrentFlowData(String key, Object value) 设置当前流程数据
FlowContext	putData(String key, Object value) 设置上下文数据
FlowContext	putFunctionFlow(String key, FunctionFlow functionFlow) 设置内部函数方法
FlowContext	putFunctionFlowIfAbsent(String key, FunctionFlow functionFlow) 不存在时设置内部函数方法
FlowContext	putTemporaryData(Map<String,Object> dataMap) 设置临时数据
FlowContext	putTemporaryData(String key, Object value) 设置临时数据
FlowContext	putTemporaryDataIfAbsent(String key, Object value) 不存在时设置临时数据
FlowContext	putThreadLocalData(String key, Object value) 设置线程本地数据
FlowContext	remark(String remark) 流程备注
FlowContext	removeData(String key) 移除上下文数据
FlowContext	removeThreadLocalData(String key) 移除线程本地数据
QuickFlowExecutor	startFlow(BusinessFlow businessFlow) 创建流程
QuickFlowExecutor	startFlow(CompositeBusinessFlow compositeBusinessFlow) 创建流程
QuickFlowExecutor	startFlow(String name) 创建流程
Object	useData(String key) 获取上下文数据,获取后删除,不存在时抛出异常
<T> T	useData(String key, Class<T> clazz) 获取上下文数据,获取后删除,不存在时抛出异常

方法详细资料

getId

long getId()

返回流程唯一标识

printTrace

FlowContext printTrace(boolean printTrace)

打印日志

ignoreBroken

FlowContext ignoreBroken(boolean ignoreBroken)

忽略中断

ignoreException

FlowContext ignoreException(boolean ignoreException)

忽略异常

executeGlobalTryCatchFinally

FlowContext executeGlobalTryCatchFinally(boolean executeGlobalTryCatchFinally)

是否所有流程都执行全局tryCatchFinally处理器

executeGlobalBeforeAfter

FlowContext executeGlobalBeforeAfter(boolean executeGlobalBeforeAfter)

是否所有流程都执行全局beforeAfter处理器

executeGlobalSingleFlow

FlowContext executeGlobalSingleFlow(boolean executeGlobalSingleFlow)

是否所有流程都执行全局singleFlow处理器

isDataNotExist

FlowContext isDataNotExist(String key,
                           String message)

检查数据是否存在,不存在时抛出异常

containKey

boolean containKey(String key)

判断key是否存在

checkData

Object checkData(String key)

获取上下文数据,不存在时抛出异常

checkData

<T> T checkData(String key,
                Class<T> clazz)

获取上下文数据,不存在时抛出异常

useData

Object useData(String key)

获取上下文数据,获取后删除,不存在时抛出异常

useData

<T> T useData(String key,
              Class<T> clazz)

获取上下文数据,获取后删除,不存在时抛出异常

getData

Object getData(String key)

获取上下文数据

getData

<T> T getData(String key,
              Class<T> clazz)

获取上下文数据

getData

Object getData(String key,
               Object defaultValue)

获取上下文数据

getData

<T> T getData(String key,
              Class<T> clazz,
              T defaultValue)

获取上下文数据

getData

Map<String,Object> getData()

获取上下文数据,不包含当前流程数据和当前复合流程数据,即通过putCurrentCompositeFlowData和putCurrentFlowData方法设置的数据

getTemporaryDataMap

Map<String,Object> getTemporaryDataMap()

获取临时数据key

getThreadLocalDataMap

Map<String,Object> getThreadLocalDataMap()

获取线程上下文数据

getRequestDataMap

Map<String,Object> getRequestDataMap()

获取请求数据

getContextDataMap

Map<String,Object> getContextDataMap()

获取上下文数据

putContextData

FlowContext putContextData(String key,
                           Object value)

设置全局上下文数据

putData

FlowContext putData(String key,
                    Object value)

设置上下文数据

putFunctionFlowIfAbsent

FlowContext putFunctionFlowIfAbsent(String key,
                                    FunctionFlow functionFlow)

不存在时设置内部函数方法

putFunctionFlow

FlowContext putFunctionFlow(String key,
                            FunctionFlow functionFlow)

设置内部函数方法

putTemporaryDataIfAbsent

FlowContext putTemporaryDataIfAbsent(String key,
                                     Object value)

不存在时设置临时数据

putTemporaryData

FlowContext putTemporaryData(String key,
                             Object value)

设置临时数据

putTemporaryData

FlowContext putTemporaryData(Map<String,Object> dataMap)

设置临时数据

putCurrentCompositeFlowData

FlowContext putCurrentCompositeFlowData(String key,
                                        Object value)

设置当前复合流程数据

putCurrentFlowData

FlowContext putCurrentFlowData(String key,
                               Object value)

设置当前流程数据

putThreadLocalData

FlowContext putThreadLocalData(String key,
                               Object value)

设置线程本地数据

removeData

FlowContext removeData(String key)

移除上下文数据

removeThreadLocalData

FlowContext removeThreadLocalData(String key)

移除线程本地数据

remark

FlowContext remark(String remark)

流程备注

brokenCurrentFlow

void brokenCurrentFlow(String reason)

中断当前流程

参数:

reason - 中断原因

brokenCurrentCompositeBusiness

void brokenCurrentCompositeBusiness(String reason)

中断当前复合流程

参数:

reason - 中断原因

broken

void broken(String reason)

中断流程

参数:

reason - 中断原因

getFlowName

String getFlowName()

获取主流程名

getFlowNameList

List<String> getFlowNameList()

获取流程列表

getFlowTrace

String getFlowTrace()

获取流程日志

getFlowException

Exception getFlowException()

获取流程异常

getBrokenReason

String getBrokenReason()

获取流程中断原因

startFlow

QuickFlowExecutor startFlow(String name)

创建流程

startFlow

QuickFlowExecutor startFlow(BusinessFlow businessFlow)

创建流程

startFlow

QuickFlowExecutor startFlow(CompositeBusinessFlow compositeBusinessFlow)

创建流程

executeFunctionFlowList

FlowContext executeFunctionFlowList(String... functionFlowNames)

执行内部函数

executeFlowList

FlowContext executeFlowList(BusinessFlow... businessFlowList)

执行流程列表

executeCompositeFlowList

FlowContext executeCompositeFlowList(CompositeBusinessFlow... compositeBusinessFlowList)

执行复合流程列表

getFlowExecutorConfig

FlowExecutorConfig getFlowExecutorConfig()

获取配置项

getFlowExecutorRootConfig

FlowExecutorRootConfig getFlowExecutorRootConfig()

获取配置项

getQuickFlow

QuickFlow getQuickFlow()

获取流程

getRecord

String getRecord()

获取日志记录

getLog

String getLog()

获取自定义日志

log

FlowContext log(String logContent,
                Object... parameters)

记录自定义日志