Package com.codingapi.flow.script.request

Class GroovyScriptRequest

java.lang.Object

com.codingapi.flow.script.request.GroovyScriptRequest

@ScriptType(description="\u6d41\u7a0b\u811a\u672c\u8bf7\u6c42\u5bf9\u8c61")
public class GroovyScriptRequest
extends Object

流程groovy脚本请求对象 request def run(request){ request.getOperatorName() }

Constructor Summary

Constructors

Constructor	Description
GroovyScriptRequest(FlowSession session)	从FlowSession构建请求对象（模板方法模式）

Method Summary

Modifier and Type	Method	Description
List<Long>	findPreviousNodeOperatorIds()	获取上一节点的审批人员Id列表。
List<FlowRecord>	findSubProcessRecords(String subProcessNodeId)	查询指定子流程节点已经结束的最终记录。
IFlowOperator	getCreatedOperator()
long	getCreatedOperatorId()	流程创建者Id
String	getCreatedOperatorName()	流程创建者名称
IFlowAction	getCurrentAction()	获取当前操作对象
IFlowNode	getCurrentNode()	获取当前节点对象
IFlowOperator	getCurrentOperator()
long	getCurrentOperatorId()	流程审批者Id
String	getCurrentOperatorName()	流程审批者名称
FlowRecord	getCurrentSubProcessRecord()	获取本次刚结束的子流程最终记录。
Map<String,Object>	getFormData()
Object	getFormData(String fieldCode)	获取表单字段值（Groovy脚本调用）
IFlowNode	getNode(String nodeId)	获取节点信息
String	getNodeName()
String	getNodeType()
IFlowNode	getStartNode()	获取开始节点
List<Map<String,Object>>	getSubFormData(String subFormCode)	获取子表单的数据
IFlowOperator	getSubmitOperator()
long	getSubmitOperatorId()	流程审批者Id
String	getSubmitOperatorName()	流程审批者名称
int	getSubProcessTotal()	获取本次子流程节点创建的实例总数。
String	getWorkflowCode()
String	getWorkflowId()
String	getWorkflowTitle()
boolean	isFlowManager()	是否流程管理员
boolean	isMock()	是否模拟测试
void	resetFormData(Map<String,Object> formData)	重置当前流程表单数据
FlowCreateRequest	toCreateRequest()	转换为当前流程的请求对象
FlowCreateRequest	toCreateRequest(String workCode, long operatorId, String actionId, String formData)	创建流程请求，用于自流程的创建
FlowCreateRequest	toCreateRequest(String workCode, long operatorId, String actionId, String formData, String workTitle)	创建流程请求，用于自流程的创建（支持手动传入流程标题）
FlowCreateRequest	toCreateRequest(String workCode, long operatorId, String actionId, Map<String,Object> formData)	创建流程请求，用于自流程的创建
FlowCreateRequest	toCreateRequest(String workCode, long operatorId, String actionId, Map<String,Object> formData, String workTitle)	创建流程请求，用于自流程的创建（支持手动传入流程标题）

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GroovyScriptRequest

public GroovyScriptRequest(FlowSession session)

从FlowSession构建请求对象（模板方法模式）

Parameters:

session - 流程会话（不能为null）

Method Details

getWorkflowTitle

@ScriptFunction(name="getWorkflowTitle",
                description="\u83b7\u53d6\u6d41\u7a0b\u540d\u79f0")
public String getWorkflowTitle()

getWorkflowId

@ScriptFunction(name="getWorkflowId",
                description="\u83b7\u53d6\u6d41\u7a0bworkId")
public String getWorkflowId()

getWorkflowCode

@ScriptFunction(name="getWorkflowCode",
                description="\u83b7\u53d6\u6d41\u7a0bworkCode")
public String getWorkflowCode()

getNodeName

@ScriptFunction(name="getNodeName",
                description="\u83b7\u53d6\u8282\u70b9\u540d\u79f0")
public String getNodeName()

getNodeType

@ScriptFunction(name="getNodeType",
                description="\u83b7\u53d6\u8282\u70b9\u7c7b\u578b")
public String getNodeType()

getFormData

@ScriptFunction(name="getFormData",
                description="\u83b7\u53d6\u5f53\u524d\u6d41\u7a0b\u6570\u636e")
public Map<String,Object> getFormData()

resetFormData

@ScriptFunction(name="resetFormData",
                description="\u91cd\u7f6e\u5f53\u524d\u6d41\u7a0b\u8868\u5355\u6570\u636e")
public void resetFormData(@ScriptParameter(description="\u8868\u5355\u6570\u636e")
 Map<String,Object> formData)

重置当前流程表单数据

Parameters:

formData - 表单数据

getCreatedOperator

@ScriptFunction(name="getCreatedOperator",
                description="\u83b7\u53d6\u6d41\u7a0b\u521b\u5efa\u4eba\u4fe1\u606f")
public IFlowOperator getCreatedOperator()

getCurrentOperator

@ScriptFunction(name="getCurrentOperator",
                description="\u83b7\u53d6\u5f53\u524d\u5ba1\u6279\u4eba\u4fe1\u606f")
public IFlowOperator getCurrentOperator()

getSubmitOperator

@ScriptFunction(name="getSubmitOperator",
                description="\u83b7\u53d6\u6d41\u7a0b\u5ba1\u6279\u8005\u4fe1\u606f")
public IFlowOperator getSubmitOperator()

getNode

@ScriptFunction(name="getNode",
                description="\u83b7\u53d6\u6d41\u7a0b\u8282\u70b9\u4fe1\u606f")
public IFlowNode getNode(@ScriptParameter(description="\u6d41\u7a0b\u8282\u70b9Id")
 String nodeId)

获取节点信息

Parameters:

nodeId - 节点id

Returns:

节点

isFlowManager

@ScriptFunction(name="isFlowManager",
                description="\u5f53\u524d\u7528\u6237\u662f\u5426\u4e3a\u6d41\u7a0b\u7ba1\u7406\u5458")
public boolean isFlowManager()

是否流程管理员

getCurrentNode

@ScriptFunction(name="getCurrentNode",
                description="\u83b7\u53d6\u5f53\u524d\u8282\u70b9\u5bf9\u8c61")
public IFlowNode getCurrentNode()

获取当前节点对象

findPreviousNodeOperatorIds

@ScriptFunction(name="findPreviousNodeOperatorIds",
                description="\u83b7\u53d6\u4e0a\u4e00\u8282\u70b9\u7684\u5ba1\u6279\u4eba\u5458Id\u5217\u8868")
public List<Long> findPreviousNodeOperatorIds()

获取上一节点的审批人员Id列表。

由 FlowSession.loadPreviousNodeOperatorIds() 提供能力，此处仅做透传。 适用于后续节点需要复用前序节点审批人的场景，例如：

 def run(request){
     return request.findPreviousNodeOperatorIds()
 }
 

Returns:

上一节点的审批人员Id列表，无法确定时返回空列表

getCurrentAction

@ScriptFunction(name="getCurrentAction",
                description="\u83b7\u53d6\u5f53\u524d\u64cd\u4f5c\u5bf9\u8c61")
public IFlowAction getCurrentAction()

获取当前操作对象

isMock

@ScriptFunction(name="isMock",
                description="\u662f\u5426\u6a21\u62df\u6d4b\u8bd5")
public boolean isMock()

是否模拟测试

getCreatedOperatorId

@ScriptFunction(name="getCreatedOperatorId",
                description="\u83b7\u53d6\u6d41\u7a0b\u521b\u5efa\u8005Id")
public long getCreatedOperatorId()

流程创建者Id

getCreatedOperatorName

@ScriptFunction(name="getCreatedOperatorName",
                description="\u83b7\u53d6\u6d41\u7a0b\u521b\u5efa\u8005\u540d\u79f0")
public String getCreatedOperatorName()

流程创建者名称

getCurrentOperatorId

@ScriptFunction(name="getCurrentOperatorId",
                description="\u83b7\u53d6\u6d41\u7a0b\u5ba1\u6279\u8005Id")
public long getCurrentOperatorId()

流程审批者Id

getCurrentOperatorName

@ScriptFunction(name="getCurrentOperatorName",
                description="\u83b7\u53d6\u6d41\u7a0b\u5ba1\u6279\u8005\u540d\u79f0")
public String getCurrentOperatorName()

流程审批者名称

getSubmitOperatorId

@ScriptFunction(name="getSubmitOperatorId",
                description="\u83b7\u53d6\u6d41\u7a0b\u5ba1\u6279\u8005Id")
public long getSubmitOperatorId()

流程审批者Id

getSubmitOperatorName

@ScriptFunction(name="getSubmitOperatorName",
                description="\u6d41\u7a0b\u5ba1\u6279\u8005\u540d\u79f0")
public String getSubmitOperatorName()

流程审批者名称

getStartNode

@ScriptFunction(name="getStartNode",
                description="\u83b7\u53d6\u5f00\u59cb\u8282\u70b9")
public IFlowNode getStartNode()

获取开始节点

Returns:

开始节点

toCreateRequest

@ScriptFunction(name="toCreateRequest",
                description="\u8f6c\u6362\u4e3a\u5f53\u524d\u6d41\u7a0b\u7684\u8bf7\u6c42\u5bf9\u8c61")
public FlowCreateRequest toCreateRequest()

转换为当前流程的请求对象

Returns:

流程请求对象

toCreateRequest

@ScriptFunction(name="toCreateRequest",
                description="\u521b\u5efa\u6d41\u7a0b\u8bf7\u6c42\uff0c\u7528\u4e8e\u81ea\u6d41\u7a0b\u7684\u521b\u5efa")
public FlowCreateRequest toCreateRequest(@ScriptParameter(description="\u6d41\u7a0bworkCode")
 String workCode,
 @ScriptParameter(description="\u6d41\u7a0b\u53d1\u8d77\u4ebaid")
 long operatorId,
 @ScriptParameter(description="\u6d41\u7a0b\u52a8\u4f5cactionId")
 String actionId,
 @ScriptParameter(description="\u6d41\u7a0b\u6570\u636eformData\uff08JSON\u683c\u5f0f\uff09")
 String formData)

创建流程请求，用于自流程的创建

Parameters:

workCode - 流程设计流程workCode

operatorId - 流程发起人id

actionId - 动作类型

formData - 流程数据

toCreateRequest

@ScriptFunction(name="toCreateRequest",
                description="\u521b\u5efa\u6d41\u7a0b\u8bf7\u6c42\uff0c\u7528\u4e8e\u81ea\u6d41\u7a0b\u7684\u521b\u5efa\uff08\u652f\u6301\u624b\u52a8\u4f20\u5165\u6d41\u7a0b\u6807\u9898\uff09")
public FlowCreateRequest toCreateRequest(@ScriptParameter(description="\u6d41\u7a0bworkCode")
 String workCode,
 @ScriptParameter(description="\u6d41\u7a0b\u53d1\u8d77\u4ebaid")
 long operatorId,
 @ScriptParameter(description="\u6d41\u7a0b\u52a8\u4f5cactionId")
 String actionId,
 @ScriptParameter(description="\u6d41\u7a0b\u6570\u636eformData\uff08JSON\u683c\u5f0f\uff09")
 String formData,
 @ScriptParameter(description="\u6d41\u7a0b\u6807\u9898workTitle\uff08\u53ef\u4e3a\u7a7a\uff09")
 String workTitle)

创建流程请求，用于自流程的创建（支持手动传入流程标题）

Parameters:

workCode - 流程设计流程workCode

operatorId - 流程发起人id

actionId - 动作类型

formData - 流程数据

workTitle - 手动传入的流程标题；为空时回落流程定义标题

toCreateRequest

@ScriptFunction(name="toCreateRequest",
                description="\u521b\u5efa\u6d41\u7a0b\u8bf7\u6c42\uff0c\u7528\u4e8e\u81ea\u6d41\u7a0b\u7684\u521b\u5efa")
public FlowCreateRequest toCreateRequest(@ScriptParameter(description="\u6d41\u7a0bworkCode")
 String workCode,
 @ScriptParameter(description="\u6d41\u7a0b\u53d1\u8d77\u4ebaid")
 long operatorId,
 @ScriptParameter(description="\u6d41\u7a0b\u52a8\u4f5cactionId")
 String actionId,
 @ScriptParameter(description="\u6d41\u7a0b\u6570\u636eformData\uff08Map<String,Object>\u683c\u5f0f\uff09")
 Map<String,Object> formData)

创建流程请求，用于自流程的创建

Parameters:

workCode - 流程设计流程workCode

operatorId - 流程发起人id

actionId - 动作类型

formData - 流程数据

toCreateRequest

@ScriptFunction(name="toCreateRequest",
                description="\u521b\u5efa\u6d41\u7a0b\u8bf7\u6c42\uff0c\u7528\u4e8e\u81ea\u6d41\u7a0b\u7684\u521b\u5efa\uff08\u652f\u6301\u624b\u52a8\u4f20\u5165\u6d41\u7a0b\u6807\u9898\uff09")
public FlowCreateRequest toCreateRequest(@ScriptParameter(description="\u6d41\u7a0bworkCode")
 String workCode,
 @ScriptParameter(description="\u6d41\u7a0b\u53d1\u8d77\u4ebaid")
 long operatorId,
 @ScriptParameter(description="\u6d41\u7a0b\u52a8\u4f5cactionId")
 String actionId,
 @ScriptParameter(description="\u6d41\u7a0b\u6570\u636eformData\uff08Map<String,Object>\u683c\u5f0f\uff09")
 Map<String,Object> formData,
 @ScriptParameter(description="\u6d41\u7a0b\u6807\u9898workTitle\uff08\u53ef\u4e3a\u7a7a\uff09")
 String workTitle)

创建流程请求，用于自流程的创建（支持手动传入流程标题）

Parameters:

workCode - 流程设计流程workCode

operatorId - 流程发起人id

actionId - 动作类型

formData - 流程数据

workTitle - 手动传入的流程标题；为空时回落流程定义标题

getFormData

@ScriptFunction(name="getFormData",
                description="\u83b7\u53d6\u8868\u5355\u5b57\u6bb5\u503c")
public Object getFormData(@ScriptParameter(description="\u8868\u5355\u5b57\u6bb5\u7f16\u7801")
 String fieldCode)

获取表单字段值（Groovy脚本调用）

Parameters:

fieldCode - 字段Code

Returns:

字段值

getSubFormData

@ScriptFunction(name="getSubFormData",
                description="\u83b7\u53d6\u5b50\u8868\u5355\u7684\u6570\u636e\uff0c\u8fd4\u56delist\u683c\u5f0f\u6570\u636e")
public List<Map<String,Object>> getSubFormData(@ScriptParameter(description="\u5b57\u8868\u7f16\u7801")
 String subFormCode)

获取子表单的数据

Parameters:

subFormCode - 子表单code

Returns:

子表单数据列表

findSubProcessRecords

@ScriptFunction(name="findSubProcessRecords",
                description="\u67e5\u8be2\u6307\u5b9a\u5b50\u6d41\u7a0b\u8282\u70b9\u5df2\u7ecf\u7ed3\u675f\u7684\u6700\u7ec8\u8bb0\u5f55")
public List<FlowRecord> findSubProcessRecords(@ScriptParameter(description="\u5b50\u6d41\u7a0b\u8282\u70b9Id")
 String subProcessNodeId)

查询指定子流程节点已经结束的最终记录。

getSubProcessTotal

@ScriptFunction(name="getSubProcessTotal",
                description="\u83b7\u53d6\u672c\u6b21\u5b50\u6d41\u7a0b\u8282\u70b9\u521b\u5efa\u7684\u5b9e\u4f8b\u603b\u6570")
public int getSubProcessTotal()

获取本次子流程节点创建的实例总数。

getCurrentSubProcessRecord

@ScriptFunction(name="getCurrentSubProcessRecord",
                description="\u83b7\u53d6\u672c\u6b21\u521a\u7ed3\u675f\u7684\u5b50\u6d41\u7a0b\u6700\u7ec8\u8bb0\u5f55")
public FlowRecord getCurrentSubProcessRecord()

获取本次刚结束的子流程最终记录。