Filter

类名：Filter。

说明：过滤器，类似于 SQL 的 SELECT 语句，用于 GetList 方法获得满足条件的对象。

属性

名称	类型	说明
FromRowNum	int	从第 N 条记录开始，基数是 0，不含第 N 条。
ToRowNum	int	到第 M 条，基数是 0，不包含第 M 条。
Matcher	H3.Data.Filter.Matcher	该对象的匹配条件。
SortByCollection	H3.Data.Filter.SortDirection	过滤器的排序方法。
ReturnItems	string[]	要返回的列的集合，如果不为空，则表示只需要返回其中的列；否则，则表示采用默认的返回方式。这个属性与 ReturnColumns 是相通的，差别仅仅是这个不显示别名。
ReturnColumns	H3.Data.Filter.ReturnColumn[]	要返回的列的集合，如果不为空，则表示只需要返回其中的列；否则，则表示采用默认的返回方式。这个属性与 ReturnItems 是相通的，差别仅仅是这个显示别名。
RequireCount	boolean	是否需要返回符合条件的记录的总数，通常对于分页显示记录的时候，是需要获得总数的。

方法

添加排序字段

功能描述

添加排序字段。

方法定义

/// <summary>
/// 添加排序字段
/// </summary>
/// <param name="itemName">排序的字段的名称</param>
/// <param name="direction">从大到小或者从小到大</param>
/// <returns>如果添加成功，则返回true，否则返回false</returns>
public bool AddSortBy(string itemName, SortDirection direction);

参数说明

参数	说明
itemName	排序的字段的名称
direction	从大到小或者从小到大

返回值

如果添加成功，则返回 true，否则返回 false。

添加排序字段（重载）

功能描述

添加排序字段，如果没有重复的排序，则返回 true，否则返回 false。

方法定义

/// <summary>
/// 添加排序字段
/// </summary>
/// <param name="sortBy">排序字段的信息</param>
/// <returns>如果没有重复的排序，则返回true，否则返回false</returns>
public bool AddSortBy(SortBy sortBy);

参数说明

参数	说明
sortBy	排序字段的信息

返回值

如果没有重复的排序，则返回 true，否则返回 false。

删除排序字段

功能描述

移除指定索引的排序字段。

方法定义

/// <summary>
/// 删除排序字段
/// </summary>
/// <param name="index">要删除的排序索引号</param>
/// <returns>如果删除成功，则返回true，否则返回false</returns>
public bool RemoveSortBy(int index);

参数说明

参数	说明
index	要删除的排序索引号

返回值

如果删除成功，则返回 true，否则返回 false。

获得该过滤器引用的所有的业务对象模式的属性

功能描述

获得该过滤器引用的所有的业务对象模式的属性。

方法定义

/// <summary>
/// 获得该过滤器引用的所有的业务对象模式的属性
/// </summary>
/// <param name="schema">业务对象模式</param>
/// <returns>引用的所有的业务对象模式的属性</returns>
public string[] GetReferencdProperties(DataModel.BizObjectSchema schema);

参数说明

参数	说明
schema	业务对象模式

返回值

引用的所有的业务对象模式的属性，string[] 类型。

检查是否存在循环引用

功能描述

检查是否存在循环引用。

方法定义

/// <summary>
/// 由于 ItemMatcher 是有可能会引用自己的，所以在这里检查一下是否存在循环引用。
/// </summary>
/// <returns>校验通过返回true，否则返回false</returns>
public bool Validate()

参数说明

参数	说明
无	无

返回值

校验通过返回 true，否则返回 false。