SAP ABAP Interface IF_SALV_STI_GROUPING_SERVICE (Grouping and aggregation service)
Hierarchy
☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-ATS (Application Component) ABAP Table/Tree Services
     ⤷ SALV_STI (Package) ALV Services for Tables: iTab Services impl.
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_SALV_STI_GROUPING_SERVICE Grouping and aggregation service 20100831
Properties
Interface IF_SALV_STI_GROUPING_SERVICE  
Short Description Grouping and aggregation service    
General Data
Package SALV_STI   ALV Services for Tables: iTab Services impl. 
Created 20100831   SAP 
Last changed 20141121    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
2 CL_SALV_STI_ITAB_SERVICES Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 IF_SALV_ITAB_VIEW_GROUPED_DATA Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
4 IF_SALV_SERVICE_TYPES Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
5 IF_SALV_STI_GROUPING_SERVICE Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Interface IF_SALV_STI_GROUPING_SERVICE has no interface.
Friends
Interface IF_SALV_STI_GROUPING_SERVICE has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 C_COLLAPSE_ALL_LEVELS Constant Public Type reference (TYPE) I 0 20110119
2 C_EXPAND_ALL_LEVELS Constant Public Type reference (TYPE) I CL_ABAP_MATH=>MAX_INT4 20110119
Methods
# Method Level Visibility Method type Description Created on
1 APPLY_CHANGE_LOG Instance method Public Method 20110118
2 COLLAPSE_NODE Instance method Public Method 20100901
3 EXPAND_NODE Instance method Public Method 20100901
4 EXPAND_NODES_FOR_AUX_INDEX Instance method Public Method 20130624
5 EXPAND_NODES_TO_LEVEL Instance method Public Method 20100831
6 FILTER_BY_INDEX_TABLE Instance method Public Method 20110126
7 FILTER_BY_MATCHING_TEST Instance method Public Method 20110126
8 FIND_FILTER_IDX_FOR_NEXT_DATA Instance method Public Method 20130821
9 FIND_GROUP_BOUNDARIES Instance method Public Method 20110126
10 GET_CURRENT_KEY_RECORDS Instance method Public Method 20140327
11 GET_DATA_ROWS_IDX_RANGES Instance method Public Method 20130821
12 GET_GRAND_TOTAL Instance method Public Method 20111019
13 GET_HEADER_DATA Instance method Public Method 20140212
14 GET_INVERSE_DATA_INDEX_TABLE Instance method Public Method 20100901
15 GET_LAST_AUX_OF_GRP Instance method Public Method 20140326
16 GET_PARENT_NODES Instance method Public Method 20140226
17 GET_RESULT_DATA Instance method Public Method 20110114
18 GET_RESULT_INDEX_FOR_KEY Instance method Public Method 20140319
19 GET_RESULT_INDEX_TABLE Instance method Public Method 20130624
20 GET_RESULT_SIZE Instance method Public Method 20130624
21 GET_SEGMENT_INFO Instance method Public Method 20140327
22 GET_VISIBLE_NODE_INFORMATION Instance method Public Method 20131016
23 NAVIGATE_TO_NEXT_DATA_ROW Instance method Public Method 20140602
24 REMOVE_FILTER Instance method Public Method 20110124
25 SET_AGGREGATION_RULES Instance method Public Method 20110420
26 SET_COLLAPSED_PER_DEFAULT Instance method Public Method 20130621
27 SET_GRAND_TOTAL_IN_RESULT Instance method Public Method Include or exclude grand total in/from result table 20111025
28 SET_REFERENCE_TO_AUX Instance method Public Method 20140415
29 SET_SOURCE Instance method Public Method 20110119
Events
Interface IF_SALV_STI_GROUPING_SERVICE has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 YS_AGGREGATION_RULE Public See coding 20110831 begin of ys_aggregation_rule, column_id type string, aggregation_function type if_salv_service_types=>y_function_code, field_path type string, reference_field_path type string, visibility_condition type string, sort_aggr type yt_sort_aggr, end of ys_aggregation_rule
2 YS_GROUPING_RULE Public See coding 20110831 begin of ys_grouping_rule, t_key_fields type if_salv_service_types=>yt_field_path, t_source_field_copy_info type yt_source_field_copy_info, " only for grouping table r_group_label_provider type ref to if_salv_sti_group_label_prov, end of ys_grouping_rule
3 YS_RESULT_METADATA Public See coding 20110114 begin of ys_result_metadata, row_no type i, row_type type char1, " domain: c_row_type group_id type i, group_level type i, parent_group_id type i, is_expanded type abap_bool, group_label type string, line_index_in_multiline_node type i, data_rows_count type i, end of ys_result_metadata
4 YS_SORT_AGGR Public See coding 20140409 begin of ys_sort_aggr, column_id type string, level type i, descending type abap_bool, end of ys_sort_aggr
5 YS_SOURCE_FIELD_COPY_INFO Public See coding 20110831 begin of ys_source_field_copy_info, source_field type string, aux_field type string, end of ys_source_field_copy_info
6 YS_VIS_NODE_INFO Public See coding 20131016 begin of ys_vis_node_info, result_start_row type i, group_label type string, end of ys_vis_node_info
7 YTS_AGGREGATION_RULE Public See coding 20110831 yts_aggregation_rule type sorted table of ys_aggregation_rule with unique key column_id aggregation_function
8 YT_GROUPING_RULE Public See coding 20110831 yt_grouping_rule type table of ys_grouping_rule with default key
9 YT_RESULT_METADATA Public See coding 20110831 yt_result_metadata type standard table of ys_result_metadata with default key
10 YT_SORT_AGGR Public See coding 20140409 yt_sort_aggr type standard table of ys_sort_aggr with default key
11 YT_SOURCE_FIELD_COPY_INFO Public See coding 20110831 yt_source_field_copy_info type standard table of ys_source_field_copy_info with default key
12 YT_VIS_NODE_INFO Public See coding 20131016 yt_vis_node_info type standard table of ys_vis_node_info with default key
Method Signatures

Method APPLY_CHANGE_LOG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_DELETED_SORTED Call by reference Type reference (TYPE) IF_SALV_STU_INTERNAL_TYPES=>YT_INDEX_VISIBILITY 20110124
2 Importing I_CELL_VALUES_MODIFIED Call by reference Type reference (TYPE) ABAP_BOOL 20111014
3 Importing I_INSERT_POSITION_BEFORE_DEL Call by reference Type reference (TYPE) I 20110124
4 Importing I_ROWS_INSERTED Call by reference Type reference (TYPE) I 20110124

Method APPLY_CHANGE_LOG on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method COLLAPSE_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing RESULT_INDEX Value transfer Type reference (TYPE) I 20130624
# Exception Resumable Description Created on
1 CX_SALV_NOT_A_GROUP_ROW 20110117

Method EXPAND_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing RESULT_INDEX Value transfer Type reference (TYPE) I 20130624
# Exception Resumable Description Created on
1 CX_SALV_NOT_A_GROUP_ROW 20110117

Method EXPAND_NODES_FOR_AUX_INDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing AUX_TABLE_INDEX Value transfer Type reference (TYPE) I 20130624
2 Exporting EV_GROUP_KEY Call by reference Object reference (TYPE REF TO) DATA 20140319
3 Exporting EV_NODE_EXPANDED Value transfer Type reference (TYPE) ABAP_BOOL 20140319
4 Exporting EV_RESULT_IDX_GROUP_KEY Value transfer Type reference (TYPE) I 20140321
5 Importing LEVEL Value transfer Type reference (TYPE) I Up to this level the nodes will be expanded 20140305

Method EXPAND_NODES_FOR_AUX_INDEX on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method EXPAND_NODES_TO_LEVEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing VISIBLE_LEVEL Value transfer Type reference (TYPE) I IF_SALV_STI_GROUPING_SERVICE=>C_EXPAND_ALL_LEVELS 20130308

Method EXPAND_NODES_TO_LEVEL on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method FILTER_BY_INDEX_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing T_FILTER_INDEX Call by reference Type reference (TYPE) IF_SALV_SERVICE_TYPES=>YT_ROW_INDEX 20110126

Method FILTER_BY_INDEX_TABLE on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method FILTER_BY_MATCHING_TEST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FILTER_MATCH_CONDITION Call by reference Type reference (TYPE) STRING 20110126
2 Importing T_AUX_TABLE Call by reference Type reference (TYPE) INDEX TABLE 20130624

Method FILTER_BY_MATCHING_TEST on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method FIND_FILTER_IDX_FOR_NEXT_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning FILTER_TABLE_INDEX Value transfer Type reference (TYPE) I 20130821
2 Importing RESULT_INDEX Value transfer Type reference (TYPE) I 20130821
3 Importing SEARCH_BACKWARD Value transfer Type reference (TYPE) ABAP_BOOL 20130821

Method FIND_FILTER_IDX_FOR_NEXT_DATA on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method FIND_GROUP_BOUNDARIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing GROUP_LINES_BELOW_DATA Value transfer Type reference (TYPE) ABAP_BOOL 20110126
2 Importing T_AUX_TABLE Call by reference Type reference (TYPE) INDEX TABLE 20130624
3 Importing T_GROUPING_RULES Call by reference Type reference (TYPE) YT_GROUPING_RULE 20110126

Method FIND_GROUP_BOUNDARIES on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_CURRENT_KEY_RECORDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_KEY_RECORDS Value transfer Object reference (TYPE REF TO) DATA 20140327

Method GET_CURRENT_KEY_RECORDS on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_DATA_ROWS_IDX_RANGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_FILTER_TABLE_IDX_RANGE Call by reference Type reference (TYPE) IF_SALV_SERVICE_TYPES=>YT_RANGE 20130821
2 Importing RESULT_INDEX_FROM Value transfer Type reference (TYPE) I 20130821
3 Importing RESULT_INDEX_TO Value transfer Type reference (TYPE) I 20130821

Method GET_DATA_ROWS_IDX_RANGES on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_GRAND_TOTAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_AGGREGATION_EXCEPTION Call by reference Type reference (TYPE) IF_SALV_ITAB_VIEW_GROUPED_DATA=>YTS_AGGREGATION_EXCEPTION 20111019
2 Exporting ET_DATA Call by reference Type reference (TYPE) STANDARD TABLE 20111019

Method GET_GRAND_TOTAL on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_HEADER_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_HEADER_DATA Call by reference Type reference (TYPE) IF_SALV_ITAB_VIEW_GROUPED_DATA=>YT_HEADER_ROW_INFO 20140212
2 Importing RESULT_INDEX_FROM Value transfer Type reference (TYPE) I 1 20140212
3 Importing RESULT_INDEX_TO Value transfer Type reference (TYPE) I 20140212

Method GET_HEADER_DATA on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_INVERSE_DATA_INDEX_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning T_INVERSE_DATA_INDEX_TABLE Value transfer Type reference (TYPE) IF_SALV_SERVICE_TYPES=>YT_ROW_INDEX 20100901

Method GET_INVERSE_DATA_INDEX_TABLE on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_LAST_AUX_OF_GRP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_AUX Call by reference Type reference (TYPE) SY-TABIX ABAP System Field: Row Index of Internal Tables 20140326
2 Importing I_LEVEL Call by reference Type reference (TYPE) I 20140326
3 Returning R_AUX Value transfer Type reference (TYPE) SY-TABIX ABAP System Field: Row Index of Internal Tables 20140326

Method GET_LAST_AUX_OF_GRP on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_PARENT_NODES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_PARENT_NODE_RESULT_INDEX Call by reference Type reference (TYPE) IF_SALV_ITAB_VIEW_GROUPED_DATA=>YT_PARENT_NODE_RESULT_INDEX 20140226
2 Importing IV_RESULT_INDEX Value transfer Type reference (TYPE) SYTABIX 20140226

Method GET_PARENT_NODES on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_RESULT_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_AGGREGATION_EXCEPTION Call by reference Type reference (TYPE) IF_SALV_ITAB_VIEW_GROUPED_DATA=>YTS_AGGREGATION_EXCEPTION 20110831
2 Exporting ET_DATA Call by reference Type reference (TYPE) STANDARD TABLE 20110114
3 Exporting ET_ROW_INFO Call by reference Type reference (TYPE) IF_SALV_ITAB_VIEW_GROUPED_DATA=>YT_RESULT_ROW_INFO 20110114
4 Exporting ET_ROW_INFO_EXTENDED Call by reference Type reference (TYPE) YT_RESULT_METADATA 20110831
5 Importing FILL_EXTENDED_ROW_INFO Value transfer Type reference (TYPE) ABAP_BOOL 20110831
6 Importing RESULT_INDEX_FROM Value transfer Type reference (TYPE) I 1 20130624
7 Importing RESULT_INDEX_TO Value transfer Type reference (TYPE) I 20130624

Method GET_RESULT_DATA on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_RESULT_INDEX_FOR_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_KEY_RECORD Call by reference Object reference (TYPE REF TO) DATA 20140319
2 Importing I_LEVEL Call by reference Type reference (TYPE) I 20140319
3 Returning R_DATA_ONLY_RES_IDX Value transfer Type reference (TYPE) I 20140319

Method GET_RESULT_INDEX_FOR_KEY on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_RESULT_INDEX_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning T_RESULT_INDEX_TABLE Value transfer Type reference (TYPE) IF_SALV_SERVICE_TYPES=>YT_ROW_INDEX 20130624

Method GET_RESULT_INDEX_TABLE on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_RESULT_SIZE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning SIZE Value transfer Type reference (TYPE) I 20130624

Method GET_RESULT_SIZE on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_SEGMENT_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_AUX_IDX Call by reference Type reference (TYPE) SY-TABIX ABAP System Field: Row Index of Internal Tables 20140327
2 Exporting E_LAST_AUX_OF_GRP Call by reference Type reference (TYPE) SY-TABIX ABAP System Field: Row Index of Internal Tables 20140327
3 Exporting E_RES_ONLY_IDX Call by reference Type reference (TYPE) SY-TABIX ABAP System Field: Row Index of Internal Tables 20140327
4 Importing I_LAST_AUX_OLD_GRP Call by reference Type reference (TYPE) SY-TABIX ABAP System Field: Row Index of Internal Tables 20140328
5 Importing I_LEVEL Call by reference Type reference (TYPE) I 20140327
6 Importing I_SEGMENT_INDEX Call by reference Type reference (TYPE) SY-TABIX ABAP System Field: Row Index of Internal Tables 20140327

Method GET_SEGMENT_INFO on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method GET_VISIBLE_NODE_INFORMATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_VIS_NODE_INFO Value transfer Type reference (TYPE) IF_SALV_STI_GROUPING_SERVICE=>YT_VIS_NODE_INFO 20131016

Method GET_VISIBLE_NODE_INFORMATION on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method NAVIGATE_TO_NEXT_DATA_ROW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_RESULT_RESIZED Call by reference Type reference (TYPE) ABAP_BOOL Grps have been collapsed/expanded 20140701
2 Exporting EV_RES_IDX Call by reference Type reference (TYPE) IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX Index of Internal Tables 20140701
3 Importing IV_BACKWARD Call by reference Type reference (TYPE) ABAP_BOOL 20140602
4 Importing IV_START_RES_IDX Call by reference Type reference (TYPE) IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX Index of Internal Tables 20140602

Method NAVIGATE_TO_NEXT_DATA_ROW on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method REMOVE_FILTER Signature

Method REMOVE_FILTER on Interface IF_SALV_STI_GROUPING_SERVICE has no parameter.
Method REMOVE_FILTER on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method SET_AGGREGATION_RULES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ENABLE_MULTILINE_NODES Value transfer Type reference (TYPE) ABAP_BOOL 20110420
2 Importing TS_AGGREGATION_RULES Call by reference Type reference (TYPE) YTS_AGGREGATION_RULE 20110831

Method SET_AGGREGATION_RULES on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method SET_COLLAPSED_PER_DEFAULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COLLAPSED_PER_DEFAULT Call by reference Type reference (TYPE) ABAP_BOOL 20130621

Method SET_COLLAPSED_PER_DEFAULT on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method SET_GRAND_TOTAL_IN_RESULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_INCLUDED Value transfer Type reference (TYPE) ABAP_BOOL 20111025

Method SET_GRAND_TOTAL_IN_RESULT on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method SET_REFERENCE_TO_AUX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_AUX Call by reference Object reference (TYPE REF TO) DATA 20140415

Method SET_REFERENCE_TO_AUX on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.

Method SET_SOURCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing R_DATA_TABLE Call by reference Object reference (TYPE REF TO) DATA 20110119
2 Importing R_FILTERED_SOURCE_INDEX Call by reference Object reference (TYPE REF TO) IF_SALV_SERVICE_TYPES=>YT_ROW_INDEX 20110119

Method SET_SOURCE on Interface IF_SALV_STI_GROUPING_SERVICE has no exception.
History
Last changed by/on SAP  20141121 
SAP Release Created in 703