SAP ABAP Class CL_ESH_SE_RUNTIME_DATA_CLUSTER (Runtime Data from Cluster Table)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_SEARCH (Package) Search (internal)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_SE_RUNTIME_DATA	ESH Search Runtime Data	20080809
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_SE_RUNTIME_DATA_UPDATE	ESH Search Runtime Data Update	20080810

Properties

Class	CL_ESH_SE_RUNTIME_DATA_CLUSTER
Short Description	Runtime Data from Cluster Table
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_SEARCH	Search (internal)
Created	20080809	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	IF_ESH_SE_RUNTIME_DATA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_SE_RUNTIME_DATA	☐	☐	ESH Search Runtime Data	20080809
2	IF_ESH_SE_RUNTIME_DATA_UPDATE	☐	☐	ESH Search Runtime Data Update	20080810

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_SE_RUNTIME_DATA	☐	20080809	Runtime Data
2	CL_ESH_SE_RUNTIME_DATA_CACHE_1	☐	20091106	Runtime Data: Cache access
3	CL_ESH_SE_RUNTIME_DATA_CCL	☐	20091103	Runtime Data: Cache client
4	CL_ESH_SE_RUNTIME_DATA_CCL_AI1	☐	20091029	Runtime Data: Cache client

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_APPLOG	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application log	20080811
2	MO_LOCK	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_CO_LOCK		Lock on a database table	20080812
3	MT_CATEGORIES	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CATEGORIES_SORTED		Categories (sorted)	20080809
4	MT_CONNECTORS	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CONNECTORS_SORTED		Connectors (sorted)	20080809
5	MT_CONNECTOR_DELETIONS	Instance attribute	Protected	☐	Type reference (TYPE)	T_CONNECTOR_IDS		Connector IDs (sorted) for deletion	20080812
6	MT_CONNECTOR_EXECUTIONS	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_SEARCH_EXEC_SORTED		Connector execution (sorted)	20080812
7	MT_CONNECTOR_STATUS	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_T_SE_CONNECTORS_STATUS		Connector status	20080812
8	MT_CONNECTOR_STATUS_ALL	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CONNECTORS_STATUS_ALL_SORTED			20090123
9	MT_KEYWORDS	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_KEYWORDS_SORTED		Table of language-dependent keywords (sorted)	20090515
10	MT_KEYWORD_DELETIONS	Instance attribute	Protected	☐	Type reference (TYPE)	T_GENERAL_IDS			20090515
11	MT_OBJECT_TYPES_BY_SYS	Instance attribute	Protected	☐	Type reference (TYPE)	T_OBJECT_TYPES_BY_SYS		Object types	20090119
12	MT_OBJECT_TYPE_DELETIONS	Instance attribute	Protected	☐	Type reference (TYPE)	T_GENERAL_IDS		Object type IDs for deletion	20090109
13	MT_OBJECT_TYPE_IDS_BY_SYS	Instance attribute	Protected	☐	Type reference (TYPE)	T_OBJECT_TYPE_IDS_OF_SYS			20090119
14	MT_TEMPLATES	Instance attribute	Protected	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_TEMPLATES_SORTED		Templates (sorted)	20080809
15	MV_CATEGORIES_IMPORTED	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Categories imported	20080814
16	MV_KEYWORDS_IMPORTED	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20090520
17	MV_TEMPLATES_IMPORTED	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20080814
18	MV_UPDATE_CATEGORIES	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20080812
19	MV_UPDATE_INVALID_BUFFER	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20090127
20	MV_UPDATE_KEYWORDS	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20090515
21	MV_UPDATE_TEMPLATES	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20080812
22	SC_CLUSTER_NAME	Constant	Protected	☐	Type reference (TYPE)	TABNAME	'ESH_SE_RUNTIME'	Cluster table name	20080812
23	SC_ID_CATEGORIES	Constant	Protected	☐	Type reference (TYPE)	ESH_E_SE_GENERAL_LONG_ID	IF_ESH_SE_RUNTIME_DATA=>SC_ID_CATEGORIES	ID for categories	20080812
24	SC_ID_TEMPLATES	Constant	Protected	☐	Type reference (TYPE)	ESH_E_SE_GENERAL_LONG_ID	IF_ESH_SE_RUNTIME_DATA=>SC_ID_TEMPLATES	ID for templates	20080812
25	SC_RELID_CATEGORY	Constant	Protected	☐	Type reference (TYPE)	INDX_RELID	IF_ESH_SE_RUNTIME_DATA=>SC_RELID_CATEGORY	Category region in IMPORT/EXPORT	20080812
26	SC_RELID_CONNECTOR	Constant	Protected	☐	Type reference (TYPE)	INDX_RELID	IF_ESH_SE_RUNTIME_DATA=>SC_RELID_CONNECTOR	Connector region in IMPORT/EXPORT	20080812
27	SC_RELID_CONNECTOR_EXEC	Constant	Protected	☐	Type reference (TYPE)	INDX_RELID	IF_ESH_SE_RUNTIME_DATA=>SC_RELID_CONNECTOR_EXEC	Connector execution region in IMPORT/EXPORT	20080812
28	SC_RELID_KEYWORD	Constant	Protected	☐	Type reference (TYPE)	INDX_RELID	IF_ESH_SE_RUNTIME_DATA=>SC_RELID_KEYWORD	Category region in IMPORT/EXPORT	20090515
29	SC_RELID_OBJECT_TYPE	Constant	Protected	☐	Type reference (TYPE)	INDX_RELID	IF_ESH_SE_RUNTIME_DATA=>SC_RELID_OBJECT_TYPE	Object type region in IMPORT/EXPORT	20090109
30	SC_RELID_TEMPLATE	Constant	Protected	☐	Type reference (TYPE)	INDX_RELID	IF_ESH_SE_RUNTIME_DATA=>SC_RELID_TEMPLATE	Template region in IMPORT/EXPORT	20080812

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COMPOSE_OBJECT_TYPE_GEN_ID	Static method	Private	Method	Compose general ID for object type runtime data	20090118
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20080811
3	DECOMPOSE_OBJECT_TYPE_GEN_ID	Static method	Private	Method	Decompose general ID for object type runtime data	20090118
4	IMPORT_CATEGORIES	Static method	Protected	Method	Import categories from cluster table	20080809
5	IMPORT_CONNECTOR	Static method	Protected	Method	Import connector from cluster table	20080809
6	IMPORT_CONNECTOR_EXECUTION	Static method	Protected	Method	Import connector execution from cluster table	20080811
7	IMPORT_KEYWORDS	Static method	Protected	Method	Import keywords from cluster table	20090515
8	IMPORT_KEYWORDS_ALL_LANGU	Static method	Protected	Method	Import keywords from cluster table	20090520
9	IMPORT_OBJECT_TYPE	Static method	Protected	Method	Import connector from cluster table	20090109
10	IMPORT_TEMPLATES	Static method	Protected	Method	Import templates from cluster table	20080809
11	IS_SEARCHABLE	Static method	Protected	Method	Is searchable depending on status	20090123
12	SELECT_IDS	Static method	Protected	Method	Select IDs from cluster	20080812
13	SELECT_IDS_MULTI	Static method	Protected	Method	Select IDs from cluster	20110110
14	SELECT_METADATA	Instance method	Protected	Method	Select metadata	20090123

Events

Class CL_ESH_SE_RUNTIME_DATA_CLUSTER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_ENTRY_METADATA	Protected	See coding			20090123	BEGIN OF s_entry_metadata, relid TYPE esh_se_runtime-relid, general_id TYPE esh_se_runtime-general_id, status TYPE esh_se_runtime-status, update_timestamp TYPE esh_se_runtime-update_timestamp, update_user TYPE esh_se_runtime-update_user, END OF s_entry_metadata
2	S_OBJECT_TYPES_BY_SYS	Protected	See coding			20090119	BEGIN OF s_object_types_by_sys, system_id TYPE syst-sysid, system_client TYPE syst-mandt, all_imported TYPE abap_bool, object_types TYPE if_esh_se_runtime_data=>t_obj_types_sorted, END OF s_object_types_by_sys
3	S_OBJECT_TYPE_ID	Protected	See coding			20090119	BEGIN OF s_object_type_id, object_type_id TYPE esh_e_om_object_type, END OF s_object_type_id
4	S_OBJECT_TYPE_IDS_OF_SYS	Protected	See coding			20090119	BEGIN OF s_object_type_ids_of_sys, system_id TYPE syst-sysid, system_client TYPE syst-mandt, object_type_ids TYPE t_object_type_ids, END OF s_object_type_ids_of_sys
5	T_CONNECTOR_IDS	Public	See coding		Connector IDs (sorted)	20080812	t_connector_ids TYPE SORTED TABLE OF esh_e_if_search_connector_id WITH UNIQUE KEY table_line
6	T_ENTRIES_METADATA_SORTED	Protected	See coding			20090123	t_entries_metadata_sorted TYPE SORTED TABLE OF s_entry_metadata WITH UNIQUE KEY relid general_id
7	T_GENERAL_IDS	Public	See coding			20090109	T_GENERAL_IDS TYPE sorted table of esh_se_runtime-general_id WITH UNIQUE KEY table_line
8	T_GENERAL_ID_RANGE	Protected	See coding			20110110	t_general_id_range TYPE RANGE OF esh_se_runtime-general_id
9	T_LANGU_SORTED	Protected	See coding			20090515	t_langu_sorted TYPE SORTED TABLE OF spras WITH UNIQUE KEY table_line
10	T_OBJECT_TYPES_BY_SYS	Protected	See coding			20090119	t_object_types_by_sys TYPE SORTED TABLE OF s_object_types_by_sys WITH UNIQUE KEY system_id system_client
11	T_OBJECT_TYPE_IDS	Protected	See coding			20090119	t_object_type_ids TYPE SORTED TABLE OF s_object_type_id WITH UNIQUE KEY object_type_id
12	T_OBJECT_TYPE_IDS_OF_SYS	Protected	See coding			20090119	t_object_type_ids_of_sys TYPE SORTED TABLE OF s_object_type_ids_of_sys WITH UNIQUE KEY system_id system_client
13	T_RELID_RANGE	Protected	See coding			20110110	t_relid_range TYPE RANGE OF esh_se_runtime-relid

Method Signatures

Method COMPOSE_OBJECT_TYPE_GEN_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		System/Release	20090202
2	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20090118
3	Importing	IV_SYSTEM_CLIENT	Call by reference	☐	Type reference (TYPE)	SYST-MANDT	SY-MANDT	Client ID of Current User	20090118
4	Importing	IV_SYSTEM_ID	Call by reference	☐	Type reference (TYPE)	SYST-SYSID	SY-SYSID	Name of the SAP System	20090118
5	Returning	RV_GENERAL_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_SE_GENERAL_LONG_ID		General ID	20090118

Method COMPOSE_OBJECT_TYPE_GEN_ID on class CL_ESH_SE_RUNTIME_DATA_CLUSTER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20080811
2	Importing	IV_UPDATE_INVALID_BUFFER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20090127

Method CONSTRUCTOR on class CL_ESH_SE_RUNTIME_DATA_CLUSTER has no exception.

Method DECOMPOSE_OBJECT_TYPE_GEN_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20090118
2	Exporting	EV_SOFTWARE_COMPONENT	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		System/Release	20090118
3	Exporting	EV_SYSTEM_CLIENT	Call by reference	☐	Type reference (TYPE)	SYST-MANDT		Client ID of Current User	20090118
4	Exporting	EV_SYSTEM_ID	Call by reference	☐	Type reference (TYPE)	SYST-SYSID		Name of the SAP System	20090118
5	Importing	IV_GENERAL_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_SE_GENERAL_LONG_ID		General ID	20090118

Method DECOMPOSE_OBJECT_TYPE_GEN_ID on class CL_ESH_SE_RUNTIME_DATA_CLUSTER has no exception.

Method IMPORT_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CATEGORIES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CATEGORIES_SORTED		Categories (sorted)	20080809

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20080812
2	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20080814

Method IMPORT_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_CONNECTOR	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED		Connector (sorted)	20080809
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080809

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20080812
2	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20080814

Method IMPORT_CONNECTOR_EXECUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_CONNECTOR_EXECUTION	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_SORTED		Connector (sorted)	20080811
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080811

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20080812
2	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20080814

Method IMPORT_KEYWORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_KEYWORDS	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_KEYWORDS_SORTED			20090515
2	Importing	IV_GENERAL_ID	Call by reference	☐	Type reference (TYPE)	ESH_SE_RUNTIME-GENERAL_ID			20090515

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090515
2	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20090515

Method IMPORT_KEYWORDS_ALL_LANGU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_KEYWORDS	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_KEYWORDS_SORTED		Keywords with tables of Connector IDs (sorted)	20090520
2	Importing	IV_RAISE_EXCEPTION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20090520

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090520
2	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20090520

Method IMPORT_OBJECT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_OBJ_TYPE_SORTED			20090109
2	Importing	IV_GENERAL_ID	Call by reference	☐	Type reference (TYPE)	ESH_SE_RUNTIME-GENERAL_ID			20090109

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090109
2	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20090109

Method IMPORT_TEMPLATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TEMPLATES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_TEMPLATES_SORTED		Templates (sorted)	20080809

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20080812
2	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20080814

Method IS_SEARCHABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	ESH_E_ADM_SC_STATUS		Status of a Search Connector	20090123
2	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090123

Method IS_SEARCHABLE on class CL_ESH_SE_RUNTIME_DATA_CLUSTER has no exception.

Method SELECT_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_IDS	Call by reference	☐	Type reference (TYPE)	T_CONNECTOR_IDS		IDs (sorted)	20080812
2	Importing	IV_ID_PATTERN	Call by reference	☑	Type reference (TYPE)	CHAR120		Pattern for ID	20090109
3	Importing	IV_RELID	Call by reference	☐	Type reference (TYPE)	INDX_RELID	SC_RELID_CONNECTOR	Region in IMPORT/EXPORT Data Table	20080812

Method SELECT_IDS on class CL_ESH_SE_RUNTIME_DATA_CLUSTER has no exception.

Method SELECT_IDS_MULTI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_IDS	Call by reference	☐	Type reference (TYPE)	T_ENTRIES_METADATA_SORTED			20110110
2	Importing	IT_ID_RANGE	Call by reference	☑	Type reference (TYPE)	T_GENERAL_ID_RANGE			20110110
3	Importing	IT_RELID_RANGE	Call by reference	☑	Type reference (TYPE)	T_RELID_RANGE			20110110

Method SELECT_IDS_MULTI on class CL_ESH_SE_RUNTIME_DATA_CLUSTER has no exception.

Method SELECT_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_METADATA	Call by reference	☐	Type reference (TYPE)	T_ENTRIES_METADATA_SORTED			20090123

Method SELECT_METADATA on class CL_ESH_SE_RUNTIME_DATA_CLUSTER has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	712