SAP ABAP Class CL_ESH_BOS_INDEX_CTRL (Index controller)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_BOS_INDEX (Package) BOS Index

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_INDEX_CONTROLLER	Index controller	20070220

Properties

Class	CL_ESH_BOS_INDEX_CTRL
Short Description	Index controller
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_BOS_INDEX	BOS Index
Created	20070220	SAP
Last change	20130531	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

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_IF_INDEX_CONTROLLER	☐	☐	Index controller	20070220

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_SE_RUNTIME_DATA_FROM_DB	☐	20090112	Runtime Data from Orig. Database

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_MSG_CLASS	Constant	Private	☐	Type reference (TYPE)	ARBGB	'ESH_BOS_INDEX_CTRL'	Application area	20070220
2	GR_AUTHC	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_OM_AUTHC		Authorization checks	20080327
3	GR_AUTHNW	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_OM_AUTHNW		SAP_NW authorizations	20080327
4	GR_AUTHPB	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_OM_AUTHPB		Path-based authorization checks	20080327
5	GR_CONNECTIVITY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_ADM_ANY_CONNECTIVITY		Connectivity details	20090216
6	GR_DELETED_AUTH	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Deleted authorizations	20080905
7	GR_DELETED_USERS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Deleted users	20080905
8	GR_MODEL_METADATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_TREX_MODEL_METADATA		Data object holding model references	20091009
9	GR_OBJTYPE_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_TEMPLATE_TYPE		Template type	20090217
10	GR_OTYP	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_OM_OTYP		Object types	20070704
11	GT_AUTHORITY_DATA	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_AU_AUTH_AOB_VAL_TO_AOBJS		ESH authorization: Values to auth.for authobj common runtime	20081010
12	GT_COMP_DESCR	Instance attribute	Private	☐	Type reference (TYPE)	TREXT_COMP_DESCR		Description of the components	20070307
13	GT_INDEX_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	LTY_T_INDEX_NAME		Table with used indices	20071105
14	GT_INDEX_IDS	Instance attribute	Private	☐	Type reference (TYPE)	LTY_T_INDEX_ID_TYPE			20070228
15	GT_MSG	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_ADM_BAL_S_MSG		Table type for structure BAL_S_MSG	20070306
16	GT_NODE_JOIN_LIST	Instance attribute	Private	☐	Type reference (TYPE)	LTY_T_NODE_JOIN_LIST		Table type for node with join list Information	20070323
17	GV_AREA	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		Area	20070704
18	GV_CONNECTION_GUID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20080407
19	GV_CONSTRAINT_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	NUMC3		Counter for constraints	20070518
20	GV_EXT_SYS_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_ADM_EXTERNAL_SYSTEM_ID		Identifier for an external system	20090127
21	GV_IDX_ID	Instance attribute	Private	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index ID	20070307
22	GV_JOIN_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	NUMC3		Counter for join conditions	20070323
23	GV_JOIN_PATH_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	NUMC3		Counter for join paths	20070323
24	GV_LOGSYS	Instance attribute	Private	☐	Type reference (TYPE)	LOGSYS		Logical system	20070220
25	GV_LOG_HANDLE	Instance attribute	Private	☐	Type reference (TYPE)	BALLOGHNDL		Application log: Log handle	20070220
26	GV_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Last message text	20070712
27	GV_MODEL	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20070704
28	GV_NODE	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node name	20070301
29	GV_NO_BKNDNM	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_EXTR_NO_BACKENDNAME		Do not use back-end names in extraction structures	20090223
30	GV_NW_70	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20080425
31	GV_OBJTYPE	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20070301
32	GV_OWN_LOG	Instance attribute	Private	☐	Type reference (TYPE)	FLAG		'X' if the log was created here	20070221
33	GV_ROOT_NODE	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Root node name	20070323
34	GV_SYSGROUP	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_SYSTEM_GROUP		System group	20080407
35	GV_SYSREL	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		System/Release	20080204
36	GV_TREX_DEST	Instance attribute	Private	☐	Type reference (TYPE)	RFCDEST		Logical destination (specified in function call)	20070228
37	GV_USER_INDEX_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	NUMC3		Counter for user indices	20070705
38	GV_WRITE_MSG	Instance attribute	Private	☐	Type reference (TYPE)	FLAG		Collect messages	20070306

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SYSTEM_MESSAGE	Instance method	Private	Method	Add message	20070712
2	ADD_TO_LIST	Static method	Private	Method	Add a string to a list of strings separated by comma & space	20070323
3	CLEAR_INDEX	Static method	Public	Method	Clear content of joins	20070301
4	COMPOSE_AUTH_INDEX	Instance method	Public	Method	Compose Index name for authorization index	20090407
5	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20070220
6	COPY_AUTH_INDEX	Instance method	Private	Method	Copy the specified authorization index	20090519
7	CREATE_JOIN_CRT	Instance method	Public	Method	Create join index	20080327
8	CREATE_JOIN_DATAMINING	Instance method	Private	Method	Create join for data mining purposes	20080821
9	CREATE_JOIN_PROPERTY	Instance method	Public	Method	Create join index	20090119
10	CREATE_NODE_JOIN_PARAM	Instance method	Private	Method	Create join parameters between 2 nodes	20080529
11	CREATE_PHYSICAL_INDEX	Instance method	Private	Method	Create physical index	20070228
12	DELETE_FROM_DEPENDENT	Instance method	Private	Method	Delete records from nodes to keep consistency	20080325
13	DELETE_INDEX	Static method	Public	Method	Clear content of joins	20070615
14	DETERMINE_INDEX_NAME	Instance method	Private	Method	Determine the name of physical indices	20080404
15	FILL_COMPLETE_OBJECTS	Instance method	Public	Method	Fill whole objects	20080129
16	FILL_INDEX_DEF	Instance method	Private	Method	Fill necessary attributes for TREX	20070301
17	FILL_MULTI_COMPLETE_OBJECTS	Static method	Public	Method	Fill whole objects	20090120
18	FILL_PATH_FROM_PPS	Instance method	Private	Method	Fill the path steps	20080403
19	GET_AUTHORITIES	Instance method	Public	Method	Get authorities	20080330
20	GET_CHILDREN	Instance method	Private	Method	Get children	20070321
21	GET_COMPLETE_LIST	Instance method	Protected	Method	Determine all the corresponding records from index	20080724
22	GET_CONSTRAINT_TOKENS	Static method	Private	Method	Extract the constraint tokens from a logical expression	20081120
23	GET_INDEX_DEF	Instance method	Public	Method	Determine the index definition	20080730
24	GET_INVOLVED_ATTRIBUTES	Instance method	Public	Method	Get the attributes to be used in join	20080402
25	GET_LOG_HANDLE	Instance method	Public	Method	Retrieve created application log	20070228
26	GET_MESSAGES	Instance method	Public	Method	Retrieve the collected messages	20070306
27	GET_NEXT_CONSTRAINT	Instance method	Private	Method	Get the next free join constraint	20080529
28	GET_NEXT_JOIN_CONDITION	Instance method	Private	Method	Get the next free join condition	20070323
29	GET_NODE_FROM_CHECK_HASH	Instance method	Public	Method	Determine node name based on hashed authorization check	20080730
30	GET_OPERATOR	Static method	Protected	Method	Get a query line with bracket	20081014
31	GET_ROOT_NODE	Instance method	Public	Method	Retrieve the name of the root node	20080407
32	GET_TREX_COMPDEF	Instance method	Protected	Method	Get the attributes definitions and components	20070617
33	INDEX	Instance method	Private	Method	Index	20070621
34	OPTIMIZE	Instance method	Public	Method	Optimize indexed records	20070306
35	PREPARE_INDEX_DEF	Instance method	Private	Method	Fill the necessary index definitions	20070302
36	READ_COMPLETE_OBJECTS	Instance method	Public	Method	Fill whole objects	20090109
37	READ_INDEX_BUFFER	Instance method	Private	Method	Read from buffer/Insert in buffer	20070621
38	TRANSLATE_FIELDNAME	Static method	Public	Method	Translate the field name	20080319
39	UPDATE	Instance method	Public	Method	Change index	20090319
40	UPDATE_INDEX	Instance method	Public	Method	Create/change index	20090305

Events

Class CL_ESH_BOS_INDEX_CTRL has no event.

Types

Class CL_ESH_BOS_INDEX_CTRL has no local type.

Method Signatures

Method ADD_SYSTEM_MESSAGE Signature

Method ADD_SYSTEM_MESSAGE on class CL_ESH_BOS_INDEX_CTRL has no parameter.
Method ADD_SYSTEM_MESSAGE on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method ADD_TO_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_LIST	Value transfer	☐	Type reference (TYPE)	STRING		Result	20070323
2	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	STRING		Imported key	20070323
3	Importing	IV_LIST	Call by reference	☐	Type reference (TYPE)	STRING		Imported list	20070323

Method ADD_TO_LIST on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method CLEAR_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CODE	Call by reference	☐	Type reference (TYPE)	INT4		Trex error code	20070615
2	Exporting	EV_TEXT	Call by reference	☐	Type reference (TYPE)	CHAR200		Trex error text	20070615
3	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070301
4	Importing	IV_RFCDEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20070615

#	Exception	Resumable	Description	Created on
1	CONV_ERROR	☐	Conversion error	20070615
2	ERROR	☐	Internal error	20070615
3	NO_RFC_DEST	☐	No RFC Destination	20070615

Method COMPOSE_AUTH_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20090407
2	Importing	IV_AUTH_CHECK	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AUTH_CHECK		Authorization Check	20090407
3	Importing	IV_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20090407

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20090407

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_MODEL_METADATA	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_TREX_MODEL_METADATA		Data object holding model references	20091009
2	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	CHAR1	'A'	Single-Character Flag	20070702
3	Importing	IV_CONNECTION_GUID	Call by reference	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20071113
4	Importing	IV_EXT_SYS_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_ADM_EXTERNAL_SYSTEM_ID		Identifier for an external system	20090127
5	Importing	IV_LOGSYS	Call by reference	☑	Type reference (TYPE)	LOGSYS		Logical system	20070220
6	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070220
7	Importing	IV_OBJTYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20070301
8	Importing	IV_SYSGROUP	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSTEM_GROUP		System Group	20070704
9	Importing	IV_SYSREL	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		System/Release	20070702
10	Importing	IV_WRITE_MSG	Call by reference	☑	Type reference (TYPE)	FLAG		Collect messages in a table	20070306

#	Exception	Resumable	Description	Created on
1	INPUT_ERROR	☐	Input data not consistent	20070220

Method COPY_AUTH_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SRC_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Source index Id	20090519
2	Importing	IV_TRG_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Target index Id	20090519

#	Exception	Resumable	Description	Created on
1	ERROR	☐	An error has occured during index copy	20090519

Method CREATE_JOIN_CRT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_JOIN_INDEX	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20080327
2	Importing	IV_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_REQUEST		Request	20080327
3	Importing	IV_REQ_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20080327

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080327

Method CREATE_JOIN_DATAMINING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AUTH_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Authorization Index Id	20080821
2	Importing	IV_JOIN_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Join Index Id	20080821

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080821

Method CREATE_JOIN_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JOIN_INDEX	Call by reference	☑	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20090119
2	Importing	IV_OBJTYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20090119
3	Importing	IV_PROP_VAL_NODE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20090119
4	Importing	IV_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_REQUEST	'$PV'	Request	20090119

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20090119

Method CREATE_NODE_JOIN_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_JOIN_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TREXT_VIEW_ATTRIBUTES		View Attributes	20080529
2	Exporting	ET_JOIN_CONDITIONS	Call by reference	☐	Type reference (TYPE)	TREXT_STATIC_JOIN_CONDITION		Static Join Condition	20080529
3	Exporting	ET_JOIN_CONSTRAINTS	Call by reference	☐	Type reference (TYPE)	TREXT_CONSTRAINTS		Constraints	20080529
4	Exporting	ET_JOIN_FREESTYLE	Call by reference	☐	Type reference (TYPE)	TREXT_ATTRIBUTES		Attributes	20080529
5	Exporting	ET_JOIN_INDEXES	Call by reference	☐	Type reference (TYPE)	TREXT_JOIN_INDEX		Join Index	20080529
6	Exporting	ET_JOIN_PATHS	Call by reference	☐	Type reference (TYPE)	TREXT_JOIN_PATHS		Join paths	20080529
7	Importing	IS_NODE_HIER	Call by reference	☐	Type reference (TYPE)	LTY_S_NODE_HIER		Node Hierarchy	20080529
8	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	LTY_T_OBJECT_NODE_FIELD		Fields	20080529
9	Importing	IV_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_REQUEST		Request	20080529
10	Importing	IV_REQ_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20080529

Method CREATE_NODE_JOIN_PARAM on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method CREATE_PHYSICAL_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CHANGED_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	ESH_S_OM_TRANS_DELTA_NODES		Changes in nodes	20090109
2	Importing	IV_DELETE_SUB_INDICES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090306
3	Importing	IV_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	TREX_RFC-DESCRIPTION		Description	20070228
4	Importing	IV_IMPORT_PATH	Call by reference	☑	Type reference (TYPE)	TREX_RFC-PATH		Import content of index from path	20081017
5	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREX_RFC-INDEX_ID		Index Id	20070228
6	Importing	IV_UPDATE_NODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN	'0'	0: create, 1: update	20080204

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20070228

Method DELETE_FROM_DEPENDENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SERIALIZED_STRING	Call by reference	☐	Type reference (TYPE)	TREXT_XSTRING		Table of xstrings.	20080325
2	Importing	IR_SOURCE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Payload	20080325
3	Importing	IV_RELATION_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_RELATION_ID		Relation ID	20080325

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080325

Method DELETE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CODE	Call by reference	☐	Type reference (TYPE)	INT4		Trex error code	20070615
2	Exporting	EV_TEXT	Call by reference	☐	Type reference (TYPE)	CHAR200		Trex error text	20070615
3	Importing	IV_DELETE_SUB_INDICES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Delete physical indices for logical index	20080930
4	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070615
5	Importing	IV_RFCDEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20070615

#	Exception	Resumable	Description	Created on
1	CONV_ERROR	☐	Conversion error	20070615
2	ERROR	☐	Internal error	20070615
3	NO_RFC_DEST	☐	No RFC Destination	20070615

Method DETERMINE_INDEX_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_FROM_INDEX	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		From Index Id	20080404
2	Changing	CV_TO_INDEX	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		To Index Id	20080404
3	Importing	IS_PATH_STEP	Call by reference	☐	Type reference (TYPE)	ESH_S_JOIN_PATH_STEP		List with path steps	20080404

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080404

Method FILL_COMPLETE_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA_STRINGS	Call by reference	☐	Type reference (TYPE)	TREXT_XSTRING		Table of xstrings.	20090128
2	Exporting	ET_INDEX_MAP	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_IDS_2		Mapping table of authorization indices	20090519
3	Changing	IS_INDEX_POPUL_API_DPS	Call by reference	☑	Type reference (TYPE)	ESH_S_TREX_INDEX_POPUL_API_DPS		Interface for passing data to DPS and KPro scenario	20090728
4	Importing	IT_OBJECT_DATA	Call by reference	☐	Type reference (TYPE)	ESH_T_IX_OBJECT_DATA		Table type for structure ESH_S_IX_OBJECT_DATA	20080129
5	Importing	IV_DELTA	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Flag for delta	20080129
6	Importing	IV_LAST_PACKAGE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Last package	20080407
7	Importing	IV_ONLY_AUTH_INDICES	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Fill only dependent authorization indices	20080414
8	Importing	IV_OPTIMIZE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN	1	0: false, 1: true	20080429
9	Importing	IV_RTI	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Flag: Realtime Indexing	20090520

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080129

Method FILL_INDEX_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_IDX_IDS	Call by reference	☐	Type reference (TYPE)	ESH_T_INDEX_ID		Index List	20070617
2	Importing	IV_AUTH_OBJ	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_AUTH_CHECK		Authorization Check	20070302
3	Importing	IV_IS_ROOT	Call by reference	☑	Type reference (TYPE)	CHAR1		Is root	20070323
4	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-LANGUAGE	'EN'	Language	20071113
5	Importing	IV_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20070302
6	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20080406
7	Importing	IV_SCOPE	Call by reference	☐	Type reference (TYPE)	CHAR1		0=Only node , 1=Only AO, 2=Node and AO	20070301

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20070301

Method FILL_MULTI_COMPLETE_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FAILED_OBJECTS	Call by reference	☐	Type reference (TYPE)	ESH_T_OBJECT_TYPE_MESSAGES		Table type for ESH_S_OBJECT_TYPE_MESSAGES	20090128
2	Exporting	ET_SUCCESS_OBJECTS	Call by reference	☐	Type reference (TYPE)	ESH_T_OBJECT_TYPE_MESSAGES		Table type for ESH_S_OBJECT_TYPE_MESSAGES	20090128
3	Importing	IT_OBJECT_DATA	Call by reference	☐	Type reference (TYPE)	ESH_T_IX_MULTI_OBJECT_DATA		Table type for structure ESH_S_IX_MULTI_OBJECT_DATA	20090120
4	Importing	IV_CONNECTION_GUID	Call by reference	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20090120
5	Importing	IV_DELTA	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Flag for delta	20090511
6	Importing	IV_ONLY_AUTH_INDICES	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20090129

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20090120

Method FILL_PATH_FROM_PPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_AOTYPPS_EXT	Call by reference	☐	Type reference (TYPE)	ESH_S_OM_AOTYPPS_EXT		ESH_OM_AOTYPPS in External Representation	20080403
2	Returning	RS_PATH_STEP	Value transfer	☐	Type reference (TYPE)	ESH_S_JOIN_PATH_STEP		List with path steps	20080403

Method FILL_PATH_FROM_PPS on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method GET_AUTHORITIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_AUTHORITIES	Value transfer	☐	Type reference (TYPE)	ESH_T_AU_AUTHORITY		Table type for XUAUTH	20080330
2	Importing	IS_AUTH_FIELD_VALUES	Call by reference	☐	Type reference (TYPE)	ESH_S_AU_AUTH_FIELD_VALUES		Authorization field values	20080330
3	Importing	IV_AUTH_OBJECT	Call by reference	☐	Type reference (TYPE)	XUOBJECT		Authorization Object	20080330
4	Importing	IV_LOGSYS	Call by reference	☑	Type reference (TYPE)	LOGSYS		Logical System	20080330

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080330
2	INDEX_EMPTY	☐	Index is empty	20080330

Method GET_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_NODE_HIER	Call by reference	☐	Type reference (TYPE)	LTY_T_NODE_HIER		Table type for node structure	20070322
2	Importing	IT_RELAT_EXT	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_ARELAT_EXT		Table Type for ESH_S_OM_ARELAT_EXT	20070321
3	Importing	IV_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20070321

Method GET_CHILDREN on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method GET_COMPLETE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IR_COMPLETE_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Complete data	20080724
2	Importing	IR_SELECTION_DATA	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Selection data	20080724
3	Importing	IT_QUERY	Call by reference	☑	Type reference (TYPE)	TREXT_QUERY_ENTRIES		Search query	20080804
4	Importing	IT_REQ_ATTR	Call by reference	☑	Type reference (TYPE)	TREXT_JOIN_ATTRIBUTES		Attributes with indexId and join path	20080804
5	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20080724

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080724

Method GET_CONSTRAINT_TOKENS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONSTRAINT_TOKENS	Call by reference	☐	Type reference (TYPE)	TREXT_STRING		Constraint tokens	20081120
2	Exporting	EV_NON_CONSTRAINT_EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING		Non constraint expression	20081121
3	Importing	IT_TOKENS	Call by reference	☑	Type reference (TYPE)	TREXT_STRING		Expression tokens	20081120
4	Importing	IV_LOGICAL_EXPRESSION	Call by reference	☐	Type reference (TYPE)	STRING		Logical expression	20081120

Method GET_CONSTRAINT_TOKENS on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method GET_INDEX_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_TABLE_REF	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20080730
2	Exporting	ET_TREX_COMP_DESCR	Call by reference	☐	Type reference (TYPE)	TREXT_COMP_DESCR		Description of the components	20080730
3	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20080730

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080730

Method GET_INVOLVED_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTR_LIST	Call by reference	☐	Type reference (TYPE)	ESH_T_JOIN_ATTRIBUTES_LIST		Table type for ESH_S_JOIN_ATTRIBUTES_LIST	20080402
2	Exporting	ET_NODE_LIST	Call by reference	☐	Type reference (TYPE)	ESH_T_NODE_AUTHORIZATION_LIST		Table type for ESH_S_NODE_AUTHORIZATION_LIST	20080402
3	Importing	IV_REQUESTED_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20080402
4	Importing	IV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request	20080402

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080402

Method GET_LOG_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070228

Method GET_LOG_HANDLE on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method GET_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MSG	Call by reference	☐	Type reference (TYPE)	ESH_T_ADM_BAL_S_MSG		Table type for structure BAL_S_MSG	20070306

Method GET_MESSAGES on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method GET_NEXT_CONSTRAINT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_CONSTRAINT	Value transfer	☐	Type reference (TYPE)	ESH_E_TREX_ELEMENT		Constraint	20080529

Method GET_NEXT_CONSTRAINT on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method GET_NEXT_JOIN_CONDITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_JOIN_CONDITION	Value transfer	☐	Type reference (TYPE)	TREXD_JOIN_PATH		Join condition	20070323

Method GET_NEXT_JOIN_CONDITION on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method GET_NODE_FROM_CHECK_HASH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_NODE_NAME	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20080730
2	Importing	IV_AUTH_CHECK	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AUTH_CHECK		Authorization Check	20080730

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20080730
2	NOT_FOUND	☐	No suitable node was found	20080730

Method GET_OPERATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_SEARCH	Value transfer	☐	Type reference (TYPE)	TREXS_QUERY_ENTRY		Query Entry	20081014
2	Importing	IV_OPERATOR	Call by reference	☐	Type reference (TYPE)	STRING		Operator (AND, OR)	20081014

Method GET_OPERATOR on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method GET_ROOT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_ROOT_NODE	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20080407

Method GET_ROOT_NODE on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method GET_TREX_COMPDEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTR_DEF	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DEF		Attribute definitions	20070617
2	Exporting	ET_COMP_DESCR	Call by reference	☐	Type reference (TYPE)	TREXT_COMP_DESCR		Description of the components	20070617
3	Exporting	ET_DD_COMP	Call by reference	☐	Type reference (TYPE)	DDFIELDS		DD: Field List	20070620
4	Exporting	ET_KEY_ATTR	Call by reference	☐	Type reference (TYPE)	TREXT_ATTRIBUTES		Attributes	20070617
5	Importing	IT_AOTYPNF_EXT	Call by reference	☑	Type reference (TYPE)	ESH_T_OM_AOTYPNF_EXT		Table Type for ESH_S_OM_AOTYPN_EXT	20070617
6	Importing	IV_NODE_AUTH	Call by reference	☑	Type reference (TYPE)	FLAG		Field for node authorization	20070617
7	Importing	IV_PROFILE	Call by reference	☑	Type reference (TYPE)	FLAG		Field for profile	20070617

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20070617

Method INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Return Code	20070621
2	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070621
3	Exporting	EV_SERIALIZED_STRING	Call by reference	☐	Type reference (TYPE)	XSTRING			20080201
4	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20070621
5	Importing	IV_AUTO_OPTIMIZE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-BOOLEAN	1	0: false, 1: true	20070621
6	Importing	IV_CLEAR_INDEX	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Clear index before indexing	20080408
7	Importing	IV_DEINDEX	Call by reference	☐	Type reference (TYPE)	TREX_RFC-FLAG	SPACE	Indicator	20070621
8	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070621
9	Importing	IV_INDEX_ID_TMP	Call by reference	☑	Type reference (TYPE)	TREXD_INDEX_ID		Use temporary index ID	20090520
10	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-LANGUAGE	'EN'	Language	20080214

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20070621

Method OPTIMIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IDX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070306

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20070306

Method PREPARE_INDEX_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_IDX_IDS	Call by reference	☐	Type reference (TYPE)	ESH_T_INDEX_ID		Indexes	20070306
2	Importing	IV_AUTH_OBJ	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_AUTH_CHECK		Authorization Check	20070302
3	Importing	IV_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20070302
4	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20080406
5	Importing	IV_SCOPE	Call by reference	☐	Type reference (TYPE)	CHAR1		0=Only node , 1=Only AO, 2=Node and AO	20070302

#	Exception	Resumable	Description	Created on
1	ERROR	☐	internal error	20070302

Method READ_COMPLETE_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	IT_OBJECT_DATA	Call by reference	☐	Type reference (TYPE)	ESH_T_IX_OBJECT_DATA		Table type for structure ESH_S_IX_OBJECT_DATA	20090109
2	Importing	IV_FROM	Call by reference	☐	Type reference (TYPE)	INT4	1	From	20090109
3	Importing	IV_TO	Call by reference	☐	Type reference (TYPE)	INT4	20	To	20090109

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20090109

Method READ_INDEX_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_INDEX_ID	Call by reference	☐	Type reference (TYPE)	LTY_S_INDEX_ID_TYPE			20070621
2	Importing	IV_AUTH_CHECK	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_AUTH_CHECK		Authorization Check	20070621
3	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070621
4	Importing	IV_INDEX_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_BOS_INDEX_TYPE		Index type	20070621
5	Importing	IV_NODE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20070621
6	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20080406

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20070621

Method TRANSLATE_FIELDNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELDNAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_FIELD		Node Field	20080319
2	Returning	RV_FIELDNAME	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_NODE_FIELD		Node Field	20080319

Method TRANSLATE_FIELDNAME on class CL_ESH_BOS_INDEX_CTRL has no exception.

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_INDEXING	Call by reference	☐	Type reference (TYPE)	CHAR1		''=Not necessary , '1'=Delta, '2'=Full	20090319
2	Importing	IT_ATTR_CHANGED	Call by reference	☑	Type reference (TYPE)	TREXT_ATTR_DEF		Changed attributes	20090513
3	Importing	IT_ATTR_CREATED	Call by reference	☑	Type reference (TYPE)	TREXT_ATTR_DEF		Created attributes	20090513
4	Importing	IT_ATTR_DEF	Call by reference	☑	Type reference (TYPE)	TREXT_ATTR_DEF		Attribute definitions	20090319
5	Importing	IT_ATTR_DELETED	Call by reference	☑	Type reference (TYPE)	TREXT_ATTR_DEF		Deleted attributes	20090513
6	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20090319

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20090319

Method UPDATE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_IDX_IDS	Call by reference	☐	Type reference (TYPE)	ESH_T_INDEX_ID		Table of indices	20090305
2	Importing	IS_CHANGED_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	ESH_S_OM_TRANS_DELTA_NODES		Changes in nodes	20090305
3	Importing	IV_NODE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20090305
4	Importing	IV_SCOPE	Call by reference	☐	Type reference (TYPE)	CHAR1	'0'	0=Only node , 1=Only AO, 2=Node and AO	20090305

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Internal error	20090305

History

Last changed by/on	SAP	20130531
SAP Release Created in	100