接口 IF_RAP_QUERY_REQUEST

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

该接口定义在非托管查询中对查询请求进行参数化的方法。它用于处理数据检索的 OData 查询选项。

方法 get_entity_id

此方法返回非托管查询中 OData 请求的请求实体集的 CDS 实体名称。

使用此方法,可以确保仅当调用此查询实施集的正确实体时才执行查询实施。

签名

  METHODS get_entity_id RETURNING VALUE(rv_entity_id) TYPE string.

rv_entity_id

请求实体集的 CDS 实体名称。

方法 is_data_requested

此方法返回一个布尔值,用于指示是否请求了数据。

备注

如果此方法用于指示数据请求,则必须调用方法 set_data。

签名

  METHODS is_data_requested RETURNING VALUE(rv_is_requested) TYPE abap_bool.

参数

rv_is_requested

如果需要返回数据,则值为 abap_true。如果不需要返回任何数据,则值为 abap_false。

方法 is_total_numb_of_rec_requested

此方法返回一个布尔值,用于指示是否请求记录总数。记录总数由查询选项 $inlinecount 或 $count 请求请求。

备注

如果此方法指示请求记录总数,则需要通过方法 set_total_number_of_records 返回总数。

签名

  METHODS is_total_numb_of_rec_requested RETURNING VALUE(rv_is_requested) TYPE abap_bool.

参数

rv_is_requested

如果需要返回记录总数,则值为 abap_true。如果未请求记录总数,则值为 abap_false。

方法 get_filter

此方法返回过滤器对象。此过滤器对象是 IF_RAP_QUERY_FILTER 的接口实例。如果要求筛选器,其方法将返回筛选器信息。仅必须返回或计数符合此过滤条件的记录。

签名

  METHODS get_filter RETURNING VALUE(ro_filter) TYPE REF TO if_rap_query_filter.

接口 IF_RAP_QUERY_FILTER

参数

RO_FILTER

包含过滤条件。

方法 get_paging

此方法返回具有分页信息的对象。分页对象是 IF_RAP_QUERY_PAGING 的接口实例。它通过偏移量和页面大小限制将作为响应数据返回的记录数。

签名

  METHODS get_paging RETURNING VALUE(ro_paging) TYPE REF TO if_rap_query_paging.

接口 IF_RAP_QUERY_PAGING

参数

RO_PAGING

包含分页信息。

方法 get_sort_elements

此方法返回排序元素的排序顺序。

签名

  METHODS get_sort_elements RETURNING VALUE(rt_sort_elements) TYPE tt_sort_elements.

参数

rt_sort_elements

包含要排序的元素及其排序方向。这是一个排序列表,用于定义排名顺序,第一个元素是主要排序条件。该表指示排序元素的名称和排序顺序以及列 descending 中的布尔值。下表说明了返回值的外观。

tt_sort_elements

ELEMENT_NAME

降序

string

abap_bool

示例

对于过滤器请求,如

<service_root_url>/<entity_set>?$orderby=Customer_ID desc

方法 get_sort_elements 返回返回表中的以下条目:

rt_sort_elements

ELEMENT_NAME

降序

CUSTOMER_ID

X

方法 get_parameters

此方法返回实体参数及其值的列表。

签名

  METHODS get_parameters RETURNING VALUE(rt_parameters) TYPE tt_parameters.

参数

rt_parameters

包含参数及其给定值的列表。

tt_parameters

PARAMETER_NAME

VALUE

string

string

示例

对于过滤器请求,如

<service_root_url>/<entity_set>(p_start_date=datetime'2016-07-08T12:34',p_end_date=datetime'2019-07-08T12:34')/Set

方法 get_parameters 返回下表:

rt_parameters

PARAMETER_NAME

VALUE

P_START_DATE

20160708

P_END_DATE

20190708

方法 get_aggregation

此方法返回聚合对象。此对象是 IF_RAP_QUERY_AGGREGATION 的接口实例,其中包含指示哪些元素需要聚合或分组的方法。

签名

  METHODS get_aggregation RETURNING VALUE(ro_aggregation) TYPE REF TO if_rap_query_aggregation.

接口 IF_RAP_QUERY_AGGREGATION

参数

ro_aggregation

有关聚合和分组信息的接口实例。

方法 get_search_expression

此方法返回请求的搜索字符串。

签名

  METHODS get_search_expression RETURNING VALUE(rv_search_expression) TYPE string.

参数

rv_search_expression

包含未指定格式的自由搜索表达式。

方法 get_requested_elements

此方法返回需要为响应提供的请求元素。

签名

  METHODS get_requested_elements RETURNING VALUE(rt_requested_elements) TYPE tt_requested_elements.

rt_requested_elements

包含请求元素的列表。

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

← 接口 IF_RAP_QUERY_PROVIDER · 接口 IF_RAP_QUERY_FILTER →