SAP ABAP Class /PLMU/CL_FRW_RETR_FILTER_NODE (Read Filter for a Single Node)
Hierarchy
SAP_BS_FND (Software Component) SAP Business Suite Foundation
   CA-EPT-SPI-FSI (Application Component) FPM SPI Integration
     /PLMU/UI_FRW_CORE (Package) UI Framework: Core
Properties
Class /PLMU/CL_FRW_RETR_FILTER_NODE  
Short Description Read Filter for a Single Node    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package /PLMU/UI_FRW_CORE   UI Framework: Core 
Created 20120605   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 /PLMU/CL_FRW_APPL_MODEL Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
2 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class /PLMU/CL_FRW_RETR_FILTER_NODE has no interface implemented.
Friends
Class /PLMU/CL_FRW_RETR_FILTER_NODE has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MO_CONTEXT Instance attribute Private Object reference (TYPE REF TO) /PLMU/IF_FRW_CONTEXT_INT 20120613
2 MO_NODE_METADATA Instance attribute Public Object reference (TYPE REF TO) /PLMB/IF_SPI_METADATA_NODE 20120605
3 MS_QUERY Instance attribute Private Type reference (TYPE) GTY_S_QUERY_BUFFER 20120613
4 MS_RETRIEVE Instance attribute Private Type reference (TYPE) GTY_S_RETRIEVE_BUFFER 20120613
5 MV_RAISE_INVALIDATION_EVENT Instance attribute Private Type reference (TYPE) BOOLE_D 20120613
Methods
# Method Level Visibility Method type Description Created on
1 ACTIVATE_INVALIDATION_EVENT Instance method Public Method 20120605
2 ADD_CRITERIA Instance method Public Method 20120613
3 ADD_IDS Instance method Public Method 20120605
4 ADJUST_INDEX_FAILED_TABLE Instance method Public Method 20120605
5 ADJUST_NODE_ID_REL_TABLE Instance method Public Method 20120605
6 ADJUST_RETRIEVE_BUFFER Instance method Private Method 20120605
7 ARE_ALL_ENTRIES_LOCKED Instance method Private Method 20120605
8 ASSOCIATE_WITH_CONTEXT Instance method Public Method 20120605
9 BUILD_DIRECT_RETRIEVE_BUFFER Instance method Private Method 20120605
10 BUILD_RETR_BY_ASSOC_BUFFER Instance method Private Method 20120605
11 CLEAR_BUFFER Instance method Private Method 20120613
12 CONSTRUCTOR Instance method Public Constructor 20120605
13 DESTRUCT Instance method Public Method 20120605
14 FILTER_CRITERIA Instance method Public Method 20120613
15 FILTER_IDS Instance method Public Method 20120605
16 GET_BUFFER_DESCRIPTION Static method Private Method 20120605
17 GET_LATELY_FILTERED_INDEXES Instance method Public Method 20120605
18 GET_LOCKED_IDS Instance method Public Method 20120605
19 GET_RETRIEVE_MODE Instance method Public Method 20120605
20 HAS_DATA_BEEN_CHANGED Instance method Private Method 20120605
21 HAS_RETRIEVE_MODE_BEEN_SET Instance method Public Method 20120605
22 HNDL_AFTER_CONTEXT_INIT Instance method Private Event handling method 20120605
23 HNDL_BEFORE_CONTEXT_DESTRUCT Instance method Private Event handling method 20120605
24 HNDL_METADATA_CHANGED Instance method Private Event handling method 20120605
25 INVALIDATE Instance method Public Method 20120605
26 REMOVE_OBSOLETE_IDS Instance method Private Method 20121004
27 SET_RETRIEVE_MODE Instance method Public Method 20120605
28 SET_RETRIEVE_MODE_FOR_CONTEXT Instance method Public Method 20120605
Events
# Event Type Visibility Description Created on
1 AFTER_INVALIDATION Instance Event
(0)
Public
(2)
20120605
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 GTY_S_DIRECT_RETRIEVE_BUFFER Private See coding 20120613 BEGIN OF gty_s_direct_retrieve_buffer, mode TYPE /plmu/frw_retrieve_mode, buffer_table TYPE REF TO data, buffer_row TYPE REF TO data, last_node_id TYPE REF TO data, END OF gty_s_direct_retrieve_buffer
2 GTY_S_INVALID_NODE_ID Public See coding 20120605 BEGIN OF gty_s_invalid_node_id, node_id TYPE /plmb/spi_node_id_x, reason TYPE /plmb/spi_invalidation_reason, scope TYPE /plmb/spi_invalidation_scope, END OF gty_s_invalid_node_id
3 GTY_S_QUERY_BUFFER Private See coding 20120613 BEGIN OF gty_s_query_buffer, mode TYPE /plmu/frw_retrieve_mode, is_initial TYPE boole_d, query_name TYPE /plmb/spi_query_name, sel_param TYPE /plmb/t_spi_selection_param, options TYPE /plmb/s_spi_query_options, keys_only TYPE /plmb/spi_keys_only_ind, requested_field TYPE /plmb/t_spi_requested_field, filter_node_id TYPE REF TO data, END OF gty_s_query_buffer
4 GTY_S_RETRIEVE_BUFFER Private See coding 20120613 BEGIN OF gty_s_retrieve_buffer, direct TYPE gty_s_direct_retrieve_buffer, by_association TYPE gty_s_retr_by_assoc_buffer, requested_field TYPE /plmb/t_spi_requested_field, index_of_filtered_node_id TYPE /plmu/ts_frw_sytabix, mode_has_been_set TYPE boole_d, END OF gty_s_retrieve_buffer
5 GTY_S_RETR_BY_ASSOC_BUFFER Private See coding 20120613 BEGIN OF gty_s_retr_by_assoc_buffer, mode TYPE /plmu/frw_retrieve_mode, buffer_table TYPE REF TO data, buffer_row TYPE REF TO data, END OF gty_s_retr_by_assoc_buffer
6 GTY_T_INVALID_NODE_ID Public See coding 20120605 gty_t_invalid_node_id TYPE SORTED TABLE OF gty_s_invalid_node_id WITH UNIQUE KEY node_id reason
Method Signatures

Method ACTIVATE_INVALIDATION_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ACTIVE Call by reference Type reference (TYPE) BOOLE_D ABAP_TRUE Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20120605

Method ACTIVATE_INVALIDATION_EVENT on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method ADD_CRITERIA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_OPTIONS Call by reference Type reference (TYPE) /PLMB/S_SPI_QUERY_OPTIONS 20120613
2 Importing IT_FILTER_NODE_ID Call by reference Type reference (TYPE) INDEX TABLE 20120613
3 Importing IT_REQUESTED_FIELD Call by reference Type reference (TYPE) /PLMB/T_SPI_REQUESTED_FIELD 20120613
4 Importing IT_SEL_PARAM Call by reference Type reference (TYPE) /PLMB/T_SPI_SELECTION_PARAM 20120613
5 Importing IV_FAILED Call by reference Type reference (TYPE) /PLMB/SPI_FAILED_IND 20120614
6 Importing IV_KEYS_ONLY Call by reference Type reference (TYPE) /PLMB/SPI_KEYS_ONLY_IND 20120613
7 Importing IV_QUERY_NAME Call by reference Type reference (TYPE) /PLMB/SPI_QUERY_NAME 20120613

Method ADD_CRITERIA on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method ADD_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_ALL_RECORDS_FAILED Call by reference Type reference (TYPE) BOOLE_D 20120605
2 Importing IT_INDEX_FAILED Call by reference Type reference (TYPE) /PLMB/T_SPI_RTR_INDEX_FAILED 20120605
3 Importing IT_NODE_ID Call by reference Type reference (TYPE) INDEX TABLE 20120605
4 Importing IT_REQUESTED_FIELD Call by reference Type reference (TYPE) /PLMB/T_SPI_REQUESTED_FIELD 20120614
5 Importing IV_FAILED Call by reference Type reference (TYPE) /PLMB/SPI_FAILED_IND 20120614
6 Importing IV_LOCK Call by reference Type reference (TYPE) /PLMB/SPI_LOCK_IND 20120605
7 Importing IV_NODE_NAME Call by reference Type reference (TYPE) /PLMB/SPI_NODE_NAME 20120614
8 Importing IV_TARGET_NODE_NAME Call by reference Type reference (TYPE) /PLMB/SPI_NODE_NAME 20120614

Method ADD_IDS on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method ADJUST_INDEX_FAILED_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_INDEX_FAILED Call by reference Type reference (TYPE) /PLMB/T_SPI_RTR_INDEX_FAILED 20120605

Method ADJUST_INDEX_FAILED_TABLE on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method ADJUST_NODE_ID_REL_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_NODE_ID_REL Call by reference Type reference (TYPE) /PLMB/T_SPI_NODE_REL 20120605

Method ADJUST_NODE_ID_REL_TABLE on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method ADJUST_RETRIEVE_BUFFER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_RETRIEVE_BUFFER Call by reference Type reference (TYPE) SORTED TABLE 20120605
2 Importing IT_INVALID_NODE_ID Call by reference Type reference (TYPE) GTY_T_INVALID_NODE_ID 20120605

Method ADJUST_RETRIEVE_BUFFER on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method ARE_ALL_ENTRIES_LOCKED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RETRIEVE_BUFFER Call by reference Type reference (TYPE) SORTED TABLE 20120605
2 Returning RV_ALL_ARE_LOCKED Value transfer Type reference (TYPE) BOOLE_D 20120605

Method ARE_ALL_ENTRIES_LOCKED on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method ASSOCIATE_WITH_CONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CONTEXT Call by reference Object reference (TYPE REF TO) /PLMU/IF_FRW_CONTEXT_INT Context (Internal Interface) 20120605

Method ASSOCIATE_WITH_CONTEXT on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method BUILD_DIRECT_RETRIEVE_BUFFER Signature

Method BUILD_DIRECT_RETRIEVE_BUFFER on class /PLMU/CL_FRW_RETR_FILTER_NODE has no parameter.
# Exception Resumable Description Created on
1 /PLMB/CX_SPI_METADATA SPI Metadata Exception (static) 20120605

Method BUILD_RETR_BY_ASSOC_BUFFER Signature

Method BUILD_RETR_BY_ASSOC_BUFFER on class /PLMU/CL_FRW_RETR_FILTER_NODE has no parameter.
# Exception Resumable Description Created on
1 /PLMB/CX_SPI_METADATA SPI Metadata Exception (static) 20120605

Method CLEAR_BUFFER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DIRECT_RETRIEVE Call by reference Type reference (TYPE) BOOLE_D 20120613
2 Importing IV_QUERY Call by reference Type reference (TYPE) BOOLE_D 20120613
3 Importing IV_RETRIEVE_BY_ASSOCIATION Call by reference Type reference (TYPE) BOOLE_D 20120613

Method CLEAR_BUFFER on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_NODE_METADATA Call by reference Object reference (TYPE REF TO) /PLMB/IF_SPI_METADATA_NODE UI Framework - node metadata 20120605

Method CONSTRUCTOR on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method DESTRUCT Signature

Method DESTRUCT on class /PLMU/CL_FRW_RETR_FILTER_NODE has no parameter.
Method DESTRUCT on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method FILTER_CRITERIA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_SKIP_QUERY Call by reference Type reference (TYPE) BOOLE_D 20120618
2 Importing IS_OPTIONS Call by reference Type reference (TYPE) /PLMB/S_SPI_QUERY_OPTIONS 20120613
3 Importing IT_FILTER_NODE_ID Call by reference Type reference (TYPE) INDEX TABLE 20120613
4 Importing IT_REQUESTED_FIELD Call by reference Type reference (TYPE) /PLMB/T_SPI_REQUESTED_FIELD 20120613
5 Importing IT_SEL_PARAM Call by reference Type reference (TYPE) /PLMB/T_SPI_SELECTION_PARAM 20120613
6 Importing IV_KEYS_ONLY Call by reference Type reference (TYPE) /PLMB/SPI_KEYS_ONLY_IND 20120613
7 Importing IV_QUERY_NAME Call by reference Type reference (TYPE) /PLMB/SPI_QUERY_NAME 20120613

Method FILTER_CRITERIA on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method FILTER_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_FILTERED_NODE_ID Call by reference Type reference (TYPE) INDEX TABLE 20120605
2 Importing IT_NODE_ID Call by reference Type reference (TYPE) INDEX TABLE 20120605
3 Importing IT_REQUESTED_FIELD Call by reference Type reference (TYPE) /PLMB/T_SPI_REQUESTED_FIELD 20120614
4 Importing IV_LOCK Call by reference Type reference (TYPE) /PLMB/SPI_LOCK_IND 20120605
5 Importing IV_NODE_NAME Call by reference Type reference (TYPE) /PLMB/SPI_NODE_NAME 20120614
6 Importing IV_TARGET_NODE_NAME Call by reference Type reference (TYPE) /PLMB/SPI_NODE_NAME 20120614

Method FILTER_IDS on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method GET_BUFFER_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EO_BUFFER_STRUCTURE Call by reference Object reference (TYPE REF TO) CL_ABAP_STRUCTDESCR 20120605
2 Exporting EO_BUFFER_TABLE Call by reference Object reference (TYPE REF TO) CL_ABAP_TABLEDESCR 20120605
3 Importing IO_NODE_METADATA Call by reference Object reference (TYPE REF TO) /PLMB/IF_SPI_METADATA_NODE 20120605
# Exception Resumable Description Created on
1 /PLMB/CX_SPI_METADATA SPI Metadata Exception (static) 20120605

Method GET_LATELY_FILTERED_INDEXES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_INDEX_OF_FILTERED_NODE_ID Call by reference Type reference (TYPE) /PLMU/TS_FRW_SYTABIX 20120605

Method GET_LATELY_FILTERED_INDEXES on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method GET_LOCKED_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_NODE_ID Call by reference Type reference (TYPE) INDEX TABLE 20120605

Method GET_LOCKED_IDS on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method GET_RETRIEVE_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_DIRECT_RETRIEVE Call by reference Type reference (TYPE) /PLMU/FRW_RETRIEVE_MODE 20120605
2 Exporting EV_QUERY Call by reference Type reference (TYPE) /PLMU/FRW_RETRIEVE_MODE 20120613
3 Exporting EV_RETRIEVE_BY_ASSOCIATION Call by reference Type reference (TYPE) /PLMU/FRW_RETRIEVE_MODE 20120605

Method GET_RETRIEVE_MODE on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method HAS_DATA_BEEN_CHANGED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_INVALID_NODE_ID Call by reference Type reference (TYPE) GTY_T_INVALID_NODE_ID 20120605
2 Returning RV_DATA_CHANGED Value transfer Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20120605

Method HAS_DATA_BEEN_CHANGED on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method HAS_RETRIEVE_MODE_BEEN_SET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RESULT Value transfer Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20120605

Method HAS_RETRIEVE_MODE_BEEN_SET on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method HNDL_AFTER_CONTEXT_INIT Signature

Method HNDL_AFTER_CONTEXT_INIT on class /PLMU/CL_FRW_RETR_FILTER_NODE has no parameter.
Method HNDL_AFTER_CONTEXT_INIT on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method HNDL_BEFORE_CONTEXT_DESTRUCT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CONTEXT Value transfer Attribute reference (LIKE) 20120605

Method HNDL_BEFORE_CONTEXT_DESTRUCT on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method HNDL_METADATA_CHANGED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_CHANGED_ATTRIBUTES Value transfer Attribute reference (LIKE) 20120605

Method HNDL_METADATA_CHANGED on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method INVALIDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_INVALID_NODE_ID Call by reference Type reference (TYPE) GTY_T_INVALID_NODE_ID 20120605

Method INVALIDATE on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method REMOVE_OBSOLETE_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_RETRIEVE_BUFFER Call by reference Type reference (TYPE) SORTED TABLE 20121004
2 Importing IT_NODE_ID Call by reference Type reference (TYPE) INDEX TABLE 20121004

Method REMOVE_OBSOLETE_IDS on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method SET_RETRIEVE_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DIRECT_RETRIEVE Call by reference Type reference (TYPE) /PLMU/FRW_RETRIEVE_MODE 20120605
2 Importing IV_QUERY Call by reference Type reference (TYPE) /PLMU/FRW_RETRIEVE_MODE 20120613
3 Importing IV_RETRIEVE_BY_ASSOCIATION Call by reference Type reference (TYPE) /PLMU/FRW_RETRIEVE_MODE 20120605

Method SET_RETRIEVE_MODE on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.

Method SET_RETRIEVE_MODE_FOR_CONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CONTEXT_INFO Call by reference Object reference (TYPE REF TO) /PLMU/IF_FRW_CONTEXT_INFO Context Info 20120605

Method SET_RETRIEVE_MODE_FOR_CONTEXT on class /PLMU/CL_FRW_RETR_FILTER_NODE has no exception.
Event Signatures

Event AFTER_INVALIDATION Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IRT_INVALID_NODE_ID Exporting Value transfer Object reference (TYPE REF TO) GTY_T_INVALID_NODE_ID Invalid Node IDs 20120605
2 IV_NODE_NAME Exporting Value transfer Type reference (TYPE) /PLMB/SPI_NODE_NAME Node Name 20120605
History
Last changed by/on SAP  20130531 
SAP Release Created in 732