ProcessInstance (Bropen Bpm 4.8.1 API)

bropen.bpm.instance.ProcessInstance

流程实例

Field Summary

Fields
Modifiers	Name	Description
`static Integer`	`COMPLETE_REASON_BYADMIN`
`static Integer`	`COMPLETE_REASON_BYSUPV`
`static Integer`	`COMPLETE_REASON_DELETECHILDREN`
`static Integer`	`COMPLETE_REASON_EXPIRED`
`static Integer`	`COMPLETE_REASON_REJECTED`
`static Integer`	`COMPLETE_REASON_TIMEOUT`
`static Integer`	`PRIORITY_CRITICAL`
`static Integer`	`PRIORITY_NONURGENT`
`static Integer`	`PRIORITY_NORMAL`
`static Integer`	`PRIORITY_URGENT`
`static Integer`	`SECURITY_ONFIDENTIAL`
`static Integer`	`SECURITY_RESTRICTED`
`static Integer`	`SECURITY_SECRET`
`static Integer`	`SECURITY_TOPSECRET`
`static Integer`	`SECURITY_UNCLASSIFIED`
`static Integer`	`STATE_CANCELED`
`static Integer`	`STATE_COMPLETED`
`static Integer`	`STATE_DRAFT`
`static String`	`STATE_NAME_CANCELED`
`static String`	`STATE_NAME_COMPLETED`
`static String`	`STATE_NAME_DRAFT`
`static String`	`STATE_NAME_PROCESSING`
`static String`	`STATE_NAME_TEMP`	默认的状态名称i18n后缀
`static String`	`STATE_NAME_TERMINATED`
`static Integer`	`STATE_PROCESSING`
`static Integer`	`STATE_TEMP`	流程状态
`static Integer`	`STATE_TERMINATED`
`static Long`	`SUBDOCID_NULL`	引入子流程关联文档未创建时的临时文档ID
`protected Object`	`_doc`
`protected Process`	`_proc`

Properties Summary

Properties
Type	Name and description
`String`	`actorsName` 当前办理人
`bropen.framework.core.domain.DomainApplication`	`application` 所属应用
`Long`	`bizId` 所属业务定义的ID
`Set<ProcessInstance>`	`children` 子流程实例
`Integer`	`completeReason` 流程结束原因
`Date`	`completeTime` 流程结束时间
`static Object`	`constraints`
`Date`	`createTime` 流程开始时间
`String`	`definitionName` 文种：业务定义名称
`String`	`docClass` 关联文档的Class
`String`	`docController` 关联文档的Contoller
`Long`	`docId` 关联文档的ID
`String`	`docNumber` 关联文档的编号：最长不超过32个字符
`EmulateProcess`	`emulateProcess` 仿真流程
`String`	`endEventId` 结束事件的Id
`String`	`entry` 流程定义路径（x.y.z.Foobar）
`String`	`ext1` 扩展分类属性：可以用于任务列表等。
`String`	`ext2`
`static Object`	`hasMany`
`bropen.framework.core.osm.Employee`	`initiator` 原始起草人：如果要获得起草人，使用方法 drafter()
`String`	`initiatorActual` 实际起草人名称：流程可能是由代为起草的，这里记录实际拟稿人的名称等信息
`String`	`initiatorName` 起草人名称
`bropen.framework.core.osm.Employee`	`initiatorTransfered` 起草人移交后的接收人
`Date`	`lastUpdated` 时间戳：更新
`static Map`	`listFields`
`static Object`	`mappedBy`
`static Object`	`mapping`
`String`	`nodesName` 当前办理人列表：actors
`String`	`organizationFullName` 起草机构全名
`Long`	`organizationId` 起草机构
`ProcessInstance`	`parent` 所属父流程实例：冗余数据
`Task`	`parentTask` 子流程实例所属的任务实例，此任务实例关联所属的父流实例
`Integer`	`priority` 紧急程度/优先级
`String`	`processId` 流程定义的ID
`String`	`revision` 流程定义版本号
`Integer`	`security` 密级
`String`	`startEventId` 开始事件的Id
`Integer`	`state` 流程状态：STATE_*
`String`	`stateName` 流程状态名称：如果流程结束，则为结束事件（end-state）的名称
`Set<Task>`	`tasks` 任务实例列表
`String`	`title` 流程实例的标题
`static Object`	`transients`

Methods Summary

Methods
Type	Name and description
`Object`	`beforeInsert()`
`Object`	`beforeUpdate()`
`Object`	`beforeValidate()`
`static void`	`bootStrapInit()`
`static String`	`calTitle(Object doc)` 计算title
`Boolean`	`canceled()` 流程是否被撤销
`ProcessInstance`	`changeState(Integer to, Map options = [now: new Date()` 改变状态
`Boolean`	`completed()` 流程是否正常完成
`Object`	`data(Map options = [lock: false)`
`void`	`deleteTask(Task t, boolean recursive = false)` 删除一个任务
`Object`	`document(Map options = [lock: false)` 获得关联文档
`bropen.framework.core.osm.Employee`	`drafter()` 当前起草人，返回 initiatorTransfered 或 initiator
`bropen.framework.core.osm.EmployeeIdentity`	`drafterEI()` 当前起草人身份，不含已被禁用的身份。
`void`	`dummyTask(Task t)` 将任务转换成 DUMMY 任务（仅用于授权），如果用户有其他任务，则直接删除该任务
`Boolean`	`ended()` 流程是否结束
`Task`	`firstCompletedTask(bropen.framework.core.osm.Employee emp, Map options = [taskNode: null)` 获得员工的最近一个已完成的task
`Task`	`firstOtherTask(bropen.framework.core.osm.Employee emp, Map options = [taskNode: null)` 获得员工的第一个授权的（dummy或移交的）任务
`Task`	`firstTask(bropen.framework.core.osm.Employee emp, Map options = [preTask: null)` 获得员工的第一个需要办理的任务
`List<bropen.framework.core.osm.Employee>`	`getActors()` 只读属性：当前办理人列表
`static String`	`getDisplayCompleteReason(Integer completeReason, boolean isDefaultLang = false)`
`String`	`getDisplayDefinitionName()`
`static String`	`getDisplayDefinitionName(String definitionName)`
`String`	`getDisplayStateName()` 只读属性：国际化后的状态名称
`static String`	`getDisplayStateName(String stateName, Integer completeReason = null, boolean isDefaultLang = false)` 国际化后的状态名称
`List<bropen.framework.core.osm.Employee>`	`getReaders()` 只读属性：当前待阅人列表
`boolean`	`isCollapsedSubprocess()` 当前流程实例是否是引入子流程实例
`bropen.framework.core.security.Permission$Granted`	`isReader(bropen.framework.core.osm.Employee emp, Map options = null)` 判断员工是否有权限访问本流程实例
`boolean`	`isSubprocess()` 当前流程实例是否是子流程实例
`Object`	`onDelete()`
`List<Opinion>`	`opinions(bropen.framework.core.osm.Employee emp, Map criteria = [groupIds: null, Map options = [:])` 获得意见对象列表
`bropen.framework.core.osm.Organization`	`organization()` 起草机构
`Process`	`processDefinition()` 获得当前流程定义
`static List<Map>`	`processes()` 获得已加载的流程定义列表
`Object`	`sendToRead(Task task, Object sender, Object receiver, Map options = [nodeId: null)`
`Object`	`sendToread(Task task, Object sender, Object receiver, Map options = [nodeId: null)` 生成一个待阅
`Task`	`startNode()` 起草环节
`Task`	`startTask(Task taskNode = null)` 起草任务
`Boolean`	`terminated()` 流程是否被终止
`String`	`toString()` 流程实例标题

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`Object#wait(long, int), Object#wait(long), Object#wait(), Object#equals(Object), Object#toString(), Object#hashCode(), Object#getClass(), Object#notify(), Object#notifyAll()`

- Field Detail
  - public static final Integer COMPLETE_REASON_BYADMIN
  - public static final Integer COMPLETE_REASON_BYSUPV
  - public static final Integer COMPLETE_REASON_DELETECHILDREN
  - public static final Integer COMPLETE_REASON_EXPIRED
  - public static final Integer COMPLETE_REASON_REJECTED
  - public static final Integer COMPLETE_REASON_TIMEOUT
  - public static final Integer PRIORITY_CRITICAL
  - public static final Integer PRIORITY_NONURGENT
  - public static final Integer PRIORITY_NORMAL
  - public static final Integer PRIORITY_URGENT
  - public static final Integer SECURITY_ONFIDENTIAL
  - public static final Integer SECURITY_RESTRICTED
  - public static final Integer SECURITY_SECRET
  - public static final Integer SECURITY_TOPSECRET
  - public static final Integer SECURITY_UNCLASSIFIED
  - public static final Integer STATE_CANCELED
  - public static final Integer STATE_COMPLETED
  - public static final Integer STATE_DRAFT
  - public static final String STATE_NAME_CANCELED
  - public static final String STATE_NAME_COMPLETED
  - public static final String STATE_NAME_DRAFT
  - public static final String STATE_NAME_PROCESSING
  - public static final String STATE_NAME_TEMP
    
    默认的状态名称i18n后缀
  - public static final String STATE_NAME_TERMINATED
  - public static final Integer STATE_PROCESSING
  - public static final Integer STATE_TEMP
    
    流程状态
  - public static final Integer STATE_TERMINATED
  - public static final Long SUBDOCID_NULL
    
    引入子流程关联文档未创建时的临时文档ID
  - protected Object _doc
  - protected Process _proc
- Property Detail
  - String actorsName
    
    当前办理人
  - bropen.framework.core.domain.DomainApplication application
    
    所属应用
  - Long bizId
    
    所属业务定义的ID
  - Set<ProcessInstance> children
    
    子流程实例
  - Integer completeReason
    
    流程结束原因
  - Date completeTime
    
    流程结束时间
  - static Object constraints
  - Date createTime
    
    流程开始时间
  - String definitionName
    
    文种：业务定义名称
  - String docClass
    
    关联文档的Class
  - String docController
    
    关联文档的Contoller
  - Long docId
    
    关联文档的ID
  - String docNumber
    
    关联文档的编号：最长不超过32个字符
    属性值取自 Domain 的某个属性，配置在 application.yml(|.groovy) 的 bropen.bpm.process.docnumber.mapping
  - EmulateProcess emulateProcess
    
    仿真流程
  - String endEventId
    
    结束事件的Id
  - String entry
    
    流程定义路径（x.y.z.Foobar）
    唯一、不为空，默认情况下和文档类名相同
  - String ext1
    
    扩展分类属性：可以用于任务列表等。
    如在待办中根据项目名称进行分类。
    属性值取自Domain的某个属性，配置在 bropen.bpm.process.ext1.mapping。
  - String ext2
  - static Object hasMany
  - bropen.framework.core.osm.Employee initiator
    
    原始起草人：如果要获得起草人，使用方法 drafter()
  - String initiatorActual
    
    实际起草人名称：流程可能是由代为起草的，这里记录实际拟稿人的名称等信息
    属性值取自Domain的某个属性，配置在Config.groovy的 bropen.bpm.process.initiatorActual.mapping
  - String initiatorName
    
    起草人名称
  - bropen.framework.core.osm.Employee initiatorTransfered
    
    起草人移交后的接收人
  - Date lastUpdated
    
    时间戳：更新
  - static Map listFields
  - static Object mappedBy
  - static Object mapping
  - String nodesName
    
    当前办理人列表：actors
  - String organizationFullName
    
    起草机构全名
  - Long organizationId
    
    起草机构
    流程实例是子流程时：
    - 如果是forkgroup策略是只启动一个子流程实例，则organizationId与fromTask（提交到子流程的待办）的organizationId一致
    - 如果是forkgroup策略是每个办理人启动一个子流程实例，则organizationId为办理人身份所属的organizationId
  - ProcessInstance parent
    
    所属父流程实例：冗余数据
  - Task parentTask
    
    子流程实例所属的任务实例，此任务实例关联所属的父流实例
  - Integer priority
    
    紧急程度/优先级
    取值范围 1～9，由业务自己定，数字越大，级别越高；默认范围[0=无，5=一般、7=紧急、9=特急]
  - String processId
    
    流程定义的ID
  - String revision
    
    流程定义版本号
  - Integer security
    
    密级
    1～9，由业务自己定，数字越大，级别越高；默认范围[0=公开，1= 受限（内部）、5=秘密、7=机密、9=高密（绝密）]
  - String startEventId
    
    开始事件的Id
  - Integer state
    
    流程状态：STATE_*
  - String stateName
    
    流程状态名称：如果流程结束，则为结束事件（end-state）的名称
  - Set<Task> tasks
    
    任务实例列表
  - String title
    
    流程实例的标题
  - static Object transients
- Method Detail
  - Object beforeInsert()
  - Object beforeUpdate()
  - Object beforeValidate()
  - @CompileStatic static void bootStrapInit()
  - @CompileStatic static String calTitle(Object doc)
    
    计算title
    Returns:
    Parameters:
    doc - 文档实例
  - @CompileStatic Boolean canceled()
    
    流程是否被撤销
  - @CompileStatic ProcessInstance changeState(Integer to, Map options = [now: new Date()
    
    改变状态
    
    Returns:
    流程实例
    Parameters:
    to - 状态值，为 STATE_XXX 中的一种
    options.now - 改变为结束状态的时间，默认为当前时间。如果to为草稿或流转中，则本参数无效
    options.stateName - 状态名称，默认从流程定义或者 STATE_NAME_XXX 中取
    options.completeReason - 流程结束原因
  - @CompileStatic Boolean completed()
    
    流程是否正常完成
  - @Deprecated @CompileStatic Object data(Map options = [lock: false)
  - void deleteTask(Task t, boolean recursive = false)
    
    删除一个任务
    注意这本方法未更新流程状态，如需更新流程状态，则应该调用 processEngineService.deleteTask。
    
    Parameters:
    t - 要删除的任务
    recursive - 是否递归删除任务的后续任务，默认为否
  - @CompileStatic Object document(Map options = [lock: false)
    
    获得关联文档
    
    Parameters:
    options.lock - 是否取出来并lock住，默认为false
    options.relink - 如果docId为空，是否尝试重新计算出docId，默认为false
  - @CompileStatic bropen.framework.core.osm.Employee drafter()
    
    当前起草人，返回 initiatorTransfered 或 initiator
  - @CompileStatic bropen.framework.core.osm.EmployeeIdentity drafterEI()
    
    当前起草人身份，不含已被禁用的身份。
    如果身份或起草人都已被禁用或删除，则通过起草任务的移交人进行计算。
  - void dummyTask(Task t)
    
    将任务转换成 DUMMY 任务（仅用于授权），如果用户有其他任务，则直接删除该任务
    注意本方法未更新流程状态
    
    Parameters:
    t - 要转换或删除的任务
  - @CompileStatic Boolean ended()
    
    流程是否结束
  - Task firstCompletedTask(bropen.framework.core.osm.Employee emp, Map options = [taskNode: null)
    
    获得员工的最近一个已完成的task
    优先级：已办、草稿、已阅
    
    Parameters:
    emp - 员工
    options.taskNode - 任务的过滤条件：环节名
    options.taskGroupId - 任务的过滤条件：分组ID，默认为"*"，表明在任何分组均可。因为分组id为null时表示为主干，因此只好用*来代替所有。
  - Task firstOtherTask(bropen.framework.core.osm.Employee emp, Map options = [taskNode: null)
    
    获得员工的第一个授权的（dummy或移交的）任务
    
    Returns:
    Parameters:
    emp - 员工
    options.taskNode - 任务的过滤条件：环节名
    options.taskGroupId - 任务的过滤条件：分组ID，默认为"*"，表明在任何分组均可。因为分组id为null时表示为主干，因此只好用*来代替所有。
  - Task firstTask(bropen.framework.core.osm.Employee emp, Map options = [preTask: null)
    
    获得员工的第一个需要办理的任务
    优先级：草稿、待办、待阅
    
    Parameters:
    emp - 员工
    options.preTask - 如果不为空，则从该任务找它提交出去的新任务，而不是从整个流程实例的任务中去查找
    options.types - 任务类型列表，排在最前面的优先级高。默认为[Task.TYPE_DRAFT, Task.TYPE_TODO, Task.TYPE_TOREAD]
    options.taskNode - 任务的过滤条件：环节名
    options.subprocess - 是否可包含子流程待办，默认false
    options.taskGroupId - 任务的过滤条件：分组ID，默认为"*"，表明在任何分组均可。因为分组id为null时表示为主干，因此只好用*来代替所有。
  - List<bropen.framework.core.osm.Employee> getActors()
    
    只读属性：当前办理人列表
  - @CompileStatic static String getDisplayCompleteReason(Integer completeReason, boolean isDefaultLang = false)
  - @CompileStatic String getDisplayDefinitionName()
  - @CompileStatic static String getDisplayDefinitionName(String definitionName)
  - @CompileStatic String getDisplayStateName()
    
    只读属性：国际化后的状态名称
  - @CompileStatic static String getDisplayStateName(String stateName, Integer completeReason = null, boolean isDefaultLang = false)
    
    国际化后的状态名称
    Parameters:
    stateName - 状态名称
    completeReason - 流程结束原因
    isDefaultLang - true/false，true时是取系统默认语言的i18n的值；false且有请求则取请求的对应语言的值
  - List<bropen.framework.core.osm.Employee> getReaders()
    
    只读属性：当前待阅人列表
  - @CompileStatic boolean isCollapsedSubprocess()
    
    当前流程实例是否是引入子流程实例
  - bropen.framework.core.security.Permission$Granted isReader(bropen.framework.core.osm.Employee emp, Map options = null)
    
    判断员工是否有权限访问本流程实例
    
    Returns:
    如果没有权限，则返回0/null，否则返回非0的整数
    Parameters:
    emp - 员工
    options.referenceId
    options.referenceClass
    options.referenceBizId
  - @CompileStatic boolean isSubprocess()
    
    当前流程实例是否是子流程实例
  - Object onDelete()
  - List<Opinion> opinions(bropen.framework.core.osm.Employee emp, Map criteria = [groupIds: null, Map options = [:])
    
    获得意见对象列表
    
    Parameters:
    emp - 如果不为null，则会返回对应员工的未提交意见
    criteria - 其他可选参数，参考 service 中的同名方法
    options - 格式化参数Map，参考 service 中的同名方法
  - bropen.framework.core.osm.Organization organization()
    
    起草机构
  - @CompileStatic Process processDefinition()
    
    获得当前流程定义
  - @CompileStatic static List<Map> processes()
    
    获得已加载的流程定义列表
    retrun:
    形如 [clazz:xx, controller:xxx, name:xxx, disabled:true/false, revision:xxx, i18nCodePrefix:xxx] 的 Map 列表
  - @Deprecated Object sendToRead(Task task, Object sender, Object receiver, Map options = [nodeId: null)
  - Object sendToread(Task task, Object sender, Object receiver, Map options = [nodeId: null)
    
    生成一个待阅
    
    Parameters:
    options - 其他可选参数，参考 service 中的同名方法
  - @CompileStatic Task startNode()
    
    起草环节
    如果流程实例已创建，则返回起草的环节；否则返回null
    注：首环节可能有多个，这里的起草环节包含于首环节
  - @CompileStatic Task startTask(Task taskNode = null)
    
    起草任务
    
    Parameters:
    taskNode - 起草任务所在环节（针对有多个起草环节的流程）
  - @CompileStatic Boolean terminated()
    
    流程是否被终止
  - String toString()
    
    流程实例标题

| Detail:
Field
Property
Constructor
Method

BROPEN Documentation, 2020-04-21 11:24

[Groovy] Class ProcessInstance

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final Integer COMPLETE_REASON_BYADMIN

public static final Integer COMPLETE_REASON_BYSUPV

public static final Integer COMPLETE_REASON_DELETECHILDREN

public static final Integer COMPLETE_REASON_EXPIRED

public static final Integer COMPLETE_REASON_REJECTED

public static final Integer COMPLETE_REASON_TIMEOUT

public static final Integer PRIORITY_CRITICAL

public static final Integer PRIORITY_NONURGENT

public static final Integer PRIORITY_NORMAL

public static final Integer PRIORITY_URGENT

public static final Integer SECURITY_ONFIDENTIAL

public static final Integer SECURITY_RESTRICTED

public static final Integer SECURITY_SECRET

public static final Integer SECURITY_TOPSECRET

public static final Integer SECURITY_UNCLASSIFIED

public static final Integer STATE_CANCELED

public static final Integer STATE_COMPLETED

public static final Integer STATE_DRAFT

public static final String STATE_NAME_CANCELED

public static final String STATE_NAME_COMPLETED

public static final String STATE_NAME_DRAFT

public static final String STATE_NAME_PROCESSING

public static final String STATE_NAME_TEMP

public static final String STATE_NAME_TERMINATED

public static final Integer STATE_PROCESSING

public static final Integer STATE_TEMP

public static final Integer STATE_TERMINATED

public static final Long SUBDOCID_NULL

protected Object _doc

protected Process _proc

Property Detail

String actorsName

bropen.framework.core.domain.DomainApplication application

Long bizId

Set<ProcessInstance> children

Integer completeReason

Date completeTime

static Object constraints

Date createTime

String definitionName

String docClass

String docController

Long docId

String docNumber

EmulateProcess emulateProcess

String endEventId

String entry

String ext1

String ext2

static Object hasMany

bropen.framework.core.osm.Employee initiator

String initiatorActual

String initiatorName

bropen.framework.core.osm.Employee initiatorTransfered

Date lastUpdated

static Map listFields

static Object mappedBy

static Object mapping

String nodesName

String organizationFullName

Long organizationId

ProcessInstance parent

Task parentTask

Integer priority

String processId

String revision

Integer security

String startEventId

Integer state

String stateName

Set<Task> tasks

String title

static Object transients

Method Detail