SAP ABAP Class CL_SEFS_INDEX (Index)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-TRX-EFS (Application Component) TREX Enterprise File Search
     ⤷ SEFS_CRAWL (Package) Crawl Files

Properties

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

General Data

Message Class	SEFS
Program status
Category	0
Package	SEFS_CRAWL	Crawl Files
Created	20070118	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_SEFS_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_SEFS_CRAWL_INDEX_INT_UTIL	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_SEFS_INDEX has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SEFS_CRAWL	☐	20070126	Crawl
2	CL_SEFS_CRAWL_INDEX_INT_UTIL	☐	20070226	Utilities (only for internal use)
3	CL_SEFS_OBJECT_TYPE	☐	20070315	Object Type Specification

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ACTION_DEL_INDEX	Constant	Private	☐	Type reference (TYPE)	TREXS_INDEX_DOC-DOC_ACTION	CL_SEFS_CONSTANTS=>GC_ACTION_DEL_INDEX	Delete Document from Index	20070205
2	GC_ADM_AUTH_CHANGE	Constant	Private	☐	Type reference (TYPE)	ACTIV_AUTH	CL_SEFS_CONSTANTS=>GC_ADM_AUTH_CHANGE	Change Activity (Administration)	20070615
3	GC_ADM_AUTH_CREATE	Constant	Private	☐	Type reference (TYPE)	ACTIV_AUTH	CL_SEFS_CONSTANTS=>GC_ADM_AUTH_CREATE	Create Activity (Administration)	20070615
4	GC_ADM_AUTH_DELETE	Constant	Private	☐	Type reference (TYPE)	ACTIV_AUTH	CL_SEFS_CONSTANTS=>GC_ADM_AUTH_DELETE	Delete Activity (Administration)	20070615
5	GC_ADM_AUTH_DISPLAY	Constant	Private	☐	Type reference (TYPE)	ACTIV_AUTH	CL_SEFS_CONSTANTS=>GC_ADM_AUTH_DISPLAY	Display Activity (Administration)	20070615
6	GC_AN_CRAWL_ID	Constant	Private	☐	Type reference (TYPE)	TREXS_DOC_ATTRIBUTES-ATTR_NAME	CL_SEFS_CONSTANTS=>GC_AN_CRAWL_ID	Attribute Name 'cruise_name' (=attribute name in TREX)	20070205
7	GC_AN_FREESTYLE_CONTAINER	Constant	Private	☐	Type reference (TYPE)	TREXD_ATTR_NAME	CL_SEFS_CONSTANTS=>GC_AN_FREESTYLE_CONTAINER	Attribute Name 'efs_freestyle_container'	20070306
8	GC_CRAWL_INITIAL	Constant	Private	☐	Type reference (TYPE)	TREXS_CRUISER-RUN_MODE	CL_SEFS_CONSTANTS=>GC_CRAWL_INITIAL	Initial Crawl	20070126
9	GC_CRAWL_RECRAWL	Constant	Private	☐	Type reference (TYPE)	TREXS_CRUISER-RUN_MODE	CL_SEFS_CONSTANTS=>GC_CRAWL_RECRAWL	Recrawl Crawl	20070126
10	GC_CRAWL_UPDATE	Constant	Private	☐	Type reference (TYPE)	TREXS_CRUISER-RUN_MODE	CL_SEFS_CONSTANTS=>GC_CRAWL_UPDATE	Update Crawl	20070126
11	GC_CRAWL_UPDATE_FULL	Constant	Private	☐	Type reference (TYPE)	TREXS_CRUISER-RUN_MODE	CL_SEFS_CONSTANTS=>GC_CRAWL_UPDATE_FULL	Full Update Crawl	20070126
12	GC_DE_SEFS_D_INDEX_STATE	Constant	Private	☐	Type reference (TYPE)	DDOBJNAME	CL_SEFS_CONSTANTS=>GC_DE_SEFS_D_INDEX_STATE	Name of Data Element 'SEFS_D_INDEX_STATE'	20070307
13	GC_MSGTY_ERROR	Constant	Private	☐	Type reference (TYPE)	SYMSGTY	CL_SEFS_CONSTANTS=>GC_MSGTY_ERROR	Message Type Error	20070222
14	GC_MSGTY_INFO	Constant	Private	☐	Type reference (TYPE)	SYMSGTY	CL_SEFS_CONSTANTS=>GC_MSGTY_INFO	Message Type Info	20070303
15	GC_NAMESPACE_EFS	Constant	Private	☐	Type reference (TYPE)	CHAR4	CL_SEFS_CONSTANTS=>GC_NAMESPACE_EFS	Namespace of Enterprise File Search (Index, Crawl)	20070302
16	GC_NOT_PUBLIC	Constant	Private	☐	Type reference (TYPE)	SEFS_D_ACCESS_RIGHT	CL_SEFS_CONSTANTS=>GC_NOT_PUBLIC	Not Secure/Not Public	20090325
17	GC_PUBLIC	Constant	Private	☐	Type reference (TYPE)	SEFS_D_ACCESS_RIGHT	CL_SEFS_CONSTANTS=>GC_PUBLIC	Secure/Public	20090325
18	GC_REGEX_INPUT_ALLOWED	Constant	Private	☐	Type reference (TYPE)	STRING	CL_SEFS_CONSTANTS=>GC_REGEX_INPUT_ALLOWED	Allowed Input Letters: A-Z, 0-9, _	20070208
19	GC_RT_ATTRIBUTE	Constant	Private	☐	Type reference (TYPE)	TREXD_ROWTYPE	CL_SEFS_CONSTANTS=>GC_RT_ATTRIBUTE	RowType 'ATTRIBUTE'	20070205
20	GC_TA_EXACT	Constant	Private	☐	Type reference (TYPE)	TREXD_TERM_ACTION	CL_SEFS_CONSTANTS=>GC_TA_EXACT	Term Action 'E', Exact Search	20070205
21	GC_X	Constant	Private	☐	Type reference (TYPE)	BOOLEAN	CL_SEFS_CONSTANTS=>GC_X	'X'	20070201
22	GV_MSG_TXT	Static Attribute	Private	☐	Type reference (TYPE)	STRING		Message Text (only for message ... into GV_MSG_TXT)	20070118
23	GV_RFC_DESTINATION	Static Attribute	Private	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC Destination to TREX	20070119

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_DEACTIVATE_INDEX	Static method	Public	Method	Activate or Deactivate Index	20070201
2	ACTIVATE_QUEUES_TREX	Static method	Protected	Method	Activate Index Queues on TREX	20070205
3	ADD_FREE_TEXT_2_LOG_ERROR	Static method	Private	Method	Add Free Text to Log with Message Type Error	20070223
4	ADD_FREE_TEXT_2_LOG_INFO	Static method	Private	Method	Add Free Text to Log with Message Type Info	20070303
5	ADD_RETURN_CODE_TAB	Static method	Private	Method	Add Return Code Table	20070227
6	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20070131
7	CLEAR_INDEX_TREX	Static method	Protected	Method	Clear Index on TREX	20070206
8	CLEAR_QUEUES_TREX	Static method	Protected	Method	Clear Queues on TREX	20070206
9	CREATE_INDEX	Static method	Public	Method	Create Index	20070118
10	CREATE_INDEX_TREX	Static method	Private	Method	Create Index on TREX	20070118
11	DELETE_INDEX	Static method	Protected	Method	Delete Index	20110114
12	DELETE_INDEX_AND_CRAWL	Static method	Public	Method	Delete Index and Delete Crawl	20070122
13	DELETE_INDEX_TREX	Static method	Private	Method	Delete Index on TREX	20070118
14	DELETE_OBJECTS_WITH_CRAWL_ID	Static method	Protected	Method	Delete Indexed Objects with Given Crawl Id	20070205
15	FLUSH_QUEUES	Static method	Public	Method	Flush Queues	20070126
16	FLUSH_QUEUES_TREX	Static method	Private	Method	Flush Queues on TREX	20070126
17	GET_FREESTYLE_ATTRIBUTES	Static method	Private	Method	Get Freestyle Attributes	20070306
18	GET_INDEX_ATTRIBUTE_INFO	Static method	Protected	Method	Get Attribute Info from Index	20070122
19	GET_INDEX_CRAWL_STATE	Static method	Public	Method	Get Index Crawl State	20070212
20	GET_INDEX_FOR_OBJ_TYPE	Static method	Public	Method	Get Index for Object Type	20070328
21	GET_INDEX_INFO	Static method	Public	Method	Get Index Info	20070122
22	GET_INDEX_INFO_TREX	Static method	Private	Method	Get Index Info from TREX	20070122
23	GET_INDEX_LIST_TREX	Static method	Private	Method	Get Index List from TREX	20070214
24	GET_INDEX_STATE	Static method	Private	Method	Get Index State	20070219
25	GET_QUEUES	Static method	Private	Method	Get Queues	20070214
26	GET_QUEUES_TREX	Static method	Private	Method	Get Queues from TREX	20070205
27	GET_STATIC_ATTRIBUTES	Static method	Private	Method	Get Static Attributes	20070319
28	INDEX_TREX	Static method	Private	Method	Index or Deindex Documents/Objects	20070226
29	IS_INDEX_SECURE	Static method	Public	Method	Is Index Secure	20090325
30	IS_INDEX_SECURE_ATTR_CHANGED	Static method	Public	Method	Is Secure Attribute of Index Changed	20071010
31	SET_QUEUE_PARAMETERS	Static method	Protected	Method	Set Queue Parameter for Index	20070126
32	SET_QUEUE_PARAMETERS_TREX	Static method	Private	Method	Set Queue Parameter for Index on TREX	20070126
33	SUSPEND_QUEUES_TREX	Static method	Protected	Method	Suspend Queues on TREX	20070205

Events

Class CL_SEFS_INDEX has no event.

Types

Class CL_SEFS_INDEX has no local type.

Method Signatures

Method ACTIVATE_DEACTIVATE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN_CODES	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES		Return codes per object type	20070223
2	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070228
3	Importing	IT_INDEX_NAME_ID	Call by reference	☐	Type reference (TYPE)	SEFS_T_INDEX_NAME_ID		Index Name and Index ID	20070315
4	Importing	IV_ACTIVATE_ALL_INDEXES	Call by reference	☐	Type reference (TYPE)	SEFS_D_INDEX_ACTIVE	'X'	'X' = Index is Active	20070212
5	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070221

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070222

Method ACTIVATE_QUEUES_TREX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUEUE_RETURN	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_RETURN		Queues with return code	20070226
2	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Return Code	20070205
3	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070205
4	Importing	IT_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_IDS		Indexes	20070205
5	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070205

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method ADD_FREE_TEXT_2_LOG_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSG_TXT	Call by reference	☑	Type reference (TYPE)	STRING		Message Text	20070223

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070223

Method ADD_FREE_TEXT_2_LOG_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSG_TXT	Call by reference	☑	Type reference (TYPE)	STRING		Message Text	20070303

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070303

Method ADD_RETURN_CODE_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INDEX_ID	Call by reference	☑	Type reference (TYPE)	SEFS_D_INDEX_ID		Index ID	20070227
2	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	SEFS_D_OBJECT_TYPE		Object Type	20070227

Method ADD_RETURN_CODE_TAB on class CL_SEFS_INDEX has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_SEFS_INDEX has no parameter.
Method CLASS_CONSTRUCTOR on class CL_SEFS_INDEX has no exception.

Method CLEAR_INDEX_TREX 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	20070206
2	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070206
3	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070206
4	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070206

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method CLEAR_QUEUES_TREX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUEUE_RETURN	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_RETURN		Queues with return code	20070226
2	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Return Code	20070206
3	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070206
4	Importing	IT_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_IDS		Indexes	20070206
5	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070206

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method CREATE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN_CODES	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES		Return codes per object type	20070222
2	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070228
3	Importing	IT_OBJECT_TYPE_INDEX_DATA	Call by reference	☐	Type reference (TYPE)	SEFS_T_OBJECT_TYPE_INDEX_DATA		Object Type and Index Data	20070308
4	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070221

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070222
2	CX_SEFS_DB_CONFIG_ERROR	☐	Exception class for Configuration Error	20070209
3	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method CREATE_INDEX_TREX 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	20070118
2	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070118
3	Importing	IT_ATTRIBUTE_DEFINITIONS	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DEF		Attribute definitions	20070319
4	Importing	IT_EXTENSIONS	Call by reference	☑	Type reference (TYPE)	TREXT_EXTENSIONS		Extensions	20070118
5	Importing	IT_FREESTYLE_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	TREXT_ATTRIBUTES		Freestyle Attributes	20070306
6	Importing	IV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	TREX_RFC-DESCRIPTION		Description	20070118
7	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070118
8	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-LANGUAGE		Language	20070118
9	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070118

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method DELETE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20110114
2	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20110114

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20110114
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20110114

Method DELETE_INDEX_AND_CRAWL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN_CODES	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES		Return codes per object type	20070223
2	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070228
3	Importing	IT_INDEX_NAME_ID	Call by reference	☐	Type reference (TYPE)	SEFS_T_INDEX_NAME_ID		Index Name and Index ID	20070315
4	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070221

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070222
2	CX_SEFS_DB_CONFIG_ERROR	☐	Exception class for Configuration Error	20070209
3	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method DELETE_INDEX_TREX 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	20070118
2	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070118
3	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070118
4	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070118

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method DELETE_OBJECTS_WITH_CRAWL_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CRAWL_ID	Call by reference	☐	Type reference (TYPE)	TREXS_CRUISER-CRUISE_NAME		Crawl Id	20070205
2	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070205

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method FLUSH_QUEUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN_CODES	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES		Return codes per object type	20070226
2	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070228
3	Importing	IT_INDEX_NAME_ID	Call by reference	☑	Type reference (TYPE)	SEFS_T_INDEX_NAME_ID		Index Name and Index ID	20070315
4	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070221

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070222
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070227

Method FLUSH_QUEUES_TREX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUEUE_RETURN	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_RETURN		Queues with return code	20070126
2	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Return Code	20070126
3	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070126
4	Importing	IT_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_IDS		Indexes	20070201
5	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070126

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method GET_FREESTYLE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_FREESTYLE_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	TREXT_ATTRIBUTES		Freestyle Attributes	20070306

Method GET_FREESTYLE_ATTRIBUTES on class CL_SEFS_INDEX has no exception.

Method GET_INDEX_ATTRIBUTE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTRIBUTE_INFO	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_INFO		Attribute Definition Info	20070122
2	Exporting	ET_RETURN_CODES	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES		Return codes per object type	20070226
3	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070228
4	Importing	IT_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_IDS		Indexes	20070201
5	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070221

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070222

Method GET_INDEX_CRAWL_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CRAWL_STATE	Call by reference	☐	Type reference (TYPE)	SEFS_T_CRAWL_STATE		Crawl State	20070308
2	Exporting	ET_INDEX_STATE	Call by reference	☐	Type reference (TYPE)	SEFS_T_INDEX_STATE		Index State	20070308
3	Exporting	ET_RETURN_CODES	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES		Return codes per object type	20070226
4	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070228
5	Importing	IT_OBJECT_TYPE_INDEX	Call by reference	☐	Type reference (TYPE)	SEFS_T_OBJECT_TYPE_INDEX		Object Type, Index Name and Index ID	20070308
6	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070221

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070222
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070226

Method GET_INDEX_FOR_OBJ_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_INDEX	Call by reference	☐	Type reference (TYPE)	SEFS_T_INDEX		Index IDs with Object Types	20070328
2	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070328
3	Importing	IT_OBJ_TYPE	Call by reference	☑	Type reference (TYPE)	SEFS_T_OBJ_TYPE		Object Types	20070328
4	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070328
5	Importing	IV_OBJ_TYPE	Call by reference	☑	Type reference (TYPE)	SEFS_D_OBJECT_TYPE		Object Type	20070328

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070328
2	CX_SEFS_DB_CONFIG_ERROR	☐	Exception class for Configuration Error	20070328

Method GET_INDEX_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_INDEX_INFO	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_INFO		Details relevant for physical and logical indexes in TREX	20070122
2	Exporting	ET_RETURN_CODES	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES		Return codes per object type	20070226
3	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070228
4	Importing	IT_INDEX_NAME_ID	Call by reference	☐	Type reference (TYPE)	SEFS_T_INDEX_NAME_ID		Index Name and Index ID	20070315
5	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070221

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070222
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method GET_INDEX_INFO_TREX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTRIBUTE_INFO	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_INFO		Attribute Definition Info	20070122
2	Exporting	ET_INDEX_INFO	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_INFO		Details relevant for physical and logical indexes in TREX	20070122
3	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Returncode	20070122
4	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Returntext	20070122
5	Importing	IT_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_IDS		Indexes	20070201
6	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070122

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method GET_INDEX_LIST_TREX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_INDEX_LIST	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_DESCR		Indexes with description	20070214
2	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Return Code	20070214
3	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070214
4	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	TREXD_NAMESPACE		TREX Namespace	20070214
5	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070214

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070214

Method GET_INDEX_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_INDEX_STATE	Call by reference	☐	Type reference (TYPE)	SEFS_S_INDEX_STATE		Index State	20070219
2	Importing	IS_OBJECT_TYPE_INDEX	Call by reference	☐	Type reference (TYPE)	SEFS_S_OBJECT_TYPE_INDEX		Object Type, Index Name and Index ID	20070308
3	Importing	IT_INDEX_INFO	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_INFO		Details relevant for physical and logical indexes in TREX	20070219
4	Importing	IT_QUEUE_STATE	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_STATE_RETURN		Queues with returncode and number of documents	20070219

Method GET_INDEX_STATE on class CL_SEFS_INDEX has no exception.

Method GET_QUEUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUEUE_STATE	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_STATE_RETURN		Queues with returncode and number of documents	20070214
2	Importing	IT_INDEX_ID	Call by reference	☑	Type reference (TYPE)	TREXT_INDEX_IDS		Indexes	20070214

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070214

Method GET_QUEUES_TREX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUEUE_STATE	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_STATE_RETURN		Queues with returncode and number of documents	20070205
2	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Return Code	20070205
3	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070205
4	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	TREXD_NAMESPACE		TREX Namespace	20070205
5	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070205
6	Importing	LT_INDEX_ID	Call by reference	☑	Type reference (TYPE)	TREXT_INDEX_IDS		Indexes	20070205

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method GET_STATIC_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ATTRIBUTE_DEFINITIONS	Value transfer	☐	Type reference (TYPE)	TREXT_ATTR_DEF		Attribute definitions	20070319

Method GET_STATIC_ATTRIBUTES on class CL_SEFS_INDEX has no exception.

Method INDEX_TREX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN_ERROR_DOC	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_DOCS		Errors in Documents/Objects	20070226
2	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Return Code	20070226
3	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070226
4	Importing	IT_INDEX_DOC	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_DOCS		Documents/Objects for Indexing	20070226
5	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREX_RFC-INDEX_ID		Index ID	20070226
6	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RFC_DESTINATION		RFC Destination of Search Engine	20070226

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070226

Method IS_INDEX_SECURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_SECURE	Call by reference	☐	Type reference (TYPE)	XFELD		'X' = Index is Secure	20090325
2	Exporting	EV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20090325
3	Importing	IV_INDEX_ID	Call by reference	☑	Type reference (TYPE)	SEFS_D_INDEX_ID		Index ID	20090325
4	Importing	IV_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20090325
5	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	SEFS_D_OBJECT_TYPE		Object Type	20090325

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20090325

Method IS_INDEX_SECURE_ATTR_CHANGED 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	20071010
2	Exporting	EV_MSG_TXT	Call by reference	☐	Type reference (TYPE)	STRING		Message Text	20071010
3	Exporting	EV_SECURE_ATTR_CHANGED	Call by reference	☐	Type reference (TYPE)	XFELD		Secure Attribute Changed	20071010
4	Importing	IV_GET_ACCESS_RIGHT	Call by reference	☐	Type reference (TYPE)	SEFS_D_ACCESS_RIGHT		Secure	20071010
5	Importing	IV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20071010
6	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	SEFS_D_OBJECT_TYPE		Object Type	20071010

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20071010

Method SET_QUEUE_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUEUE_RETURN	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_RETURN		Queues with return code	20070226
2	Importing	IV_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXD_INDEX_ID		Index Id	20070126
3	Importing	IV_RUN_MODE	Call by reference	☐	Type reference (TYPE)	TREXS_CRUISER-RUN_MODE		1=update,2=continus,3=default,4=recrwal,5=repair, 6=full,7	20070126

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method SET_QUEUE_PARAMETERS_TREX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUEUE_RETURN	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_RETURN		Queues with return code	20070226
2	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Returncode	20070126
3	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Returntext	20070126
4	Importing	IT_QUEUE_PARAMETERS	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_PARAMETERS		queue parameter	20070126
5	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070126

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

Method SUSPEND_QUEUES_TREX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUEUE_RETURN	Call by reference	☐	Type reference (TYPE)	TREXT_QUEUE_RETURN		Queues with return code	20070205
2	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_CODE		Return Code	20070205
3	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	TREX_RFC-RETURN_TEXT		Return Text	20070205
4	Importing	IT_INDEX_ID	Call by reference	☐	Type reference (TYPE)	TREXT_INDEX_IDS		Indexes	20070205
5	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	TREXD_RFCDEST		RFC destination to TREX	20070205

#	Exception	Resumable	Description	Created on
1	CX_SEFS_CRAWL_INDEX_ERROR	☐	Crawl and Index Exceptions	20070226
2	CX_SEFS_TREX_ERROR	☐	TREX Administration Exceptions	20070207

History

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