Field Detail

• public static final String VIEW_PATH

• public static Object aliasOverridingOrder

Property Detail

• bropen.framework.core.biz.BizPermissionService bizPermissionService

• bropen.framework.core.OsmOrganizationService osmOrganizationService

Method Detail

• Integer countAllProcesses(Map params)

  取流程实例数量

• Integer countAllTasks(Map params)

  取任务数量

• @Deprecated Integer countDocuments(bropen.framework.core.osm.Employee emp, String docClass, Map params)

• Integer countDocuments(bropen.framework.core.osm.Employee emp, Long bizId, Map params)

  获取某流程实例的文档数量。参数同list

  Returns:

  实例的文档 ( DomainBean ) 数量

• Integer countProcesses(bropen.framework.core.osm.Employee emp, List<Long> bizIds, Map params, Boolean isExclude = false)

  获取有权限的流程实例数量。

  Returns:

  有权限的流程实例数量

  Parameters:

  emp - 员工对象

  bizIds - 文种对应的业务定义 ID 列表，为 null 时表示全部

  params -

  翻页、排序、查询（search.where）
     例1：[search.where: "pi... and pi.docNumber='xx'"]，其中 pi 表示流程实例
     例2：[order: "", sort: "asc"]，注意字段前缀，pi 表示流程实例

  isExclude - 是否排除 bizIds 中的文种。

• @Deprecated Object countWorks(bropen.framework.core.osm.Employee emp, String docClass, Object type, Map params = null, Boolean isCompleted = false)

• Object countWorks(bropen.framework.core.osm.Employee emp, List<Long> bizIds, Object type, Map params = null, Boolean isCompleted = false)

  任务表API，可用来取待办、待阅、已办、已阅的任务数量。参数同 listWorks

  Returns:

  任务数量。
  如果type参数为列表，则返回一个Map（如： [a:100, b:200, sum:300], 其中a和b为传入的type，sum为合计)；
  否则直接返回对应任务类型的任务数量。

• @Internal@bropen.toolkit.annotation.Internal List<Long> findBizIds(String docClass)

• @Internal@bropen.toolkit.annotation.Internal List<Long> getBizIds(List<String> docClasses)

• String getFormatedOpinions(bropen.framework.core.osm.Employee emp, ProcessInstance processInst, Map criteria = [:], Map options = [:])

  拼装格式化的流转意见（不含子流程）

  Returns:

  html字符串，表格形式，有css class为 bpm-opinions、bpm-opinions-table 等，可以自己用css进一步做控制。
  注意表格宽度默认为100%（在body.css中控制），因此当父表格比较宽的时候，意见表格也会被放大。
  如果是导出到word中使用，表格宽度和字体会变成自适应，需要添加css设置，例如：
  table.bpm-opinions-table { width: 100%; font-size: 10.5pt; }

  Parameters:

  processInst - 流程实例

  criteria - 查询条件

  criteria.groupIds - 分组ID列表/数组。null则显示所有流转意见，否则仅显示对应分组的意见（注意主干的分组ID为trunk）

  criteria.tags - 意见标签列表/数组。即仅显示对应标签的意见（如“总经理意见”）；null则显示所有。

  criteria.nodes - 环节列表/数组，即仅显示某些环节的意见；null则显示所有。

  criteria.subprocess - 是否显示子流程意见

  criteria.parentprocess - 是否显示父流程意见

  options - 格式化参数

  options.blank - 如何显示空意见，0/null=过滤掉空意见（不显示），1=空意见仅显示签名+时间，2=空意见显示空行和签名+时间，3=不论有无意见仅显示签名+时间

  options.override

  options.datetime - 如何显示时间格式，1（默认）=显示日期和时间，2=仅显示日期

  options.default - 当没有找到任何意见时显示的内容，如“无”

  options.signature - 如何显示签名，0（默认）=显示姓名（文字），10=显示手写签名图片（如果有的话）

  options.title - 是否显示员工头衔，0（默认）=不显示，1=显示

  options.order

  options.organization - 如何显示办理人的机构信息，0（默认）=不显示，1=显示最低一级名称，2=显示不包括根机构名称的机构全名，3=显示完整的机构全名

  options.htmlFormater - 自定义的格式化闭包，用来代替下面的table下的tr生成代码，该闭包可接收一个Map（其内容大多为格式化的html字符串）和一个StringBuilder、输出tr/td等html内容。 [opinion: 意见Bean, status, content, signature, signatureURL, time, organization, title]

  options.formater - 自定义的格式化闭包，用来完全自定义输出（比如Word套打时，输出到XML中，需要去掉多余的HTML标签），会覆盖htmlFormater。 该闭包接收参数( List

  See Also:

  getOpinions

  getOpinions

• String getFormattedProcessLog(ProcessInstance processInst, Object criteria = [groupIds: null])

  拼装格式化的流程日志（不含子流程）

  Returns:

  html字符串

  Parameters:

  processInst - 流程实例

  criteria.groupIds - 分组ID列表/数组。null则显示所有，否则仅显示对应分组（注意主干的分组ID为trunk）

• String getFormattedReadLog(ProcessInstance processInst, Object criteria = [groupIds: null])

  拼装格式化的阅文日志（不含子流程）

  Returns:

  html字符串

  Parameters:

  processInst - 流程实例

  criteria.groupIds - 分组ID列表/数组。null则显示所有，否则仅显示对应分组（注意主干的分组ID为trunk）

• List<Opinion> getOpinions(bropen.framework.core.osm.Employee emp, ProcessInstance pi, Map criteria = [:], Map options = [:])

  获得意见对象列表（不含子流程）

  Parameters:

  emp - 如果不为空，则会返回对应员工的未提交意见，且只返回对应员工有权(意见属性readerType)查看的意见；有流程实例全局阅读权限的不限，但也只返回已提交的意见

  pi - 流程实例对象，不允许为空，否则返回null

  criteria - 查询条件

  criteria.groupIds - 分组ID列表/数组。默认为null，即显示所有流转意见，否则仅显示对应分组的意见（注意主干的分组ID为trunk）

  criteria.tags - 意见标签列表/数组。即仅显示对应标签的意见（如“总经理意见”）；默认为null，显示所有。

  criteria.nodes - 环节名称列表/数组，即仅显示某些环节的意见；默认为null，显示所有。

  criteria.subprocess - 是否显示子流程意见

  criteria.parentprocess - 是否显示父流程意见

  options - 格式化参数

  options.blank - 如何显示空意见，0/null=过滤掉空意见，其他则都返回

  options.override - 如何显示同一个环节的重复意见，默认显示所有，1=同一个分组、同一个环节、同一个用户、同一个意见标签中只显示新的

  options.order - 排序方式，0（默认）=按时间逆序、1=按时间顺序、10=按时间逆序+同一机构的放在一起(适用于多部门会签)、11=按时间顺序+同一机构的放在一起，自定义的排序闭包(接收一个或两个意见Bean参数)

• Map<String, List<Task>> getProcessLogTaskGroups(ProcessInstance processInst, Object criteria = [groupIds: null])

  获得流程日志需要的任务信息（不含子流程）。

  Returns:

  按照任务的groupId分组成Map，每个value为按照创建时间（createTime）顺序排列的任务列表.

  Parameters:

  processInst - 流程实例

  criteria.groupIds - 分组ID列表/数组

• Map<String, List<Task>> getReadLogTaskGroups(ProcessInstance processInst, Object criteria = [groupIds: null])

  获得阅文日志需要的任务信息（不含子流程）。

  Returns:

  按照任务的groupId分组成Map，每个value为按照创建时间（createTime）顺序排列的任务列表.

  Parameters:

  processInst - 流程实例

  criteria.groupIds - 分组ID列表/数组。

• @Internal@bropen.toolkit.annotation.Internal String godEditLink(Task task, String color)

  生成一个在开发开发环境下，直接切换用户并打开待办、待阅任务的链接 HTML 代码

  直接显示在提交成功的表单上，以加快调试速度。

  Returns:

  链接的 HTML 代码：<a href=....>张三</a>

  Parameters:

  task - 任务

  color - 字体颜色

• List<ProcessInstance> listAllProcesses(Map params)

  取流程实例列表

  Returns:

  流程实例列表

  Parameters:

  params - 翻页、排序、查询（search.where）等参数Map

• List<Task> listAllTasks(Map params)

  取任务列表

  Returns:

  所有任务列表

  Parameters:

  params - 翻页、排序、查询（search.where）等参数Map

• @Deprecated List listDocuments(bropen.framework.core.osm.Employee emp, String docClass, Map params)

• List listDocuments(bropen.framework.core.osm.Employee emp, Long bizId, Map params)

  获取某流程的文档或流程实例列表

  Returns:

  如果 params.grouped 为 true，则返回 [bean, groupId, groupName] 的列表，否则返回文档列表、或 params.search.select 指定的列表。
  注意：返回时，params 里会额外保存一个 listHql 的临时参数，以供 count 使用，如果需要同时获得其他的列表，再次调用前需清空。

  Parameters:

  emp - 员工，如果为 null，则取所有

  bizId - 文种对应的业务定义 ID

  params -

  翻页、排序、查询（search.where、search.from、search.select）、是否返回分组等参数，以便支持更复杂的查询
     例1：[search.where: "pi... and d.name='xx'"]，其中 pi 表示流程实例、d 表示文档，t 表示任务
     例2：[search.from: "left outer join d.members m", search.where: "m.name='xx'"]，其中from会拼在“select...from..d ”语句后
     例3：[grouped: true]，会使参数 search.select 无效，根据文档、任务分组ID对返回结果分组
     例4：[search.select: 'd.name and pi.title']，注意其中不能包含t
     例5：[search.select: 'pi']，返回流程实例列表

• List<ProcessInstance> listProcesses(List beanList, bropen.framework.core.osm.Employee emp = null, Map params = null)

  获取特定的流程实例列表（多用于和本 listDocuments 方法一起使用）

  Returns:

  特定的流程实例列表

  Parameters:

  beanList - 某流程实例的文档列表

  emp - 员工对象

  params - 可包含参数 subProcessId （子流程节点ID），用于获取子流程实例

• List<ProcessInstance> listProcesses(bropen.framework.core.osm.Employee emp, List<Long> bizIds, Map params, Boolean isExclude = false)

  获取有权限的流程实例列表，不限流程。

  注：只有当 bizIds.size()==1 时才支持通过流程权限资源 R 中配置的扩展接口鉴权

  Returns:

  有权限的流程实例列表

  Parameters:

  emp - 员工对象

  bizIds - 文种对应的业务定义 ID 列表，为 null 时表示全部

  params -

  翻页、排序、查询（search.where）
     例1：[search.where: "pi... and pi.docNumber='xx'"]，其中 pi 表示流程实例
     例2：[order: "", sort: "asc"]，注意字段前缀，pi 表示流程实例

  isExclude - 是否排除 bizIds 中的文种。

• @Internal@bropen.toolkit.annotation.Internal List<Long> listWorkBizIds(bropen.framework.core.osm.Employee emp, Integer type, Boolean isCompleted)

• @Deprecated List listWorks(bropen.framework.core.osm.Employee emp, String docClass, Object type, Map params, Boolean isCompleted = false)

• List listWorks(bropen.framework.core.osm.Employee emp, List<Long> bizIds, Object type, Map params, Boolean isCompleted = false)

  任务表API，可用来取待办、待阅、已办、已阅的任务列表

  Returns:

  任务列表或 params.search.select 指定的列表 < br > 注意：返回时，params 里会额外保存一个 listHql 的临时参数，以供 count 使用，如果需要同时获得其他的列表，再次调用前需清空。

  Parameters:

  emp - 员工对象

  bizIds - 文种对应的业务定义 ID 列表，如果为空则表示所有

  type - 任务类型，可以为列表，比如同时查询待办、草稿

  params -

  翻页、排序、查询（search.where、search.select）、是否缓存（cache）等
     例1：[search.where: "t... and d.name='xx'"]，其中 pi 表示流程实例、t 表示任务，d 表示文档（需要docClass参数）
     例2：[search.from: "left outer join d.members m", search.where: "m.name='xx'"]，其中from会拼在“select...from..d ”语句后，且仅当docClass为一个文种时有效
     例3：[order: "", sort: "asc"]，注意字段前缀，d 表示文档，t 表示Task
     例4：[document: true]，如果 type 为待办、isCompleted 为真，则返回按文档分类（一个文档只显示一条）的已办列表

  isCompleted - 是否仅查询结束了的任务。如类型为待办＋本参数为true，即查询已办