SAP ABAP Class CL_PS_HLP_ESH_UTIL (Common methods and data for ES_HLP)
Hierarchy
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   PS (Application Component) Project System
     PS_HLP_CACHE (Package) Handling Large Projects:-Cache
Properties
Class CL_PS_HLP_ESH_UTIL  
Short Description Common methods and data for ES_HLP    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package PS_HLP_CACHE   Handling Large Projects:-Cache 
Created 20100430   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)
Interfaces
Class CL_PS_HLP_ESH_UTIL has no interface implemented.
Friends
Class CL_PS_HLP_ESH_UTIL has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 C_CACHE_BEINGPROCESSED Static Attribute Public Type reference (TYPE) CHAR1 'B' Single-Character Flag 20101215
2 C_CACHE_INVALID Static Attribute Public Type reference (TYPE) CHAR1 'I' Single-Character Flag 20101215
3 C_CACHE_VALID Static Attribute Public Type reference (TYPE) CHAR1 'V' Single-Character Flag 20101215
4 C_OPERATOR_EQUAL Static Attribute Public Type reference (TYPE) CHAR2 'EQ' Version Number Component 20100628
5 C_OPERATOR_INCLUDE Static Attribute Public Type reference (TYPE) CHAR1 'I' Single-Character Flag 20100628
6 C_OTYPE_NETWORK Static Attribute Public Type reference (TYPE) CHAR2 'NP' Version Number Component 20100629
7 C_TREX_ACL Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'ACL' Node Name 20100613
8 C_TREX_ACTIVITY Constant Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'ACTY' Node Name 20100531
9 C_TREX_ACTY_COLLPR Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'COLLECTIVE_PR' Node Name 20100616
10 C_TREX_ACTY_USER Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'USER' Node Name 20100905
11 C_TREX_BO_ACL Static Attribute Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_ACL' Object Type 20100613
12 C_TREX_BO_ACPR Static Attribute Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_COLLPR_ACTY' Object Type 20100616
13 C_TREX_BO_ACTY Constant Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_ACTY' Object Type 20100531
14 C_TREX_BO_HIERARCHY Constant Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_HIERARCHY' Object Type 20100529
15 C_TREX_BO_MATERIAL Static Attribute Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_MATERIAL_ASG' Object Type 20100619
16 C_TREX_BO_MLST Constant Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_MLST' Object Type 20100531
17 C_TREX_BO_NTWK Constant Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_NTWK' Object Type 20100531
18 C_TREX_BO_PROJECT Constant Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_PROJECT' Object Type 20100529
19 C_TREX_BO_RELT Constant Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_ACTY_REL' Object Type 20100531
20 C_TREX_BO_STATUS Static Attribute Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_STATUS' Object Type 20100613
21 C_TREX_BO_STATUS_PROF Static Attribute Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_STATUS_PROF' Object Type 20100613
22 C_TREX_BO_STEXT Static Attribute Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_STEXT' Object Type 20100613
23 C_TREX_BO_WBS Constant Public Type reference (TYPE) ESH_E_OM_OBJECT_TYPE 'PSHLP_WBS' Object Type 20100531
24 C_TREX_COLLPR Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'COLLECTIVE_PR' Node Name 20100612
25 C_TREX_DATES Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'DATES' Node Name 20100612
26 C_TREX_HIERARCHY_HEADER Constant Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'HIERARCHY_HEADER' Node Name 20100529
27 C_TREX_HIERARCHY_ITEMS Constant Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'HIERARCHY_ITEMS' Node Name 20100529
28 C_TREX_MLST Constant Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'MLST' Node Name 20100531
29 C_TREX_NTWK Constant Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'NTWK' Node Name 20100531
30 C_TREX_NTWK_AFFL Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'AFFL' Node Name 20100612
31 C_TREX_NTWK_AFIH Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'AFIH' Node Name 20100612
32 C_TREX_NTWK_AFPO Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'AFPO' Node Name 20100612
33 C_TREX_OBJNR Static Attribute Public Type reference (TYPE) STRING 'OBJNR' 20100628
34 C_TREX_PROJECT Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'PROJECT' Node Name 20100612
35 C_TREX_REL Constant Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'REL' Node Name 20100531
36 C_TREX_RESB Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'RESB' Node Name 20100619
37 C_TREX_RSDB Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'RSDB' Node Name 20100622
38 C_TREX_RSDBS Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'RSDBS' Node Name 20100622
39 C_TREX_SEPERATOR Static Attribute Public Type reference (TYPE) CHAR1 '$' Single-Character Flag 20100628
40 C_TREX_STATUS Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'OBJECT_STATUS' Node Name 20100613
41 C_TREX_STAT_PROF Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'STATUS_PROFILE' Node Name 20100613
42 C_TREX_STEXT Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'STEXT' Node Name 20100613
43 C_TREX_SWCOMP Static Attribute Public Type reference (TYPE) ESH_E_OM_SYSREL 'EA-APPL' Software Component 20100617
44 C_TREX_WBS Constant Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'WBS' Node Name 20100530
45 C_TREX_WBS_HIER Static Attribute Public Type reference (TYPE) ESH_E_OM_NODE_NAME 'WBS_HIER' Node Name 20100616
46 MR_ESH_UTIL Static Attribute Public Object reference (TYPE REF TO) CL_PS_HLP_ESH_UTIL Common methods and data for ES_HLP 20100430
47 MR_TREX_ACTIVE_STATUS Static Attribute Private Type reference (TYPE) CHAR1 Boolean Variable (X=True, -=False, Space=Unknown) 20100531
48 MT_HIER_DATA Instance attribute Public Type reference (TYPE) PSHLP_HIER_TAB_TYP Table type for PS hierarchy 20100430
49 MV_STEXT_CP_MARKED Static Attribute Private Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20101011
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_HEADER_IN_CACHE Static method Public Method Checks whether header object is cached or not 20101017
2 CHECK_STEXT_CP_MARKED Static method Public Method check whether changepointer is already set for shortext 20101011
3 CHECK_TREX_DATA_MODIFIED Static method Private Method To check weather data is changed in the BO 20100614
4 CHECK_TREX_EXISTENCE Static method Public Method Check if object exists in TREX 20100813
5 DEACTIVATE_CACHE Static method Public Method Switch cache flag to false 20100921
6 DELETE_OBJECTS Static method Public Method 20100505
7 GET_HIERARCHY Static method Public Method Retrieve the list of hierarchy objects 20100504
8 GET_INSTANCE Static method Public Method 20100430
9 GET_OBJECTS Static method Public Method 20100505
10 GET_TREX_ACTIVE Static method Public Method To retreive the status of trex activation 20100524
11 INITIAL_LOAD Instance method Public Method 20100430
12 LOG_MESSAGE Static method Public Method Log messages in PSHLP90 for DB cache 20101115
13 REPORT_MESSAGE Static method Public Method 20100602
14 REQUEST_TREX Static method Private Method 20100608
15 RESPONSE_TREX Static method Private Method 20100608
16 SEARCH_TREX Static method Public Method 20100608
17 SET_STEXT_CP_MARKED Static method Public Method Mark flag to indicate changepointer is set for shortext 20101011
Events
Class CL_PS_HLP_ESH_UTIL has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 LTY_ATTRIBUTES Public See coding 20100611 BEGIN OF lty_attributes, name TYPE string, values TYPE RANGE OF char255, END OF lty_attributes
2 ST_ATTRIBUTE Public See coding 20100513 BEGIN OF st_attribute, name TYPE string, value TYPE string, select_options TYPE esh_t_if_select_options, END OF st_attribute
3 TT_ATTRIBUTES Public See coding 20100513 tt_attributes TYPE STANDARD TABLE OF st_attribute
Method Signatures

Method CHECK_HEADER_IN_CACHE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_EXPIRY_DATE Call by reference Type reference (TYPE) PS_EXPIRY_DATE Date from Which Cached Data Is Invalid 20101017
2 Exporting EV_OBJECT_IS_CACHED Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20101017
3 Exporting EV_OBJNR Call by reference Type reference (TYPE) J_OBJNR Object Number 20101017
4 Importing IV_OBJNR Call by reference Type reference (TYPE) J_OBJNR Object Number 20101017

Method CHECK_HEADER_IN_CACHE on class CL_PS_HLP_ESH_UTIL has no exception.

Method CHECK_STEXT_CP_MARKED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_STEXT_CP_MARKED Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20101011

Method CHECK_STEXT_CP_MARKED on class CL_PS_HLP_ESH_UTIL has no exception.

Method CHECK_TREX_DATA_MODIFIED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_OBJECT_TYPE_ID Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20100614
2 Exporting RV_IS_MODIFIED Call by reference Type reference (TYPE) ABAP_BOOL 20100614

Method CHECK_TREX_DATA_MODIFIED on class CL_PS_HLP_ESH_UTIL has no exception.

Method CHECK_TREX_EXISTENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_DATA_EXISTS Call by reference Type reference (TYPE) BOOLE Boolean variable 20100813
2 Exporting EV_EXPIRY_DATE Call by reference Type reference (TYPE) PS_EXPIRY_DATE Date from Which Cached Data Is Invalid 20100813
3 Exporting EV_HEADER Call by reference Type reference (TYPE) J_OBJNR Object Number 20101018
4 Importing IV_OBJNR Call by reference Type reference (TYPE) J_OBJNR Object Number 20100813

Method CHECK_TREX_EXISTENCE on class CL_PS_HLP_ESH_UTIL has no exception.

Method DEACTIVATE_CACHE Signature

Method DEACTIVATE_CACHE on class CL_PS_HLP_ESH_UTIL has no parameter.
Method DEACTIVATE_CACHE on class CL_PS_HLP_ESH_UTIL has no exception.

Method DELETE_OBJECTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_OBJECTS Call by reference Type reference (TYPE) PSHLP_HIER_HEADER_TT Hierarchy header 20100505

Method DELETE_OBJECTS on class CL_PS_HLP_ESH_UTIL has no exception.

Method GET_HIERARCHY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_HIERARCHY Value transfer Type reference (TYPE) PSHLP_TREX_HIER_ITEMS_TT Table type for PS hierarchy 20100612
2 Exporting ET_OBJECTS Call by reference Type reference (TYPE) PSHLP_HIER_HEADER_TT Hierarchy header 20100504
3 Importing IT_OBJECTS Call by reference Type reference (TYPE) PSHLPDB_OBJECT_TT TREX object list 20100902

Method GET_HIERARCHY on class CL_PS_HLP_ESH_UTIL has no exception.

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ER_ESH_UTIL Call by reference Object reference (TYPE REF TO) CL_PS_HLP_ESH_UTIL Common methods and data for ES_HLP 20100430

Method GET_INSTANCE on class CL_PS_HLP_ESH_UTIL has no exception.

Method GET_OBJECTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_OBJECTS Call by reference Type reference (TYPE) PSHLP_HIER_HEADER_TT Hierarchy header 20100505
2 Importing OBJ_TYPE Call by reference Type reference (TYPE) J_OBART Object Type 20100505

Method GET_OBJECTS on class CL_PS_HLP_ESH_UTIL has no exception.

Method GET_TREX_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_STATUS Value transfer Type reference (TYPE) PS_CACHE_STATUS Boolean Variable (X=True, -=False, Space=Unknown) 20100524
2 Importing IV_SKIP_BUFFER Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20101007

Method GET_TREX_ACTIVE on class CL_PS_HLP_ESH_UTIL has no exception.

Method INITIAL_LOAD Signature

Method INITIAL_LOAD on class CL_PS_HLP_ESH_UTIL has no parameter.
Method INITIAL_LOAD on class CL_PS_HLP_ESH_UTIL has no exception.

Method LOG_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_AUFNR Call by reference Type reference (TYPE) AUFNR Order Number 20101115
2 Importing I_DESCR Call by reference Type reference (TYPE) PS_POST1 PS: Short description (1st text line) 20101115
3 Importing I_MSGNO Call by reference Type reference (TYPE) SY-MSGNO Message Number 20101115
4 Importing I_MSGTYP Call by reference Type reference (TYPE) SYMSGTY Message Type 20101115
5 Importing I_MSGV1 Call by reference Type reference (TYPE) SYMSGV Message Variable 20101115
6 Importing I_MSGV2 Call by reference Type reference (TYPE) SYMSGV Message Variable 20101115
7 Importing I_MSGV3 Call by reference Type reference (TYPE) SYMSGV Message Variable 20101115
8 Importing I_MSGV4 Call by reference Type reference (TYPE) SYMSGV Message Variable 20101115
9 Importing I_PSPID Call by reference Type reference (TYPE) PS_PSPID Project definition 20101115
10 Importing I_WBS Call by reference Type reference (TYPE) PS_POSID Work Breakdown Structure Element (WBS Element) 20101115

Method LOG_MESSAGE on class CL_PS_HLP_ESH_UTIL has no exception.

Method REPORT_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_AUFNR Call by reference Type reference (TYPE) AUFNR Order Number 20100602
2 Importing I_DESCR Call by reference Type reference (TYPE) PS_POST1 PS: Short description (1st text line) 20100602
3 Importing I_MSGNO Call by reference Type reference (TYPE) SY-MSGNO Message Number 20100602
4 Importing I_MSGTYP Call by reference Type reference (TYPE) SYMSGTY Message Type 20100602
5 Importing I_MSGV1 Call by reference Type reference (TYPE) SYMSGV Message Variable 20100602
6 Importing I_MSGV2 Call by reference Type reference (TYPE) SYMSGV Message Variable 20100602
7 Importing I_MSGV3 Call by reference Type reference (TYPE) SYMSGV Message Variable 20100602
8 Importing I_MSGV4 Call by reference Type reference (TYPE) SYMSGV Message Variable 20100602
9 Importing I_PSPID Call by reference Type reference (TYPE) PS_PSPID Project definition 20100602
10 Importing I_WBS Call by reference Type reference (TYPE) PS_POSID Work Breakdown Structure Element (WBS Element) 20100602

Method REPORT_MESSAGE on class CL_PS_HLP_ESH_UTIL has no exception.

Method REQUEST_TREX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CR_REQUEST_OBJECT Call by reference Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_REQUEST Search Request 20100608
2 Importing IT_SEARCH_ATTRIBUTES Call by reference Type reference (TYPE) TT_ATTRIBUTES 20100608
3 Importing IV_BUSINESS_OBJECT Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20100608
4 Importing IV_NODE_NAME Call by reference Type reference (TYPE) ESH_E_OM_NODE_NAME SPACE Node Name 20100608
5 Importing IV_SEARCH_MODE Call by reference Type reference (TYPE) TREXD_TERM_ACTION 'E' Term action (Exact, fuzzy, linquistic search) 20100608
6 Importing IV_SEARCH_TEXT Call by reference Type reference (TYPE) STRING '*' 20100608
# Exception Resumable Description Created on
1 CX_ESH_CO_ENGINE Common ESH Engine Exception 20100622

Method RESPONSE_TREX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) INDEX TABLE Search result 20100610
2 Importing IR_REQUEST_OBJECT Call by reference Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_REQUEST Search Request 20100608
3 Importing IV_BO_NODE_NAME Call by reference Type reference (TYPE) ESH_E_OM_NODE_NAME Node name 20100610
4 Importing IV_BO_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20100610
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20100622
2 CX_ESH_IF_NO_MORE_ENTRIES ESH Interface Search: No more entries 20100622

Method SEARCH_TREX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) INDEX TABLE search result data 20100610
2 Importing IT_SEARCH_ATTRIBUTES Call by reference Type reference (TYPE) TT_ATTRIBUTES search attributes 20100608
3 Importing IV_BUSINESS_OBJECT Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20100608
4 Importing IV_NODE_NAME Call by reference Type reference (TYPE) ESH_E_OM_NODE_NAME SPACE Node Name 20100608
5 Importing IV_SEARCH_TEXT Call by reference Type reference (TYPE) STRING '*' 20100608
# Exception Resumable Description Created on
1 CX_ESH_CO_ENGINE Common ESH Engine Exception 20100726
2 CX_ESH_IF_ENGINE ESH Interface Exception 20100726
3 CX_ESH_IF_NO_MORE_ENTRIES ESH Interface Search: No more entries 20100622

Method SET_STEXT_CP_MARKED Signature

Method SET_STEXT_CP_MARKED on class CL_PS_HLP_ESH_UTIL has no parameter.
Method SET_STEXT_CP_MARKED on class CL_PS_HLP_ESH_UTIL has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 606