SAP ABAP Class CL_CRM_ES_MGR_UI_ROUTINES (GUI ES Manager methods)
Hierarchy
WEBCUIF (Software Component) SAP Web UI Framework
   CA-WUI-ES (Application Component) Enterprise Search Integration
     CRM_ES_MODEL_MGR (Package) CRM Enterprise Search Modeling Manager
Properties
Class CL_CRM_ES_MGR_UI_ROUTINES  
Short Description GUI ES Manager methods    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package CRM_ES_MODEL_MGR   CRM Enterprise Search Modeling Manager 
Created 20080822   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
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_CRM_ES_MGR_UI_ROUTINES Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
Class CL_CRM_ES_MGR_UI_ROUTINES has no interface implemented.
Friends
Class CL_CRM_ES_MGR_UI_ROUTINES has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_CONNECTOR_FPATH Static Attribute Public Type reference (TYPE) CHAR4 ' / ' Filepath separator in UNIX systems 20081117
2 GC_TREE_NODE_TYPE_A Static Attribute Public Type reference (TYPE) CHAR1 'A' Tree node type attribute (A) 20080829
3 GC_TREE_NODE_TYPE_E Static Attribute Public Type reference (TYPE) CHAR1 'E' Tree node type E 20080829
4 GC_TREE_NODE_TYPE_F Static Attribute Public Type reference (TYPE) CHAR1 'F' Tree node type F 20081013
5 GC_TREE_NODE_TYPE_H Static Attribute Public Type reference (TYPE) CHAR1 'H' Tree node type business template (H) 20080829
6 GC_TREE_NODE_TYPE_K Static Attribute Public Type reference (TYPE) CHAR1 'K' New tree node type foreign key templates (K) 20081013
7 GC_TREE_NODE_TYPE_N Static Attribute Public Type reference (TYPE) CHAR1 'N' New tree node type relations of foreign key templates (N) 20081013
8 GC_TREE_NODE_TYPE_O Static Attribute Public Type reference (TYPE) CHAR1 'O' Tree node type O 20081013
9 GC_TREE_NODE_TYPE_R Static Attribute Public Type reference (TYPE) CHAR1 'R' Tree node type R 20081013
10 GC_TREE_NODE_TYPE_S Static Attribute Public Type reference (TYPE) CHAR1 'S' Tree node type structures (S) 20081013
11 GC_TREE_NODE_TYPE_T Static Attribute Public Type reference (TYPE) CHAR1 'T' Tree node type T 20081013
12 GC_TREE_NODE_TYPE_V Static Attribute Public Type reference (TYPE) CHAR1 'V' Tree node type Virtual Template (V) 20081022
13 GV_CURRENT_KEY Static Attribute Public Type reference (TYPE) LVC_NKEY Currently active node key of the ALV tree 20081013
Methods
# Method Level Visibility Method type Description Created on
1 CHECK Instance method Public Method Check the tree 20080822
2 CHECK_COPY_OF_TEMPLATES Instance method Public Method Checks if copy of template is possible 20090128
3 CHECK_SWITCHES Static method Public Method Check whether values entred are in the tables 20090120
4 CHECK_SWITCHES_IN_TREE Static method Public Method Check Switches 20090121
5 CHECK_SWITCH_IS_ACTIVE Static method Public Method Get active Switches 20090123
6 COPY Instance method Public Method Copys a seletected template 20090205
7 DETERMINE_FLAG Instance method Public Method Retruns true if a certain flag occurs at least once in a tab 20081014
8 EXECUTE_NAVIGATION Instance method Public Method Displays the desired panel subscreen 20081013
9 FILL_TO_TABLE_FIELDS Static method Public Method fills to default field-info 20091006
10 GET_ATTR_GRID_LAYOUT Static method Public Method Layout of attributes grid 20100519
11 GET_ATTR_STRUC_GRID_LAYOUT Static method Public Method Delivers the ALV Grid settings for attribute structure 20081104
12 GET_BOL_ROOT_PATH_STRING Static method Public Method Re-formats the given string to a path as text 20081114
13 GET_FKT_GRID_LAYOUT Static method Public Method Delivers the ALV Grid settings for FK Templates 20081104
14 GET_FKT_REL_GRID_LAYOUT Static method Public Method Delivers the ALV Grid settings for FK Templates 20081104
15 GET_GRID_TOOLBAR Static method Public Method Get the GRID toolbar with all meaningful buttons 20081030
16 GET_SWITCHES Static method Public Method Returns Switches 20090120
17 GET_TABLE_FIELDS Static method Public Method returns table fields 20091006
18 GET_TEMPLATE_NODEKEY Instance method Public Method Return the node key of the given template 20080828
19 INSERT_NODE Instance method Public Method insertion of a new node during runtime 20090202
20 IS_SWITCH_ACTIVE Static method Public Method Returns true if the switch id on 20090123
21 MESSAGES_INITIALIZE Static method Public Method Initialize Message 20081212
22 MESSAGES_SHOW Static method Public Method show messages in list 20081212
23 MESSAGES_STORE Static method Public Method stor messages 20081212
24 SHOW_GRID Instance method Public Method Brings up the ALV Grid on the dynpro 20080908
Events
Class CL_CRM_ES_MGR_UI_ROUTINES has no event.
Types
Class CL_CRM_ES_MGR_UI_ROUTINES has no local type.
Method Signatures

Method CHECK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_PASSED Call by reference Type reference (TYPE) CRM_ES_SELECT Select Indicator 20080822
2 Importing IO_NODE_OBJECT Value transfer Object reference (TYPE REF TO) IF_CRM_ES_MODEL_TREE_NODE ALV Tree Control: Node Key 20080822
3 Importing IR_TREE_MODEL Value transfer Object reference (TYPE REF TO) CL_CRM_ES_MODEL_UI ES Modelling UI Class 20080822
4 Importing IV_SILENT_MODE Call by reference Type reference (TYPE) BOOLEAN No messages will be brought up 20080822
5 Importing IV_TEMPLATE_ID Value transfer Type reference (TYPE) CRM_ES_TEMPLATE_ID Template ID for CRM ES 20080822

Method CHECK on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method CHECK_COPY_OF_TEMPLATES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_CHECK_OK Call by reference Type reference (TYPE) ABAP_BOOL 20090128
2 Importing IV_TEMPLATE_ID Call by reference Type reference (TYPE) CRM_ES_TEMPLATE_ID Template ID for CRM ES 20090128
3 Importing IV_TEMPLATE_ID_SOURCE Call by reference Type reference (TYPE) CRM_ES_TEMPLATE_ID Template ID for CRM ES 20090128
4 Importing IV_TEMPLATE_SET_ID Call by reference Type reference (TYPE) CRM_ES_TEMPLATE_SET Template Set ID 20090128
# Exception Resumable Description Created on
1 CX_CRM_ES_FAULT CRM ES exception class 20090128

Method CHECK_SWITCHES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_IS_OK Call by reference Type reference (TYPE) ABAP_BOOL 20090120
2 Exporting EV_REACTION_IS_VALID Call by reference Type reference (TYPE) ABAP_BOOL Boolean Variable (X=True, -=False, Space=Unknown) 20090120
3 Exporting EV_SWITCH_IS_VALID Call by reference Type reference (TYPE) ABAP_BOOL Boolean Variable (X=True, -=False, Space=Unknown) 20090120
4 Importing IV_REACTION Call by reference Type reference (TYPE) CRMS_ES_HEADER_SCRN_DATA-REACTION Reaction to Switch 20090120
5 Importing IV_SWITCH_ID Value transfer Type reference (TYPE) CRMS_ES_HEADER_SCRN_DATA-SWITCH_ID Id of a Switch in Switch Framework 20090120

Method CHECK_SWITCHES on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method CHECK_SWITCHES_IN_TREE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_IS_OK Call by reference Type reference (TYPE) ABAP_BOOL 20090121
2 Exporting EV_REACTION_IS_VALID Call by reference Type reference (TYPE) ABAP_BOOL Boolean Variable (X=True, -=False, Space=Unknown) 20090121
3 Exporting EV_SWITCH_IS_VALID Call by reference Type reference (TYPE) ABAP_BOOL Boolean Variable (X=True, -=False, Space=Unknown) 20090121
4 Importing IR_MESSAGES Call by reference Object reference (TYPE REF TO) BAPIRETTAB Table with BAPI Return Information 20090123
5 Importing IV_REACTION Call by reference Type reference (TYPE) CRMS_ES_HEADER_SCRN_DATA-REACTION Reaction to Switch 20090121
6 Importing IV_SWITCH_ID Value transfer Type reference (TYPE) CRMS_ES_HEADER_SCRN_DATA-SWITCH_ID Id of a Switch in Switch Framework 20090121

Method CHECK_SWITCHES_IN_TREE on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method CHECK_SWITCH_IS_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SWITCH_ID Call by reference Type reference (TYPE) SFW_SWITCH_ID Id of a Switch in Switch Framework 20090123
2 Importing IV_SWITCH_MUST_BE_ACTIVE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Switch is sopposed to be active 20090219
3 Returning RV_VALID Value transfer Type reference (TYPE) ABAP_BOOL Switch is valid / active 20090219

Method CHECK_SWITCH_IS_ACTIVE on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method COPY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_REFRESH_NECESSARY Call by reference Type reference (TYPE) BOOLEAN A refresh of the tree is recommended/necessary after calling 20090205
2 Importing IR_MODEL Call by reference Object reference (TYPE REF TO) CL_CRM_ES_MODEL_UI ES Modelling UI Class 20090205
3 Importing IR_TREE Value transfer Object reference (TYPE REF TO) CL_GUI_ALV_TREE ALV Tree Control 20090205
4 Importing IV_CURRENT_KEY Value transfer Type reference (TYPE) LVC_NKEY The current key of the node in the tree 20090205
5 Importing IV_CURRENT_TEMPLATE_ID Value transfer Type reference (TYPE) CRM_ES_TEMPLATE_ID Template ID for CRM ES 20090205
6 Importing IV_CURRENT_TEMPLATE_SET Value transfer Type reference (TYPE) CRM_ES_TEMPLATE_SET Template Set ID 20090205
7 Importing IV_TARGET_TEMPLATE_ID Value transfer Type reference (TYPE) CRM_ES_TEMPLATE_ID Template Set ID 20090205
8 Importing IV_TARGET_TEMPLATE_SET_ID Value transfer Type reference (TYPE) CRM_ES_TEMPLATE_SET Template Set ID 20090205
9 Importing IV_TTS_DIFF Call by reference Type reference (TYPE) BOOLEAN Set to true, a copy to a different Template Set is attempted 20090210

Method COPY on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method DETERMINE_FLAG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_FLAG_SET Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20081014
2 Importing IS_STRUCTURE Call by reference Type reference (TYPE) CRMS_ES_ATTR_DATA_SCRN ES BOL Attribute Data for Screen 20081014
3 Importing IT_TABLE Call by reference Type reference (TYPE) CRMT_ES_ATTR_DATA_TAB Attribute data table type 20081014
4 Importing IV_FLAG_NAME Call by reference Type reference (TYPE) CHAR32 Character field, length 32 20081014

Method DETERMINE_FLAG on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method EXECUTE_NAVIGATION Signature

Method EXECUTE_NAVIGATION on class CL_CRM_ES_MGR_UI_ROUTINES has no parameter.
Method EXECUTE_NAVIGATION on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method FILL_TO_TABLE_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_KEY_FIELDS Call by reference Type reference (TYPE) CRMT_ES_KEY_FIELDS Key fields for ES 20091006
2 Changing CT_TABLE_FIELDS Call by reference Type reference (TYPE) CRMT_ES_ATTR_DATA_TO_TAB Attribute data table type 20091006
3 Changing CV_TABLE_NAME Call by reference Type reference (TYPE) TABNAME Table Name 20091006

Method FILL_TO_TABLE_FIELDS on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method GET_ATTR_GRID_LAYOUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_LAYOUT Call by reference Type reference (TYPE) LVC_S_LAYO ALV control: Layout structure 20100519
2 Exporting ET_FIELDCATALOG Call by reference Type reference (TYPE) LVC_T_FCAT Field Catalog for List Viewer Control 20100519
3 Exporting ET_SORTING Call by reference Type reference (TYPE) LVC_T_SORT ALV Control: Table of Sort Criteria 20100519
4 Importing IV_EDIT_MODE Call by reference Type reference (TYPE) ABAP_BOOL true = Edit allowed 20100908

Method GET_ATTR_GRID_LAYOUT on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method GET_ATTR_STRUC_GRID_LAYOUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_LAYOUT Call by reference Type reference (TYPE) LVC_S_LAYO ALV control: Layout structure 20081104
2 Exporting ET_FIELDCATALOG Call by reference Type reference (TYPE) LVC_T_FCAT Field Catalog for List Viewer Control 20081104
3 Exporting ET_SORTING Call by reference Type reference (TYPE) LVC_T_SORT ALV Control: Table of Sort Criteria 20081104
4 Importing IV_EDIT_MODE Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20081104
5 Importing IV_SHOW_LANGFLD Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20081104

Method GET_ATTR_STRUC_GRID_LAYOUT on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method GET_BOL_ROOT_PATH_STRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_PATH Call by reference Type reference (TYPE) STANDARD TABLE Table with path as text for use with cl_gui_textedit 20081114
2 Exporting EV_PATH_HTML Call by reference Type reference (TYPE) STRING The complete HTML-enriched path for use with cl_dd_document 20081114
3 Importing IT_PATH_TAB Call by reference Type reference (TYPE) CRMT_ES_FOREIGN_REL_PATH_TAB RelationPath Table 20081117
4 Importing IV_HEADING_TEXT Call by reference Type reference (TYPE) STRING The plain text for the page heading 20081114
5 Importing IV_HTML Call by reference Type reference (TYPE) BOOLEAN set to true, output string will be enriched with HTML 20081114
6 Importing IV_PATH_STRING Call by reference Type reference (TYPE) CRM_ES_STRING The string to re-format into a good looking path text 20081114
7 Importing IV_REPL_CONNECTOR Call by reference Type reference (TYPE) STRING The connector to replace in IV_PATH_STRING 20081117

Method GET_BOL_ROOT_PATH_STRING on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method GET_FKT_GRID_LAYOUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_LAYOUT Call by reference Type reference (TYPE) LVC_S_LAYO ALV control: Layout structure 20081104
2 Exporting ET_FIELDCATALOG Call by reference Type reference (TYPE) LVC_T_FCAT Field Catalog for List Viewer Control 20081104
3 Exporting ET_SORTING Call by reference Type reference (TYPE) LVC_T_SORT ALV Control: Table of Sort Criteria 20081104

Method GET_FKT_GRID_LAYOUT on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method GET_FKT_REL_GRID_LAYOUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_LAYOUT Call by reference Type reference (TYPE) LVC_S_LAYO ALV control: Layout structure 20081104
2 Exporting ET_FIELDCATALOG Call by reference Type reference (TYPE) LVC_T_FCAT Field Catalog for List Viewer Control 20081104
3 Exporting ET_SORTING Call by reference Type reference (TYPE) LVC_T_SORT ALV Control: Table of Sort Criteria 20081104

Method GET_FKT_REL_GRID_LAYOUT on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method GET_GRID_TOOLBAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_EXCLUDED_BUTTONS Call by reference Type reference (TYPE) UI_FUNCTIONS Function Code Table 20081030
2 Importing IV_EXCLUDE_ALL Call by reference Type reference (TYPE) BOOLEAN set to true, no buttons shown in toolbar 20081030
3 Importing IV_SHOW_PERS_ONLY Call by reference Type reference (TYPE) BOOLEAN set to true, only personalization relevant buttons shown 20100519

Method GET_GRID_TOOLBAR on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method GET_SWITCHES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SWITCHES Call by reference Type reference (TYPE) SFW_SW_TAB Switches / Switch Framework 20090120
2 Importing IV_SWITCH_ID Call by reference Type reference (TYPE) SFW_SWITCH_ID Switches / Switch Framework 20090120

Method GET_SWITCHES on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method GET_TABLE_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_TABLE_FIELDS Call by reference Type reference (TYPE) CRMT_ES_ATTR_DATA_TO_TAB Attribute data table type 20091006
2 Importing IV_TABLE_NAME Call by reference Type reference (TYPE) TABNAME Table Name 20091006

Method GET_TABLE_FIELDS on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method GET_TEMPLATE_NODEKEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_NODE_KEY Call by reference Type reference (TYPE) LVC_NKEY ALV Tree Control: Node Key 20080828
2 Importing IS_MAPENTRY Call by reference Type reference (TYPE) CRMS_ES_UITREEMAP Enterprise Search mapping UI tree node key and node object 20080829
3 Importing IS_NODE_DATA Call by reference Type reference (TYPE) CRMS_ES_NODE_DATA Template ID for CRM ES 20080829
4 Importing IV_TEMPLATE_ID Call by reference Type reference (TYPE) CRM_ES_TEMPLATE_ID The template ID of which to find the node key 20080829

Method GET_TEMPLATE_NODEKEY on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method INSERT_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_REFRESH_NECESSARY Call by reference Type reference (TYPE) BOOLEAN A refresh of the tree is recommended/necessary after calling 20090202
2 Importing IR_MODEL_NODE Value transfer Object reference (TYPE REF TO) IF_CRM_ES_MODEL_TREE_NODE ES model tree node 20090202
3 Importing IR_TREE Value transfer Object reference (TYPE REF TO) CL_GUI_ALV_TREE ALV Tree Control 20090202
4 Importing IV_CURRENT_KEY Value transfer Type reference (TYPE) LVC_NKEY ALV Tree Control: Node Key 20090202

Method INSERT_NODE on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method IS_SWITCH_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SWITCH_ID Call by reference Type reference (TYPE) SFW_SWITCH_ID Id of a Switch in Switch Framework 20090123
2 Returning RV_ON Value transfer Type reference (TYPE) ABAP_BOOL Boolean Variable (X=True, -=False, Space=Unknown) 20090123

Method IS_SWITCH_ACTIVE on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method MESSAGES_INITIALIZE Signature

Method MESSAGES_INITIALIZE on class CL_CRM_ES_MGR_UI_ROUTINES has no parameter.
Method MESSAGES_INITIALIZE on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method MESSAGES_SHOW Signature

Method MESSAGES_SHOW on class CL_CRM_ES_MGR_UI_ROUTINES has no parameter.
Method MESSAGES_SHOW on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method MESSAGES_STORE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_BAPIRETURN Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20081212
2 Importing IV_LINE Call by reference Type reference (TYPE) I 20081212

Method MESSAGES_STORE on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.

Method SHOW_GRID Signature

Method SHOW_GRID on class CL_CRM_ES_MGR_UI_ROUTINES has no parameter.
Method SHOW_GRID on class CL_CRM_ES_MGR_UI_ROUTINES has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 700