DataDict (Bropen Framework 4.8.1 API)

bropen.framework.core.datadict.DataDict

All Implemented Interfaces and Traits:

DomainTrait, java.io.Serializable
```
@Commons@groovy.util.logging.Commons
class DataDict
extends Object
```
数据字典

Field Summary

Fields
Modifiers	Name	Description
`static List<String>`	`PERMISSION_CODE_SUFFIXES`

Properties Summary

Properties
Type	Name and description
`static Integer`	`TYPE_ATT`
`static Integer`	`TYPE_BOOL`
`static Integer`	`TYPE_DATE`
`static Integer`	`TYPE_DATETIME`
`static Integer`	`TYPE_DECIMAL`
`static Integer`	`TYPE_EI`
`static Integer`	`TYPE_EMP`
`static Integer`	`TYPE_IMG`
`static Integer`	`TYPE_INTEGER`
`static Integer`	`TYPE_ORG`
`static Integer`	`TYPE_STRING`
`String`	`code` 数据字典代码 - 被程序引用的标识符
`static Object`	`constraints`
`String`	`createdBy`
`Date`	`dateCreated` 时间戳...
`Boolean`	`disabled` 禁用
`String`	`ext1` 　扩展属性
`String`	`ext2`
`String`	`extName1` 扩展属性名称
`String`	`extName10`
`String`	`extName2`
`String`	`extName3`
`String`	`extName4`
`String`	`extName5`
`String`	`extName6`
`String`	`extName7`
`String`	`extName8`
`String`	`extName9`
`Integer`	`extType1` 扩展属性类型，同 type
`Integer`	`extType10`
`Integer`	`extType2`
`Integer`	`extType3`
`Integer`	`extType4`
`Integer`	`extType5`
`Integer`	`extType6`
`Integer`	`extType7`
`Integer`	`extType8`
`Integer`	`extType9`
`String`	`group` 数据字典的分组名称，便于维护管理
`Boolean`	`hierarchical` 是否分层
`Date`	`lastUpdated`
`static Map`	`listFields`
`static Object`	`mapping`
`String`	`name` 数据字典名称
`String`	`notes` 维护说明
`static Object`	`transients`
`String`	`updatedBy`
`Boolean`	`valKey` 是否需要值代码
`String`	`valKeyName` 值代码的显示名
`String`	`valName` 数据值的显示名
`Integer`	`valType` 数据类型

Methods Summary

Methods
Type	Name and description
`static void`	`bootStrapInit()` 初始化权限
`static void`	`clearData(String dictCode)` 删除数据字典下所有数据
`static Integer`	`countData(String dictCode)` 根据数据字典代码，计算数据对象的数量
`static DataDictData`	`createData(Object dict, Object val, String key = null, Map props = null)` 创建一条数据
`static DataDictData`	`createData(Object dict, Object val, Map props)` 创建一条数据
`static DataDict`	`createDict(String name, String code, Map props = null)` 创建一种数据字典
`static DataDict`	`createDict(String name, String code, String stype, Map props = null)` @Deprecated
`static DataDict`	`createDictIfNotExists(String name, String code, Map props, List values = null)` 如果数据字典不存在，则创建数据字典，并初始化数据
`static DataDictData`	`dataOf(String dictCode, String key)` 根据数据字典代码和数据值的 Key，获得其数据对象
`DataDictData`	`dataOf(String dictCode, String key, boolean attach)`
`static void`	`delete(String dictCode, boolean immediately = true)` 强制删除数据字典
`static void`	`deletePermissions(DataDict dd)`
`static DataDict`	`getDict(String dictCode)` 获取数据字典
`Map<String, Object>`	`getHandoverLogs(Map params)` 获得数据的工作移交日志
`Permission`	`getPermission(String type)` 获取关联角色对象
`Long`	`getPermissionId(String type)` 获得关联权限对象的ID
`List<Permission>`	`getPermissions()` 获得所有关联权限对象
`static List<DataDictData>`	`listData(String dictCode)` 根据数据字典代码，获得所有的数据对象列表，并根据序号/值代码排序
`static List`	`listData(String dictCode, boolean attach)`
`static List<DataDictData>`	`listData(String dictCode, String key)` 根据数据字典代码及数据值的 Key，获得所有的数据对象列表，并根据序号/值代码排序
`static List`	`listData(String dictCode, String key, boolean attach)`
`static List<Map>`	`listDataKV(String dictCode, List<String> props = null)` 根据数据字典代码，获得所有的数据的 KV 列表，并根据序号/值代码排序
`static List<DataDict>`	`listDicts()` 获得所有数据字典列表
`static List<DataDict>`	`listDicts(String group)` 获得数据字典列表
`Object`	`onDelete()`
`Object`	`onSave()`
`String`	`toString()`
`static Object`	`valueOf(String dictCode, String key, Object defaultVal = null)` 根据数据字典代码和数据值的 Key，获得其值
`static List`	`valuesOf(String dictCode, String key, boolean convert = true)` 根据数据字典代码和数据值的 Key，获得其值列表
`static List`	`valuesOf(String dictCode, boolean convert = true)` 根据数据字典代码，获得值列表

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 List<String> PERMISSION_CODE_SUFFIXES
- Property Detail
  - static Integer TYPE_ATT
  - static Integer TYPE_BOOL
  - static Integer TYPE_DATE
  - static Integer TYPE_DATETIME
  - static Integer TYPE_DECIMAL
  - static Integer TYPE_EI
  - static Integer TYPE_EMP
  - static Integer TYPE_IMG
  - static Integer TYPE_INTEGER
  - static Integer TYPE_ORG
  - static Integer TYPE_STRING
  - String code
    
    数据字典代码 - 被程序引用的标识符
  - static Object constraints
  - String createdBy
  - Date dateCreated
    
    时间戳...
  - Boolean disabled
    
    禁用
  - String ext1
    
    　扩展属性　
  - String ext2
  - String extName1
    
    扩展属性名称
  - String extName10
  - String extName2
  - String extName3
  - String extName4
  - String extName5
  - String extName6
  - String extName7
  - String extName8
  - String extName9
  - Integer extType1
    
    扩展属性类型，同 type
  - Integer extType10
  - Integer extType2
  - Integer extType3
  - Integer extType4
  - Integer extType5
  - Integer extType6
  - Integer extType7
  - Integer extType8
  - Integer extType9
  - String group
    
    数据字典的分组名称，便于维护管理
  - Boolean hierarchical
    
    是否分层
  - Date lastUpdated
  - static Map listFields
  - static Object mapping
  - String name
    
    数据字典名称
  - String notes
    
    维护说明
  - static Object transients
  - String updatedBy
  - Boolean valKey
    
    是否需要值代码
  - String valKeyName
    
    值代码的显示名
  - String valName
    
    数据值的显示名
  - Integer valType
    
    数据类型
- Method Detail
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static void bootStrapInit()
    
    初始化权限
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static void clearData(String dictCode)
    
    删除数据字典下所有数据
    
    Parameters:
    dictCode
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static Integer countData(String dictCode)
    
    根据数据字典代码，计算数据对象的数量
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDictData createData(Object dict, Object val, String key = null, Map props = null)
    
    创建一条数据
    
    Returns:
    未保存的数据对象
    Parameters:
    dict - 数据字典的代码(code)、ID、或数据字典对象
    val - 值对象
    key - 值的索引名称
    props - 其他属性，如 notes、extValN（扩展属性）......
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDictData createData(Object dict, Object val, Map props)
    
    创建一条数据
    
    Returns:
    未保存的数据对象
    Parameters:
    dict - 数据字典的代码(code)，或数据字典Bean
    val - 值对象
    props - 其他属性，如 notes、extValN（扩展属性）......
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDict createDict(String name, String code, Map props = null)
    
    创建一种数据字典
    
    Returns:
    未保存的数据字典对象
    Parameters:
    name - 数据字典的名字
    code - 数据字典的代码
    props - 其他属性，如 valType、group、notes、extNameN、extTypeN 等，默认为 null
  - @Deprecated @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDict createDict(String name, String code, String stype, Map props = null)
    
    Deprecated:
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDict createDictIfNotExists(String name, String code, Map props, List values = null)
    
    如果数据字典不存在，则创建数据字典，并初始化数据
```
示例:

 DataDict.createDictIfNotExists("婚姻状况", DD_MARITAL,
    [group: "人力资源", notes: "员工婚姻状况"],
    ["未婚","离异","丧偶"] )
 DataDict.createDictIfNotExists("户口性质", DD_HUKOU_TYPE,
    [group: "人力资源", notes: "员工户口性质"],
    [[val:"本市城镇职工", key:"BSCZ"], [val:"外埠城镇职工", key:"WFCZ"],
    [val:"本市农村劳动力", key:"BSNC"], [val:"外埠农村劳动力", key:"WFNC"]])
 DataDict.createDictIfNotExists("父子结构", "XXXX",
    [group: "xxxx", notes: "xxxx"],
    [[val:"xxxx", children: ["x1", "x2", "x3"]],
     [val:"yyyy", children: [[val: "y1"], [val: "y2"]]]])
 
```
    Returns:
    已保存的数据字典对象
    Parameters:
    props - 字典的属性
    values - 数据列表，如果为 map，则会复制到对应的数据字段上，否则直接赋值到 val 上；如果不包含 key，且 props 中也不包含 valKey，则字典的 valKey（是否需要值代码）会自动设置为 false。
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDictData dataOf(String dictCode, String key)
    
    根据数据字典代码和数据值的 Key，获得其数据对象
    
    Returns:
    数据Bean
    Parameters:
    dictCode - 数据字典的代码
    key - 数据值的 Key
  - @Deprecated @GrailsCompileStatic@grails.compiler.GrailsCompileStatic DataDictData dataOf(String dictCode, String key, boolean attach)
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static void delete(String dictCode, boolean immediately = true)
    
    强制删除数据字典
    
    Parameters:
    dictCode
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static void deletePermissions(DataDict dd)
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDict getDict(String dictCode)
    
    获取数据字典
    
    Returns:
    数据字典对象
    Parameters:
    dictCode - 数据字典的代码
  - @CompileStatic Map<String, Object> getHandoverLogs(Map params)
    
    获得数据的工作移交日志
    Returns:
    [list: list, total: total]
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic Permission getPermission(String type)
    
    获取关联角色对象
    
    Returns:
    Parameters:
    type - 角色类型：w/ED=编辑权限，r/RO=查阅权限
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic Long getPermissionId(String type)
    
    获得关联权限对象的ID
    
    Returns:
    Parameters:
    type - 权限类型：w/ED=编辑权限，r/RO=查阅权限, s/DIS=禁/启用，d/DE=删除权限，c/CR=创建权限
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic List<Permission> getPermissions()
    
    获得所有关联权限对象
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List<DataDictData> listData(String dictCode)
    
    根据数据字典代码，获得所有的数据对象列表，并根据序号/值代码排序
    Returns:
    数据对象列表
    Parameters:
    dictCode - 数据字典的代码
  - @Deprecated @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List listData(String dictCode, boolean attach)
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List<DataDictData> listData(String dictCode, String key)
    
    根据数据字典代码及数据值的 Key，获得所有的数据对象列表，并根据序号/值代码排序
    
    Returns:
    数据对象列表
    Parameters:
    dictCode - 数据字典的代码
    key - 数据值的 Key
  - @Deprecated @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List listData(String dictCode, String key, boolean attach)
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List<Map> listDataKV(String dictCode, List<String> props = null)
    
    根据数据字典代码，获得所有的数据的 KV 列表，并根据序号/值代码排序
    Returns:
    数据列表，每条 Map 数据的格式为 [key: xxx, val: yyy, fullValue: zzz]
    Parameters:
    dictCode - 数据字典的代码
    props - 其他属性列表，如 extN
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List<DataDict> listDicts()
    
    获得所有数据字典列表
    
    Returns:
    数据字典列表
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List<DataDict> listDicts(String group)
    
    获得数据字典列表
    
    Returns:
    数据字典的列表
    Parameters:
    group - 字典分组名称
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic Object onDelete()
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic Object onSave()
  - String toString()
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static Object valueOf(String dictCode, String key, Object defaultVal = null)
    
    根据数据字典代码和数据值的 Key，获得其值
    
    Returns:
    数据值
    Parameters:
    dictCode - 数据字典的代码
    key - 数据值的 Key
    defaultVal - 如果 key 对应的数据值不存在，返回的默认值
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List valuesOf(String dictCode, String key, boolean convert = true)
    
    根据数据字典代码和数据值的 Key，获得其值列表
    
    Returns:
    数据值列表
    Parameters:
    dictCode - 数据字典的代码
    key - 数据值的 Key
    convert - 是否根据数据类型进行数据值转换，默认为 true
  - @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List valuesOf(String dictCode, boolean convert = true)
    
    根据数据字典代码，获得值列表
    
    Returns:
    数据值列表
    Parameters:
    dictCode - 数据字典的代码
    convert - 是否根据数据类型进行数据值转换，默认为 true

| Detail:
Field
Property
Constructor
Method

BROPEN Documentation, 2020-04-21 11:00

[Groovy] Class DataDict

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final List<String> PERMISSION_CODE_SUFFIXES

Property Detail

static Integer TYPE_ATT

static Integer TYPE_BOOL

static Integer TYPE_DATE

static Integer TYPE_DATETIME

static Integer TYPE_DECIMAL

static Integer TYPE_EI

static Integer TYPE_EMP

static Integer TYPE_IMG

static Integer TYPE_INTEGER

static Integer TYPE_ORG

static Integer TYPE_STRING

String code

static Object constraints

String createdBy

Date dateCreated

Boolean disabled

String ext1

String ext2

String extName1

String extName10

String extName2

String extName3

String extName4

String extName5

String extName6

String extName7

String extName8

String extName9

Integer extType1

Integer extType10

Integer extType2

Integer extType3

Integer extType4

Integer extType5

Integer extType6

Integer extType7

Integer extType8

Integer extType9

String group

Boolean hierarchical

Date lastUpdated

static Map listFields

static Object mapping

String name

String notes

static Object transients

String updatedBy

Boolean valKey

String valKeyName

String valName

Integer valType

Method Detail

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static void bootStrapInit()

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static void clearData(String dictCode)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static Integer countData(String dictCode)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDictData createData(Object dict, Object val, String key = null, Map props = null)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDictData createData(Object dict, Object val, Map props)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDict createDict(String name, String code, Map props = null)

@Deprecated @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDict createDict(String name, String code, String stype, Map props = null)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDict createDictIfNotExists(String name, String code, Map props, List values = null)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDictData dataOf(String dictCode, String key)

@Deprecated @GrailsCompileStatic@grails.compiler.GrailsCompileStatic DataDictData dataOf(String dictCode, String key, boolean attach)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static void delete(String dictCode, boolean immediately = true)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static void deletePermissions(DataDict dd)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static DataDict getDict(String dictCode)

@CompileStatic Map<String, Object> getHandoverLogs(Map params)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic Permission getPermission(String type)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic Long getPermissionId(String type)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic List<Permission> getPermissions()

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List<DataDictData> listData(String dictCode)

@Deprecated @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List listData(String dictCode, boolean attach)

@GrailsCompileStatic@grails.compiler.GrailsCompileStatic static List<DataDictData> listData(String dictCode, String key)