kd.bos.entity.property

## 接口 IFieldHandle

- 所有已知实现类:
    AdminDivisionProp, AmountProp, AssistantProp, AttachmentCountProp, AttachmentProp, BasedataProp, BaseUnitqtyProp, BigIntProp, BillStatusProp, BillTypeProp, BizBasedataProp, BooleanProp, CityProp, ComboProp, CreateDateProp, CreaterProp, CurrencyProp, DateProp, DateTimeProp, DecimalProp, FieldProp, FlexProp, FormulaProp, GroupProp, IconProp, IntegerProp, ItemClassProp, ItemClassTypeProp, JoinProperty, LargeTextProp, LongProp, MainOrgProp, MasterBasedataProp, MaterielProp, ModifierProp, ModifyDateProp, MulBasedataProp, MulComboProp, MuliLangTextProp, OrgProp, ParentBasedataProp, PeriodProp, PictureProp, PKFieldProp, PriceProp, PrintCountProp, QtyProp, TextAreaProp, TextProp, TimeProp, UnitProp, UserProp, VarcharProp

      public interface IFieldHandle

- - ### 方法概要

    所有方法 静态方法 实例方法 抽象方法 默认方法 已过时的方法
    限定符和类型 | 方法和说明
    --- | ---
    `default void` | `afterCreateFilterColumn(java.util.Map<java.lang.String,java.lang.Object> column, ColumnParam param)` 根据不同字段类型来调整字段列的某些属性，在创建过滤字段后被调用
    `void` | `applyDefaultValue(IDataModel model, kd.bos.dataentity.entity.DynamicObject dataEntity, int rowIndex)` 设置该属性对应缺省值
    `AnalysisField` | `createAnalysisField(MainEntityType mainType, java.lang.String propName)`
    `default java.util.List<AnalysisField>` | `createAnalysisFields(MainEntityType mainType)`
    `java.util.List<java.util.Map<java.lang.String,java.lang.Object>>` | `createEntityTreeNodes(EntityTreeNode entityTreeNode)` 已过时。
    `java.util.List<java.util.Map<java.lang.String,java.lang.Object>>` | `createEntityTreeNodes(EntityTreeNode entityTreeNode, boolean isAllNode)`
    `FilterField` | `createFilterField(MainEntityType mainType, java.lang.String propName)`
    `default java.util.List<FilterField>` | `createFilterFields(MainEntityType mainType)` 基于运行时字段元数据，构建过滤字段
    `default java.lang.Object` | `getBasePropDisplayValue(java.lang.Object basedataObj)` 获取基础资料属性在界面上展示的值
    `java.lang.String` | `getCompareGroupID()`
    `java.util.List<CompareType>` | `getCompareTypes()`
    `int` | `getDbType()`
    `java.lang.String` | `getDefaultCompareTypeId()`
    `java.lang.String` | `getDefaultMultiCompareTypeId()`
    `default java.lang.Object` | `getDefValue()` 字段默认值配置，默认返回为null，即未配置默认值
    `default FieldDefValue` | `getDefValue2()` 进阶版字段默认值配置，适用于复杂默认值取值类型，默认返回null。
    `kd.bos.dataentity.entity.LocaleString` | `getDisplayName()`
    `default int` | `getFeatures()` 字段的功能控制
    `static java.lang.Object` | `getFieldDefaultValue(DefaultValueCalculator defaultValueCalculator, kd.bos.dataentity.metadata.dynamicobject.DynamicProperty fieldProp)` 输出字段的默认值，基础版，传入的参数不够，只能进行变量运算
    `static java.lang.Object` | `getFieldDefaultValue2(IDataModel model, kd.bos.dataentity.entity.DynamicObject dataEntity, DefaultValueCalculator defaultValueCalculator, kd.bos.dataentity.metadata.dynamicobject.DynamicProperty fieldProp)` 输出字段的默认值，高级版，可以进行函数、公式计算
    `java.lang.String` | `getFilterControlType()`
    `AbstractColumnDesc` | `getListColumnDesc(ListField col)` 获取该属性对应列字段对应的格式化对象
    `default boolean` | `isAllowvoucher()` 允许凭证生成
    `default boolean` | `isAnalysisField()` 是否能用于分析字段
    `default boolean` | `isBulkEditable()` 允许批量修改
    `default boolean` | `isConvertTote()` 允许单据转换携带
    `default boolean` | `isCopyable()` 允许复制
    `default boolean` | `isExportable()` 允许引出
    `default boolean` | `isF7BatchFill()` F7批量填充分录空白行
    `default boolean` | `isImportable()` 允许引入
    `default boolean` | `isMultiFillable()` 允许批量填充
    `default boolean` | `isSeriesNewTote()` 连续新增
    `boolean` | `isSysField()` 是否系统属性，如内码、基础资料引用Id，多语言对应内部字段
    `void` | `setCompareGroupID(java.lang.String compareGroupID)`
    `void` | `setDefaultCompareTypeId(java.lang.String defaultCompareTypeId)`
    `void` | `setDefaultMultiCompareTypeId(java.lang.String defaultMultiCompareTypeId)`
    `default void` | `setFeatures(int features)`
    `void` | `setFieldValue(IDataModel model, java.lang.Object dataEntity, java.lang.Object Value)`
    `void` | `setFieldValueForWebApi(IDataModel model, java.lang.Object dataEntity, java.lang.Object value)` WebApi上传数据时设置字段的值，特殊的字段需要值转换进行重载，缺省实现和 setFieldValue一致
    `void` | `setFilterControlType(java.lang.String filterControlType)`
    `default void` | `setGroupControl(boolean groupControl)` 设置集团管控

- - ### 方法详细资料

    - #### isSysField

          boolean isSysField()

      是否系统属性，如内码、基础资料引用Id，多语言对应内部字段
      返回:

    - #### setFieldValue

          void setFieldValue(IDataModel model,
                             java.lang.Object dataEntity,
                             java.lang.Object Value)

    - #### getDisplayName

          kd.bos.dataentity.entity.LocaleString getDisplayName()

    - #### setFieldValueForWebApi

          void setFieldValueForWebApi(IDataModel model,
                                      java.lang.Object dataEntity,
                                      java.lang.Object value)

      WebApi上传数据时设置字段的值，特殊的字段需要值转换进行重载，缺省实现和 setFieldValue一致
      参数:
        `model` -
        `dataEntity` -
        `value` -

    - #### applyDefaultValue

          void applyDefaultValue(IDataModel model,
                                 kd.bos.dataentity.entity.DynamicObject dataEntity,
                                 int rowIndex)

      设置该属性对应缺省值
      参数:
        `dataEntity` -

    - #### afterCreateFilterColumn

          default void afterCreateFilterColumn(java.util.Map<java.lang.String,java.lang.Object> column,
                                               ColumnParam param)

      根据不同字段类型来调整字段列的某些属性，在创建过滤字段后被调用
      参数:
        `column` - 列字典

    - #### getListColumnDesc

          AbstractColumnDesc getListColumnDesc(ListField col)

      获取该属性对应列字段对应的格式化对象
      参数:
        `col` -
      返回:

    - #### getDefValue

          default java.lang.Object getDefValue()

      字段默认值配置，默认返回为null，即未配置默认值
      返回:

    - #### getDefValue2

          default FieldDefValue getDefValue2()

      进阶版字段默认值配置，适用于复杂默认值取值类型，默认返回null。
      返回:

    - #### getCompareGroupID

          java.lang.String getCompareGroupID()

      返回:
        默认比较符组标识

    - #### setCompareGroupID

          void setCompareGroupID(java.lang.String compareGroupID)

      参数:
        `compareGroupID` - 默认比较符组标识

    - #### getDefaultCompareTypeId

          java.lang.String getDefaultCompareTypeId()

      返回:
        默认比较符(单个值)

    - #### setDefaultCompareTypeId

          void setDefaultCompareTypeId(java.lang.String defaultCompareTypeId)

      参数:
        `defaultCompareTypeId` - 默认比较符(单个值)

    - #### getDefaultMultiCompareTypeId

          java.lang.String getDefaultMultiCompareTypeId()

      返回:
        默认比较符(多个值)

    - #### setDefaultMultiCompareTypeId

          void setDefaultMultiCompareTypeId(java.lang.String defaultMultiCompareTypeId)

      参数:
        `defaultMultiCompareTypeId` - 默认比较符(多个值)

    - #### getCompareTypes

          java.util.List<CompareType> getCompareTypes()

    - #### createFilterFields

          default java.util.List<FilterField> createFilterFields(MainEntityType mainType)

      基于运行时字段元数据，构建过滤字段
      返回:

    - #### createFilterField

          FilterField createFilterField(MainEntityType mainType,
                                        java.lang.String propName)

    - #### createAnalysisFields

          default java.util.List<AnalysisField> createAnalysisFields(MainEntityType mainType)

    - #### createAnalysisField

          AnalysisField createAnalysisField(MainEntityType mainType,
                                            java.lang.String propName)

    - #### getDbType

          int getDbType()

    - #### createEntityTreeNodes

          @Deprecated
          java.util.List<java.util.Map<java.lang.String,java.lang.Object>> createEntityTreeNodes(EntityTreeNode entityTreeNode)

      已过时。

    - #### createEntityTreeNodes

          java.util.List<java.util.Map<java.lang.String,java.lang.Object>> createEntityTreeNodes(EntityTreeNode entityTreeNode,
                                                                                                 boolean isAllNode)

    - #### setFilterControlType

          void setFilterControlType(java.lang.String filterControlType)

    - #### getFilterControlType

          java.lang.String getFilterControlType()

      返回:
        过滤控件类型

    - #### getFieldDefaultValue

          static java.lang.Object getFieldDefaultValue(DefaultValueCalculator defaultValueCalculator,
                                                       kd.bos.dataentity.metadata.dynamicobject.DynamicProperty fieldProp)

      输出字段的默认值，基础版，传入的参数不够，只能进行变量运算
      参数:
        `defaultValueCalculator` - 默认值解析器：据此解析字段的默认值配置； 如果传入null，则在内部自动创建DefaultValueCalculator实例
        `fieldProp` - 字段属性对象
      返回:

    - #### getFieldDefaultValue2

          static java.lang.Object getFieldDefaultValue2(IDataModel model,
                                                        kd.bos.dataentity.entity.DynamicObject dataEntity,
                                                        DefaultValueCalculator defaultValueCalculator,
                                                        kd.bos.dataentity.metadata.dynamicobject.DynamicProperty fieldProp)

      输出字段的默认值，高级版，可以进行函数、公式计算
      参数:
        `model` - 数据模型，如果传null，不能进行含字段变量的公式运算
        `dataEntity` - 字段当前行数据包
        `defaultValueCalculator` - 默认值解析器：据此解析字段的默认值配置； 如果传入null，则在内部自动创建DefaultValueCalculator实例
        `fieldProp` - 字段属性对象
      返回:

    - #### getBasePropDisplayValue

          default java.lang.Object getBasePropDisplayValue(java.lang.Object basedataObj)

      获取基础资料属性在界面上展示的值
      参数:
        `basedataObj` - 基础资料的动态对象
      返回:
        基础资料属性在界面上展示的值

    - #### isAnalysisField

          default boolean isAnalysisField()

      是否能用于分析字段
      返回:

    - #### getFeatures

          default int getFeatures()

      字段的功能控制
      返回:

    - #### setFeatures

          default void setFeatures(int features)

    - #### isF7BatchFill

          default boolean isF7BatchFill()

      F7批量填充分录空白行
      返回:

    - #### isCopyable

          default boolean isCopyable()

      允许复制
      返回:

    - #### isMultiFillable

          default boolean isMultiFillable()

      允许批量填充
      返回:

    - #### isImportable

          default boolean isImportable()

      允许引入
      返回:

    - #### isExportable

          default boolean isExportable()

      允许引出
      返回:

    - #### isSeriesNewTote

          default boolean isSeriesNewTote()

      连续新增
      返回:

    - #### isBulkEditable

          default boolean isBulkEditable()

      允许批量修改
      返回:

    - #### isConvertTote

          default boolean isConvertTote()

      允许单据转换携带
      返回:

    - #### isAllowvoucher

          default boolean isAllowvoucher()

      允许凭证生成
      返回:

    - #### setGroupControl

          default void setGroupControl(boolean groupControl)

      设置集团管控