接口 IF_RAP_QUERY_FILTER

ABAP RESTful 应用程序编程模型 › 学习 › 查询 › 非托管查询 API › 接口 IF_RAP_QUERY_PROVIDER › 接口 IF_RAP_QUERY_REQUEST › 接口 IF_RAP_QUERY_FILTER

此接口是非托管查询的过滤条件提供者。这些方法为过滤条件提供了不同的表示。

方法 get_as_ranges

此方法返回过滤器作为同时适用的范围表的列表。如果未提供过滤器,则表为初始值。

签名

  METHODS get_as_ranges RETURNING VALUE(rt_ranges) TYPE tt_name_range_pairs
                        RAISING cx_rap_query_filter_no_range.

参数

rt_ranges

包含名称-范围-表对中的过滤条件列表。这意味着,每个请求的过滤器元素都与指示过滤条件的范围表相关。返回值的格式与范围表兼容。下表说明了名称和范围表的列表。

范围表的列具有选择表条件的语义。定义如下:

  • SIGN:包含值 I(包含)或 E(不考虑定义的范围)

  • OPTION:包含运算符值。如果高列为初始列,则有效运算符为 EQ、NE、GE GT LT、LE、CP 和 NP,如果高列不是初始值,则为 BT、NB。

  • LOW:包含比较值或间隔下限。

  • HIGH:包含间隔上限。

tt_name_range_对数

名称

范围

字符串

tt_range_option

符号

OPTION

LOW

HIGH

c(1)

c(2)

字符串

字符串

示例

对于过滤器请求,如

<service_root_url>/<entity_set>?$filter= Agency_ID eq '070031'
                                    and (Begin_Date ge datetime 2019-01-01T00 and Begin_Date le datetime 2019-12-31T00)

方法 get_as_ranges 返回范围表中的以下条目:

tt_name_range_对数

名称

范围

AGENCY_ID

tt_range_option

符号

OPTION

LOW

HIGH

I

EQ

070031

 

Begin_Date

tt_range_option

符号

OPTION

LOW

HIGH

I

BT

20190101

20191231

异常

cx_rap_query_filter_no_range

如果筛选器无法转换为范围表,则会抛出此异常。

在这种情况下,开发人员可以尝试使用方法 get_as_tree 或 get_as_sql_string 作为回退或抛出错误。

方法 get_as_sql_string

此方法以 SQL 字符串形式返回过滤器。如果未提供过滤器,则字符串为初始值。

签名

  METHODS get_as_sql_string RETURNING VALUE(rv_string) TYPE string.

参数

rv_string

包含 ABAP SQL 字符串形式的过滤条件。该变量可以直接在 ABAP SQL 语句的 WHERE 子句中用于选择数据。

示例

对于过滤器请求,如

<service_root_url>/<entity_set>?$filter= Agency_ID eq '070031'
                                    and (Begin_Date ge datetime 2019-01-01T00 and Begin_Date le datetime 2019-12-31T00)

方法 get_as_sql_string 返回 BEGIN_DATE BETWEEN '20190101' AND '20191231' AND AGENCY_ID = '070031'。此字符串具有要在 SQL 语句中使用的正确语法。

请参阅在非托管查询中实施过滤。

SQL 过滤器也可以应用于已使用范围表等进行预过滤的数据。

方法 get_as_tree

此方法返回对表示过滤条件的表达式树的引用,由于语义树结构,可以轻松查询和操作。过滤器树中的每个节点都有一个指示节点内容的类型。未提供过滤器时,对过滤器树的引用将解除绑定。

签名

METHODS get_as_tree RETURNING VALUE(ro_tree) TYPE REF TO if_rap_query_filter_tree.

参数 ro_tree

参数 ro_tree 引用接口 if_rap_query_filter_tree。使用此接口的方法 get_root_node 获取表达式树的根节点。在此,您可以使用接口 if_rap_query_filter_tree_node 的以下方法通过过滤器树进行分析:

  • get_children:按用户输入的顺序获取当前节点的子节点。

  • get_type:获取当前节点的类型。

  • get_value:对于类型为 identifier 的节点,此方法返回对包含标识符(即字段条件中涉及的字段)的字符串的引用。对于类型为 value 的节点,此方法返回对原始值的引用。对于所有其他节点类型,不得调用此方法。如果无论是否出现不可捕获的异常,都会调用。

示例

对于过滤器请求,如

AGENCY_ID = '070004' AND ( CUSTOMER_ID = '000001' OR CUSTOMER_ID = '000002' OR CUSTOMER_ID = '000003' ) AND OVERALL_STATUS <> 'X'

方法 get_as_tree 返回具有以下语义的过滤器树: 给定条件的过滤器树

对于给定条件,无法保证过滤器树的结构以及此结构中节点的顺序,并且可以根据对过滤条件所做的修改而更改。

必须准备使用代码以处理可用节点类型的扩展,因为未来可能会添加更多节点类型。

来源:SAP Help Portal · 2025 FPS02 (Oct 2026) · 中文为 SAP 官方机器翻译

← 接口 IF_RAP_QUERY_REQUEST · 接口 IF_RAP_QUERY_PAGING →