SAP ABAP Class CL_ESH_RTI_REGISTRATION (Real-Time Indexing Registration Handler)

Hierarchy

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

Properties

Class	CL_ESH_RTI_REGISTRATION
Short Description	Real-Time Indexing Registration Handler
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_EXTRACTION	Extraction
Created	20110204	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_ESH_RTI_REGISTRATION has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_EX_FU_ADMIN	☐	20110204	Real-Time Indexing Administration

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_RTI_REG_LOCKARG_PREFIX	Constant	Protected	☐	Type reference (TYPE)	ESH_S_CO_LOCKTAB-LOCKARG	'ESH_RTI_REGISTRATION~'	Lock key for tables	20110207
2	GC_RTI_REG_LOCK_HEADER	Constant	Protected	☐	Type reference (TYPE)	RSTABLE-TABNAME	'ESH_RTI_REGISTRATION'	Lock header for FU daemon lock	20110207
3	MR_APPLOG	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20110204
4	MR_RTI_CALLBACK	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_RTI_CALLBACK		Real-Time Indexing Callback to Application	20110214
5	MT_LOCKTAB	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_CO_LOCKTAB		Lock administration table (lock references per lock arg.)	20110207
6	SR_RT_DATA	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA		ESH Search Runtime Data	20110214

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_OBJECTS_REGISTERED	Static method	Public	Method	Check objects registered for real-time indexing	20110215
2	CHECK_OBJECT_REGISTERED	Static method	Public	Method	Check object registered for real-time indexing	20110215
3	DETERMINE_REGISTRATION_DETAILS	Instance method	Private	Method	Determine Registration Details	20110204
4	GET_BACKEND_NAME	Static method	Public	Method	Get Backend Name	20110207
5	GET_INSTANCE	Static method	Protected	Method	Get Instance	20110204
6	GET_REGISTERED_OBJECT_TYPES	Static method	Public	Method	Get object types registered for real-time indexing	20110215
7	GET_RTI_REGISTRATION	Static method	Public	Method	Get registration record for an object type	20110215
8	LOCK_REGISTRATION	Instance method	Private	Method	Log Registration	20110204
9	REGISTER_OBJECT_TYPES	Instance method	Protected	Method	Register/Unregister Object types for Real-Time Indexing	20110204
10	SAVE_REGISTRATIONS	Instance method	Private	Method	Save Registration	20110204
11	TRIGGER_JOB_RESTART	Instance method	Private	Method	Trigger RTI Job Restart	20110204
12	UNLOCK_REGISTRATION	Instance method	Private	Method	Unlock Registration	20110204

Events

Class CL_ESH_RTI_REGISTRATION has no event.

Types

Class CL_ESH_RTI_REGISTRATION has no local type.

Method Signatures

Method CHECK_OBJECTS_REGISTERED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	CHAR01		Objects registered	20110215

Method CHECK_OBJECTS_REGISTERED on class CL_ESH_RTI_REGISTRATION has no exception.

Method CHECK_OBJECT_REGISTERED 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		Software Component	20110215
2	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20110215
3	Returning	RV_REGISTERED_FOR	Value transfer	☐	Type reference (TYPE)	ESH_E_EX_REGISTERED_FOR		Is Registered For	20110215

Method CHECK_OBJECT_REGISTERED on class CL_ESH_RTI_REGISTRATION has no exception.

Method DETERMINE_REGISTRATION_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DEREG_IN	Call by reference	☑	Type reference (TYPE)	ESH_T_FU_CO_REG		Objects to be deregistered	20110207
2	Changing	CT_REG_IN	Call by reference	☑	Type reference (TYPE)	ESH_T_FU_CO_REG		Objects to be registered	20110207
3	Exporting	ET_CALLBACK_DEREG	Call by reference	☐	Type reference (TYPE)	ESH_T_RTI_REG_CALLBACK		Callback for deregistrations	20110207
4	Exporting	ET_CALLBACK_REG	Call by reference	☐	Type reference (TYPE)	ESH_T_RTI_REG_CALLBACK		Callback for registrations	20110207
5	Exporting	ET_REGISTRATIONS_ADD	Call by reference	☐	Type reference (TYPE)	ESH_T_EX_FU_CONN		Registrations to add	20110204
6	Exporting	ET_REGISTRATIONS_DEL	Call by reference	☐	Type reference (TYPE)	ESH_T_EX_FU_CONN		Registrations to delete	20110204
7	Exporting	ET_REGISTRATIONS_MOD	Call by reference	☐	Type reference (TYPE)	ESH_T_EX_FU_CONN		Registrations to modify	20110204

Method DETERMINE_REGISTRATION_DETAILS on class CL_ESH_RTI_REGISTRATION has no exception.

Method GET_BACKEND_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HSWC	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Home-SWC	20110207
2	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20110207
3	Returning	RV_BACKEND_NAME	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20110207

Method GET_BACKEND_NAME on class CL_ESH_RTI_REGISTRATION has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_APPLOG	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20110204
2	Returning	RR_RTI_REGISTRATION_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_RTI_REGISTRATION		RTI Registration Handler	20110204

Method GET_INSTANCE on class CL_ESH_RTI_REGISTRATION has no exception.

Method GET_REGISTERED_OBJECT_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECT_TYPES_CP	Call by reference	☐	Type reference (TYPE)	ESH_T_EX_FU_CONN		Object Types registered for CP Processing	20110215
2	Exporting	ET_OBJECT_TYPES_FU	Call by reference	☐	Type reference (TYPE)	ESH_T_EX_FU_CONN		Object Types registered for FU Processing	20110215

Method GET_REGISTERED_OBJECT_TYPES on class CL_ESH_RTI_REGISTRATION has no exception.

Method GET_RTI_REGISTRATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_REGISTRATION	Call by reference	☐	Type reference (TYPE)	ESH_EX_FU_CONN		Real-Time Indexing Registration	20110215
2	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Hoime Software Component	20110215
3	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type ID	20110215

Method GET_RTI_REGISTRATION on class CL_ESH_RTI_REGISTRATION has no exception.

Method LOCK_REGISTRATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DEREG_IN	Call by reference	☑	Type reference (TYPE)	ESH_T_FU_CO_REG		Objects to be deregistered	20110207
2	Changing	CT_REG_IN	Call by reference	☑	Type reference (TYPE)	ESH_T_FU_CO_REG		Objects to be registered	20110207
3	Importing	IR_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20110207

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20110207
2	CX_ESH_CO_LOCKED	☐	ESH Locking Exception	20110207

Method REGISTER_OBJECT_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_REGISTER	Call by reference	☑	Type reference (TYPE)	ESH_T_FU_CO_REG		Register Object Types for Real-Time Indexing	20110204
2	Importing	IT_UNREGISTER	Call by reference	☑	Type reference (TYPE)	ESH_T_FU_CO_REG		Unregister Object Types	20110204
3	Importing	IV_AUTO_RESTART	Call by reference	☐	Type reference (TYPE)	CHAR01	ABAP_TRUE	Auto-Restart Process if it is not running and not on Hold	20110204
4	Importing	IV_COMMIT	Call by reference	☐	Type reference (TYPE)	CHAR01	ABAP_TRUE	Commit Work	20110204

#	Exception	Resumable	Description	Created on
1	CX_ESH_EX_PROCESS	☐	Extraction: Processing error	20110204

Method SAVE_REGISTRATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MARK_FOR_DEL	Call by reference	☐	Type reference (TYPE)	ESH_T_EX_FU_CONN		Registrations to mark for deletion	20110204
2	Importing	IT_REGISTRATIONS_ADD	Call by reference	☐	Type reference (TYPE)	ESH_T_EX_FU_CONN		Registrations to add	20110204
3	Importing	IT_REGISTRATIONS_DEL	Call by reference	☐	Type reference (TYPE)	ESH_T_EX_FU_CONN		Registrations to delete	20110204
4	Importing	IT_REGISTRATIONS_MOD	Call by reference	☐	Type reference (TYPE)	ESH_T_EX_FU_CONN		Registrations to modify	20110204
5	Importing	IV_COMMIT	Call by reference	☐	Type reference (TYPE)	CHAR01	ABAP_TRUE	COMMIT WORK	20110204
6	Importing	IV_SET_SUCCESS_MSGS	Call by reference	☑	Type reference (TYPE)	CHAR01		Set Success Messages	20110210

Method SAVE_REGISTRATIONS on class CL_ESH_RTI_REGISTRATION has no exception.

Method TRIGGER_JOB_RESTART Signature

Method TRIGGER_JOB_RESTART on class CL_ESH_RTI_REGISTRATION has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_EX_PROCESS	☐	Extraction: Processing error	20110211

Method UNLOCK_REGISTRATION Signature

Method UNLOCK_REGISTRATION on class CL_ESH_RTI_REGISTRATION has no parameter.
Method UNLOCK_REGISTRATION on class CL_ESH_RTI_REGISTRATION has no exception.

History

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