kd.bos.entity

## 类 EntityTypeUtil

- java.lang.Object
- - kd.bos.entity.EntityTypeUtil

-     public class EntityTypeUtil
      extends java.lang.Object

  实体属性工具类

- - ### 构造器概要

    构造器
    构造器和说明
    `EntityTypeUtil()`

  - ### 方法概要

    所有方法 静态方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `static java.util.List<ListField>` | `expandListFields(java.util.List<ListField> listFields)`
    `static java.util.List<ListField>` | `getAllListField(EntityType entityType, java.util.List<ListField> listFields, boolean isNeedKeyFields)`
    `java.util.List<AnalysisField>` | `getAnalysisField(kd.bos.dataentity.metadata.IDataEntityType dataEntityType)`
    `static java.lang.String` | `getBilltypeId(BillEntityType entityType)`
    `static kd.bos.dataentity.metadata.IDataEntityProperty` | `getDataEntityProperty(java.lang.String fieldKey, EntityType dataType)` 返回实体属性
    `static kd.bos.dataentity.metadata.IDataEntityProperty` | `getDataEntityProperty(java.lang.String fieldKey, EntityType dataType, boolean isThrowException)` 返回实体属性
    `static java.util.List<EntryEntityDto>` | `getEntryEntities(EntityType entityType)` 返回实体所有分录
    `static java.util.List<EntryEntityDto>` | `getEntryEntitiesForForQing(EntityType entityType)`
    `static FieldProp` | `getFieldProp(java.lang.String fieldKey, EntityType dataType)` 返回字段属性
    `static FieldProp` | `getFieldProp(java.lang.String fieldKey, EntityType dataType, boolean isThrowException)` 返回字段属性
    `java.util.List<java.util.Map<java.lang.String,java.lang.Object>>` | `getFilterColumns(kd.bos.dataentity.metadata.IDataEntityType dataEntityType)` 基于单据主实体，生成前端使用的过滤字段列表
    `java.util.List<java.util.Map<java.lang.String,java.lang.Object>>` | `getFilterColumns(kd.bos.dataentity.metadata.IDataEntityType dataEntityType, boolean isOnlyMainEntityField)`
    `java.util.List<FilterField>` | `getFilterFields(kd.bos.dataentity.metadata.IDataEntityType dataEntityType)`
    `java.util.List<FilterField>` | `getFilterFields(kd.bos.dataentity.metadata.IDataEntityType dataEntityType, boolean isOnlyMainEntityField)`
    `static EntityTypeUtil` | `getInstance()` 返回工具类实例，单例
    `static java.util.List<ListField>` | `getKeyFields(EntityType entityType)`
    `static java.util.Map<java.lang.String,java.lang.String>` | `getKeyFields(MainEntityType entityType)` 获取单据关键字段信息，组织字段，编码：如果是基础，是编码，如果是单据是单据编号
    `java.util.List<java.lang.String>` | `getListFields(kd.bos.dataentity.metadata.IDataEntityType dataEntityType)` 返回列表字段列表
    `static java.lang.String` | `getMainOrgId(MainEntityType entityType)`
    `static ListField` | `getMainOrgListField(MainEntityType entityType)`
    `static FieldName` | `getORMFieldName(java.lang.String fieldKey, EntityType dataType)` 返回ORM查询时需要的名称，ORM查询时要带分录
    `static java.util.List<EntryEntityDto>` | `getParentEntryEntities(java.util.List<EntryEntityDto> entryEntities, java.lang.String entryEntity)` 返回当前分录的上级分录列表
    `static java.lang.String` | `getType(kd.bos.dataentity.metadata.IDataEntityProperty prop)` 返回实体字段类型，给前端使用
    `static java.util.List<ListField>` | `getValidPkFields(EntityType entityType, java.util.List<ListField> listFields)`
    `static boolean` | `isContainKey(java.util.List<EntryEntityDto> entryList, java.lang.String key)` 分录列表中是否有指定分录
    `static boolean` | `isContainPropertyName(kd.bos.dataentity.metadata.dynamicobject.DynamicObjectType dynamicObjectType, java.lang.String fieldName)`
    `static boolean` | `isMainOrgProp(kd.bos.dataentity.metadata.IDataEntityProperty bdProp)` 是否为主业务组织
    `static java.util.List<CompareType>` | `setCompareTypes(java.util.List<CompareType> compareTypes, boolean isFieldCompare)` 添加并返回字段相关比较符
    `static java.util.List<java.lang.String>` | `toCachedListFields(java.util.List<ListField> listFields)`

    - ### 从类继承的方法 java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### EntityTypeUtil

          public EntityTypeUtil()

  - ### 方法详细资料

    - #### getEntryEntitiesForForQing

          public static java.util.List<EntryEntityDto> getEntryEntitiesForForQing(EntityType entityType)

    - #### getEntryEntities

          public static java.util.List<EntryEntityDto> getEntryEntities(EntityType entityType)

      返回实体所有分录
      参数:
        `entityType` - 实体
      返回:
        实体分录列表

    - #### getParentEntryEntities

          public static java.util.List<EntryEntityDto> getParentEntryEntities(java.util.List<EntryEntityDto> entryEntities,
                                                                              java.lang.String entryEntity)

      返回当前分录的上级分录列表
      参数:
        `entryEntities` - 所有实体分录列表
        `entryEntity` - 当前分录
      返回:
        上级分录列表

    - #### getFieldProp

          public static FieldProp getFieldProp(java.lang.String fieldKey,
                                               EntityType dataType)

      返回字段属性
      参数:
        `fieldKey` - 字段标识
        `dataType` - 实体
      返回:
        字段属性

    - #### getFieldProp

          public static FieldProp getFieldProp(java.lang.String fieldKey,
                                               EntityType dataType,
                                               boolean isThrowException)

      返回字段属性
      参数:
        `fieldKey` - 字段标识
        `dataType` - 实体
        `isThrowException` - 是否抛出错误
      返回:
        字段属性

    - #### getDataEntityProperty

          public static kd.bos.dataentity.metadata.IDataEntityProperty getDataEntityProperty(java.lang.String fieldKey,
                                                                                             EntityType dataType)

      返回实体属性
      参数:
        `fieldKey` - 字段标识
        `dataType` - 实体
      返回:
        实体属性

    - #### getDataEntityProperty

          public static kd.bos.dataentity.metadata.IDataEntityProperty getDataEntityProperty(java.lang.String fieldKey,
                                                                                             EntityType dataType,
                                                                                             boolean isThrowException)

      返回实体属性
      参数:
        `fieldKey` - 字段标识
        `dataType` - 实体
        `isThrowException` - 是否抛出错误
      返回:
        实体属性

    - #### getORMFieldName

          public static FieldName getORMFieldName(java.lang.String fieldKey,
                                                  EntityType dataType)

      返回ORM查询时需要的名称，ORM查询时要带分录
      参数:
        `fieldKey` - 字段标识
        `dataType` - 实体
        `isF7` - 是否是F7,如果是将编码转为主键处理
      返回:
        字段相关属性类

    - #### isContainKey

          public static boolean isContainKey(java.util.List<EntryEntityDto> entryList,
                                             java.lang.String key)

      分录列表中是否有指定分录
      参数:
        `entryList` - 分录列表
        `key` - 指定分录
      返回:
        是否有

    - #### getInstance

          public static EntityTypeUtil getInstance()

      返回工具类实例，单例
      返回:

    - #### getListFields

          public java.util.List<java.lang.String> getListFields(kd.bos.dataentity.metadata.IDataEntityType dataEntityType)

      返回列表字段列表
      参数:
        `dataEntityType` - 实体
      返回:
        字段列表

    - #### getType

          public static java.lang.String getType(kd.bos.dataentity.metadata.IDataEntityProperty prop)

      返回实体字段类型，给前端使用
      参数:
        `prop` - 字段属性
      返回:
        字段类型

    - #### setCompareTypes

          public static java.util.List<CompareType> setCompareTypes(java.util.List<CompareType> compareTypes,
                                                                    boolean isFieldCompare)

      添加并返回字段相关比较符
      参数:
        `compareTypes` - 字段类型
        `compareGroupId` - 比较符组
      返回:
        比较符集合

    - #### getAnalysisField

          public java.util.List<AnalysisField> getAnalysisField(kd.bos.dataentity.metadata.IDataEntityType dataEntityType)

    - #### getFilterFields

          public java.util.List<FilterField> getFilterFields(kd.bos.dataentity.metadata.IDataEntityType dataEntityType)

      返回:

    - #### getFilterFields

          public java.util.List<FilterField> getFilterFields(kd.bos.dataentity.metadata.IDataEntityType dataEntityType,
                                                             boolean isOnlyMainEntityField)

    - #### getFilterColumns

          public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getFilterColumns(kd.bos.dataentity.metadata.IDataEntityType dataEntityType)

      基于单据主实体，生成前端使用的过滤字段列表
      参数:
        `dataEntityType` - 实体类型
      返回:
        返回直接发送给前端的过滤字段元数据

    - #### getFilterColumns

          public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getFilterColumns(kd.bos.dataentity.metadata.IDataEntityType dataEntityType,
                                                                                                   boolean isOnlyMainEntityField)

    - #### getKeyFields

          public static java.util.Map<java.lang.String,java.lang.String> getKeyFields(MainEntityType entityType)

      获取单据关键字段信息，组织字段，编码：如果是基础，是编码，如果是单据是单据编号
      参数:
        `entityType` - 实体
      返回:
        关键字段字典

    - #### getBilltypeId

          public static java.lang.String getBilltypeId(BillEntityType entityType)

    - #### getMainOrgId

          public static java.lang.String getMainOrgId(MainEntityType entityType)

    - #### toCachedListFields

          public static java.util.List<java.lang.String> toCachedListFields(java.util.List<ListField> listFields)

    - #### getMainOrgListField

          public static ListField getMainOrgListField(MainEntityType entityType)

    - #### getKeyFields

          public static java.util.List<ListField> getKeyFields(EntityType entityType)

    - #### expandListFields

          public static java.util.List<ListField> expandListFields(java.util.List<ListField> listFields)

    - #### getAllListField

          public static java.util.List<ListField> getAllListField(EntityType entityType,
                                                                  java.util.List<ListField> listFields,
                                                                  boolean isNeedKeyFields)

    - #### getValidPkFields

          public static java.util.List<ListField> getValidPkFields(EntityType entityType,
                                                                   java.util.List<ListField> listFields)

    - #### isMainOrgProp

          public static boolean isMainOrgProp(kd.bos.dataentity.metadata.IDataEntityProperty bdProp)

      是否为主业务组织
      参数:
        `bdProp` - 实体属性
      返回:
        是否为主业务组织

    - #### isContainPropertyName

          public static boolean isContainPropertyName(kd.bos.dataentity.metadata.dynamicobject.DynamicObjectType dynamicObjectType,
                                                      java.lang.String fieldName)