OsmEntity (Bropen Framework 4.8.1 API)

bropen.framework.core.osm.OsmEntity

All Implemented Interfaces and Traits:

DomainTrait, java.io.Serializable
```
class OsmEntity
extends Object
```
实体与员工/用户的关联表
通常配合标签 o:osmEntities、注解 OsmEntities 使用，将文档与机构、岗位等关联后，自动计算出关联用户，提供更好的配置体验与计算性能。

Field Summary

Fields
Modifiers	Name	Description
`static String`	`TYPE_GRP`
`static String`	`TYPE_GRP_CODE`
`static String`	`TYPE_LVL`
`static String`	`TYPE_ORG`
`static String`	`TYPE_ORG_CHILDREN`
`static String`	`TYPE_ORG_SELF`
`static String`	`TYPE_POS`
`static String`	`TYPE_POS_CODE`
`static String`	`TYPE_POS_CODE_ORGSELF`
`static String`	`TYPE_ROL`
`static String`	`TYPE_ROL_CODE`
`static String`	`TYPE_USR`	实体关联类型
`static String`	`TYPE_USR_NAME`

Properties Summary

Properties
Type	Name and description
`static Object`	`constraints`
`String`	`dataClass` 所属 Domain 类
`Long`	`dataId` 所属 Domain 实例 ID
`Date`	`dateCreated` 插入时间
`String`	`eiIds` 以分号分隔的身份ID列表：如果不是通过机构、岗位、身份级别授权的，则为 null *
`String`	`fieldName` 属性名
`static Object`	`mapping`
`Long`	`userId` 用户ID

Methods Summary

Methods
Type	Name and description
`Object`	`beforeValidate()`
`static String`	`convertList(List entities)` 将列表格式的 OSM 实体转成最终使用的 JSON 字符串
`static String`	`convertMap(Map entities)` 将 Map 格式的 OSM 实体转成最终使用的 JSON 字符串
`static void`	`delete(String dataClass, Long dataId)` 删除
`static void`	`delete(String dataClass, List<Long> dataIds, List<String> fieldNames = null)` 批量删除
`static void`	`delete(String dataClass)` 批量删除
`static Boolean`	`exists(String dataClass, Long dataId, String fieldName, Long userId)`
`static Boolean`	`exists(String dataClass, List<Long> dataIds, String fieldName, Long userId)`
`static Boolean`	`exists(Object bean, String fieldName, Long userId)`
`static Boolean`	`exists(String dataClass, Object dataIds, Object fieldNames, Object userIds)` 根据数据类、ID[列表]、字段名[列表]、用户ID[列表] 判断是否存在。
`static List<Long>`	`getDataIds(String dataClass, Long userId, String fieldName)` 获得数据的 ID 列表
`static String`	`getDataIdsHql(String dataClass, Long userId, String fieldName)` 获得数据 ID 列表的 hql，可用于拼接子查询条件
`static List<Long>`	`getUserIds(String dataClass, Long dataId, String fieldName)` 获取用户id列表
`static List<Long>`	`getUserIds(Object bean, String fieldName)`
`static List<String>`	`parseUuids(List<String> uuids, String osmEntity)`
`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 String TYPE_GRP
  - public static final String TYPE_GRP_CODE
  - public static final String TYPE_LVL
  - public static final String TYPE_ORG
  - public static final String TYPE_ORG_CHILDREN
  - public static final String TYPE_ORG_SELF
  - public static final String TYPE_POS
  - public static final String TYPE_POS_CODE
  - public static final String TYPE_POS_CODE_ORGSELF
  - public static final String TYPE_ROL
  - public static final String TYPE_ROL_CODE
  - public static final String TYPE_USR
    
    实体关联类型
    详细说明可参考 bropen.framework.core.security.RoleEntity 中的同名常量。
  - public static final String TYPE_USR_NAME
- Property Detail
  - static Object constraints
  - String dataClass
    
    所属 Domain 类
  - Long dataId
    
    所属 Domain 实例 ID
  - Date dateCreated
    
    插入时间
  - String eiIds
    
    以分号分隔的身份ID列表：如果不是通过机构、岗位、身份级别授权的，则为 null *
  - String fieldName
    
    属性名
  - static Object mapping
  - Long userId
    
    用户ID
- Method Detail
  - Object beforeValidate()
  - @CompileStatic static String convertList(List entities)
    
    将列表格式的 OSM 实体转成最终使用的 JSON 字符串
    Returns:
    返回和标签 o:osmEntities 格式一致的 JSON 字符串
    Parameters:
    entities - 员工（会自动转成用户）、用户、机构、岗位、群组、用户ID等对象列表
  - @CompileStatic static String convertMap(Map entities)
    
    将 Map 格式的 OSM 实体转成最终使用的 JSON 字符串
    Returns:
    返回和标签 o:osmEntities 格式一致的 JSON 字符串
    Parameters:
    entities - 形如：[included: [[type: OsmEntity.TYPE_XX, value: xxx], 机构对象，员工对象, ....], excluded: [...]]
  - @CompileStatic static void delete(String dataClass, Long dataId)
    
    删除
  - @CompileStatic static void delete(String dataClass, List<Long> dataIds, List<String> fieldNames = null)
    
    批量删除
  - @CompileStatic static void delete(String dataClass)
    
    批量删除
  - @CompileStatic static Boolean exists(String dataClass, Long dataId, String fieldName, Long userId)
  - @CompileStatic static Boolean exists(String dataClass, List<Long> dataIds, String fieldName, Long userId)
  - @CompileStatic static Boolean exists(Object bean, String fieldName, Long userId)
  - @CompileStatic static Boolean exists(String dataClass, Object dataIds, Object fieldNames, Object userIds)
    
    根据数据类、ID[列表]、字段名[列表]、用户ID[列表] 判断是否存在。
    Returns:
    Parameters:
    dataClass - 实体的类名
    dataIds - 实体对象的 ID 或 ID 列表
    fieldNames - 字段名称或名称列表
    userIds - 用户ID 或 ID 列表
  - @CompileStatic static List<Long> getDataIds(String dataClass, Long userId, String fieldName)
    
    获得数据的 ID 列表
  - @CompileStatic static String getDataIdsHql(String dataClass, Long userId, String fieldName)
    
    获得数据 ID 列表的 hql，可用于拼接子查询条件
  - @CompileStatic static List<Long> getUserIds(String dataClass, Long dataId, String fieldName)
    
    获取用户id列表
  - @CompileStatic static List<Long> getUserIds(Object bean, String fieldName)
  - @Internal@bropen.toolkit.annotation.Internal @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List<String> parseUuids(List<String> uuids, String osmEntity)
  - String toString()

| Detail:
Field
Property
Constructor
Method

BROPEN Documentation, 2020-04-21 11:00

[Groovy] Class OsmEntity

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String TYPE_GRP

public static final String TYPE_GRP_CODE

public static final String TYPE_LVL

public static final String TYPE_ORG

public static final String TYPE_ORG_CHILDREN

public static final String TYPE_ORG_SELF

public static final String TYPE_POS

public static final String TYPE_POS_CODE

public static final String TYPE_POS_CODE_ORGSELF

public static final String TYPE_ROL

public static final String TYPE_ROL_CODE

public static final String TYPE_USR

public static final String TYPE_USR_NAME

Property Detail

static Object constraints

String dataClass

Long dataId

Date dateCreated

String eiIds

String fieldName

static Object mapping

Long userId

Method Detail

Object beforeValidate()

@CompileStatic static String convertList(List entities)

@CompileStatic static String convertMap(Map entities)

@CompileStatic static void delete(String dataClass, Long dataId)

@CompileStatic static void delete(String dataClass, List<Long> dataIds, List<String> fieldNames = null)

@CompileStatic static void delete(String dataClass)

@CompileStatic static Boolean exists(String dataClass, Long dataId, String fieldName, Long userId)

@CompileStatic static Boolean exists(String dataClass, List<Long> dataIds, String fieldName, Long userId)

@CompileStatic static Boolean exists(Object bean, String fieldName, Long userId)

@CompileStatic static Boolean exists(String dataClass, Object dataIds, Object fieldNames, Object userIds)

@CompileStatic static List<Long> getDataIds(String dataClass, Long userId, String fieldName)

@CompileStatic static String getDataIdsHql(String dataClass, Long userId, String fieldName)

@CompileStatic static List<Long> getUserIds(String dataClass, Long dataId, String fieldName)

@CompileStatic static List<Long> getUserIds(Object bean, String fieldName)

@Internal@bropen.toolkit.annotation.Internal @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List<String> parseUuids(List<String> uuids, String osmEntity)

String toString()