cn.schoolwow.quickflow.domain

接口 FlowContext

所有已知实现类:

FlowContextImpl

public interface FlowContext

上下文对象

方法概要

限定符和类型	方法和说明
void	broken(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	executeGlobalBeforeAfter(boolean executeGlobalBeforeAfter) 是否所有流程都执行全局beforeAfter处理器
FlowContext	executeGlobalSingleFlow(boolean executeGlobalSingleFlow) 是否所有流程都执行全局singleFlow处理器
FlowContext	executeGlobalTryCatchFinally(boolean executeGlobalTryCatchFinally) 是否所有流程都执行全局tryCatchFinally处理器
FlowContext	executeQuickFlowExecutor(QuickFlowExecutor quickFlowExecutor) 执行复合流程
String	getBrokenReason() 获取流程中断原因
Map<String,Object>	getContextDataMap() 获取上下文数据
Map<String,Object>	getData() 获取上下文数据
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() 返回流程唯一标识
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	printTrace(boolean printTrace) 打印日志
void	putData(Map<String,Object> map) 设置上下文数据
void	putData(String key, Object value) 设置上下文数据
void	putTemporaryData(Map<String,Object> map) 设置临时数据
void	putTemporaryData(String key, Object value) 设置临时数据
void	putThreadLocalData(Map<String,Object> map) 设置线程本地数据
void	putThreadLocalData(String key, Object value) 设置线程本地数据
void	remark(String remark) 流程备注
void	removeData(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处理器

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()

获取上下文数据

getTemporaryDataMap

Map<String,Object> getTemporaryDataMap()

获取临时数据key

getThreadLocalDataMap

Map<String,Object> getThreadLocalDataMap()

获取线程上下文数据

getRequestDataMap

Map<String,Object> getRequestDataMap()

获取请求数据

getContextDataMap

Map<String,Object> getContextDataMap()

获取上下文数据

putData

void putData(String key,
             Object value)

设置上下文数据

putData

void putData(Map<String,Object> map)

设置上下文数据

putTemporaryData

void putTemporaryData(String key,
                      Object value)

设置临时数据

putTemporaryData

void putTemporaryData(Map<String,Object> map)

设置临时数据

putThreadLocalData

void putThreadLocalData(String key,
                        Object value)

设置线程本地数据

putThreadLocalData

void putThreadLocalData(Map<String,Object> map)

设置线程本地数据

removeData

void removeData(String key)

移除上下文数据

remark

void remark(String remark)

流程备注

brokenCurrentFlow

void brokenCurrentFlow(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)

创建流程

executeFlowList

FlowContext executeFlowList(BusinessFlow... businessFlowList)

执行流程列表

executeQuickFlowExecutor

FlowContext executeQuickFlowExecutor(QuickFlowExecutor quickFlowExecutor)

执行复合流程

executeCompositeFlowList

FlowContext executeCompositeFlowList(CompositeBusinessFlow... compositeBusinessFlowList)

执行复合流程列表

getFlowExecutorConfig

FlowExecutorConfig getFlowExecutorConfig()

获取配置项

getFlowExecutorRootConfig

FlowExecutorRootConfig getFlowExecutorRootConfig()

获取配置项

getQuickFlow

QuickFlow getQuickFlow()

获取流程

getRecord

String getRecord()

获取日志记录