SAP ABAP Class CL_CRM_GENIL_ES (GenIL Implementation Class for CRM_ES Component)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-ES (Application Component) Enterprise Search Integration
     ⤷ CRM_ES_GENIL (Package) Enterprise Search: Genil Access

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_CRM_GENIL_ABSTR_COMPONENT2	Pattern for Components with Alternative DSLI Interface	20080402

Properties

Class	CL_CRM_GENIL_ES
Short Description	GenIL Implementation Class for CRM_ES Component
Super Class	CL_CRM_GENIL_ABSTR_COMPONENT2	Pattern for Components with Alternative DSLI Interface
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CRM_ES_GENIL	Enterprise Search: Genil Access
Created	20080402	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)
2	CL_CRM_GENIL_ABSTR_COMPONENT2	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_CRM_GENIL_ES has no interface implemented.

Friends

Class CL_CRM_GENIL_ES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ALL_ATTR_SEARCH_STRING	Constant	Public	☐	Type reference (TYPE)	STRING	'ALL_ATTRIBUTES_SEARCH_STRING'	name of field in request for all attributes search string	20080407
2	GC_BOL_ROOT_ENTITY_KEY	Constant	Public	☐	Type reference (TYPE)	STRING	'BOL_ROOT_ENTITY_KEY'	name of field in response containg BOL root entity key	20080408
3	GC_DEFAULT_MAX_HITS	Constant	Protected	☐	Type reference (TYPE)	INT4	50	default max hits	20080403
4	GC_DEFAULT_START_INDEX	Constant	Protected	☐	Type reference (TYPE)	INT4	1	default start index	20080403
5	GC_QUERY_NAME_SUFFIX	Constant	Public	☐	Type reference (TYPE)	STRING	'_ESSearch'	suffix for query name	20080407
6	GC_QUERY_RESULT_NAME_SUFFIX	Constant	Public	☐	Type reference (TYPE)	STRING	'_ESResult'	suffix for query result name	20080407
7	GC_RELATION_QR_TO_ROOT	Constant	Public	☐	Type reference (TYPE)	STRING	'RelToRoot'	relation name for relation from qr to root	20080408
8	GR_GLOBAL_MSG_CONT	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CRM_GENIL_GLOBAL_MESS_CONT		global message container	20080411
9	GT_CONNECTOR_IDS	Static Attribute	Protected	☐	Type reference (TYPE)	ESH_T_IF_MDATA_CONNECTORS		Meta Data: Connectors	20080402
10	GT_OBJ_PROPS	Static Attribute	Protected	☐	Type reference (TYPE)	CRMT_OBJ_PROPERTIES_TAB		Table of Business Object Attributes	20080404
11	GT_QUERY_INSTANCES	Static Attribute	Protected	☐	Type reference (TYPE)	CRMT_ES_GENIL_INSTANCES		Tabel type of CRMS_ES_GENIL_INSTANCES	20080402
12	GT_RELATION_DET	Static Attribute	Protected	☐	Type reference (TYPE)	CRMT_RELATION_DETAIL_TAB		Table of Relation Detail Data	20080408
13	GT_TEMPLATE_KEYSTRUCTURE	Static Attribute	Protected	☐	Type reference (TYPE)	CRMT_ES_TEMPLATE_KEYSTRUC_TAB		CRM ES Templates and Keystructures	20080409
14	GV_ADJUST_SEARCH_TEXT	Static Attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	turn automatic adjustment of search values on or off	20080813
15	GV_HOLD	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		hold: accumulate ES queries	20080402

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJUST_SEARCH_FILTER_TEXT	Static method	Protected	Method	Adjust search text to support special situations	20090223
2	ADJUST_SEARCH_TEXT	Static method	Protected	Method	Adjust search text to support special situations	20080813
3	BUILD_MODEL	Static method	Protected	Method	Gets the model and fills the global variables	20080408
4	CLEANUP	Static method	Protected	Method	Clean up query instances table	20080408
5	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20080402
6	EXECUTE_ACCUMULATED_QUERIES	Static method	Protected	Method	Executes accumulated quries	20080403
7	EXECUTE_QUERY	Static method	Protected	Method	Executes ES query	20080402
8	FIND_KEYSTRUCTURE_FOR_TEMPLATE	Static method	Protected	Method	Returns the key-structure for one/all templates	20080407
9	GET_ALL_ATTR_SEARCH_STRING	Static method	Protected	Method	Get all attributes search string from selection parameters	20080407
10	GET_CONNECTOR_ID	Static method	Protected	Method		20080402
11	GET_FIELD_TYPE	Static method	Public	Method	Get field type for given query object	20090525
12	GET_QUERY_NAME	Static method	Protected	Method	Get query name from template id	20080403
13	GET_QUERY_RESULT_NAME	Static method	Protected	Method	Get query result name from template id	20080403
14	GET_RELATION_NAME	Static method	Protected	Method	Get relation name from template id	20080414
15	GET_RELTOROOT_NAME	Static method	Public	Method	Get relation to root name for given query result object name	20080414
16	GET_ROOT_NAME	Static method	Public	Method	Gets the name of the root object for a given query result ob	20080413
17	GET_TEMPLATE_ID_FROM_QRESULT	Static method	Public	Method	Get template id from query result name	20080628
18	GET_TEMPLATE_ID_FROM_QUERY	Static method	Public	Method	Get template id from query name	20080407
19	HOLD	Static method	Public	Method	Hold on to accumulate searches for all objects	20080402
20	MAP_ES_RESULT_TO_BOL_RESULT	Static method	Protected	Method	Maps ES search result table to BOL query result object	20080403
21	UNHOLD	Static method	Public	Method	Unhold to exceute accumulated searches for all objects	20080403

Events

Class CL_CRM_GENIL_ES has no event.

Types

Class CL_CRM_GENIL_ES has no local type.

Method Signatures

Method ADJUST_SEARCH_FILTER_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT	Call by reference	☐	Type reference (TYPE)	STRING			20090223
2	Importing	IV_SEARCH_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20090223
3	Returning	RV_SEARCH_TEXT_ADJUSTED	Value transfer	☐	Type reference (TYPE)	STRING			20090223

Method ADJUST_SEARCH_FILTER_TEXT on class CL_CRM_GENIL_ES has no exception.

Method ADJUST_SEARCH_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT	Call by reference	☐	Type reference (TYPE)	STRING			20080813
2	Importing	IV_SEARCH_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20080813
3	Returning	RV_SEARCH_TEXT_ADJUSTED	Value transfer	☐	Type reference (TYPE)	STRING			20080813

Method ADJUST_SEARCH_TEXT on class CL_CRM_GENIL_ES has no exception.

Method BUILD_MODEL Signature

Method BUILD_MODEL on class CL_CRM_GENIL_ES has no parameter.
Method BUILD_MODEL on class CL_CRM_GENIL_ES has no exception.

Method CLEANUP Signature

Method CLEANUP on class CL_CRM_GENIL_ES has no parameter.
Method CLEANUP on class CL_CRM_GENIL_ES has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT_NAME	Call by reference	☑	Type reference (TYPE)	CRMT_COMPONENT_NAME		Component Name	20080402
2	Importing	IV_MODE	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20080402

Method CONSTRUCTOR on class CL_CRM_GENIL_ES has no exception.

Method EXECUTE_ACCUMULATED_QUERIES Signature

Method EXECUTE_ACCUMULATED_QUERIES on class CL_CRM_GENIL_ES has no parameter.
Method EXECUTE_ACCUMULATED_QUERIES on class CL_CRM_GENIL_ES has no exception.

Method EXECUTE_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_QUERY_INSTANCES	Call by reference	☐	Type reference (TYPE)	CRMT_ES_GENIL_INSTANCES		Tabe type of CRMS_ES_GENIL_QUERIES	20080410

Method EXECUTE_QUERY on class CL_CRM_GENIL_ES has no exception.

Method FIND_KEYSTRUCTURE_FOR_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TEMPLATE_KEYSTRUCTURE	Call by reference	☐	Type reference (TYPE)	CRMT_ES_TEMPLATE_KEYSTRUC_TAB		Template and related Key-Structure	20080407
2	Importing	IV_TEMPLATE_ID	Call by reference	☑	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template ID for CRM ES	20080407

Method FIND_KEYSTRUCTURE_FOR_TEMPLATE on class CL_CRM_GENIL_ES has no exception.

Method GET_ALL_ATTR_SEARCH_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SELECTION_PARAMETERS	Call by reference	☐	Type reference (TYPE)	GENILT_SELECTION_PARAMETER_TAB		Complex Search Condition	20080409
2	Returning	RV_ALL_ATTR_SEARCH_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20080409

Method GET_ALL_ATTR_SEARCH_STRING on class CL_CRM_GENIL_ES has no exception.

Method GET_CONNECTOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20080402
2	Returning	RV_CONNECTOR_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080402

Method GET_CONNECTOR_ID on class CL_CRM_GENIL_ES has no exception.

Method GET_FIELD_TYPE 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)	STRING		Field Name	20090525
2	Importing	IV_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20090525
3	Returning	RV_TYPE	Value transfer	☐	Type reference (TYPE)	INTTYPE		ABAP data type (C,D,N,...)	20090525

Method GET_FIELD_TYPE on class CL_CRM_GENIL_ES has no exception.

Method GET_QUERY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template ID for CRM ES	20080403
2	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20080403

Method GET_QUERY_NAME on class CL_CRM_GENIL_ES has no exception.

Method GET_QUERY_RESULT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template ID for CRM ES	20080403
2	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20080403

Method GET_QUERY_RESULT_NAME on class CL_CRM_GENIL_ES has no exception.

Method GET_RELATION_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template ID for CRM ES	20080414
2	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	CRMT_RELATION_NAME		External Name of Object	20080414

Method GET_RELATION_NAME on class CL_CRM_GENIL_ES has no exception.

Method GET_RELTOROOT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QRESULT_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		Template ID for CRM ES	20080414
2	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	CRMT_RELATION_NAME		External Name of Object	20080414

Method GET_RELTOROOT_NAME on class CL_CRM_GENIL_ES has no exception.

Method GET_ROOT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOAD_COMP_SET	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	'X'		20080628
2	Importing	IV_QRESULT_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20080413
3	Returning	RV_ROOT_NAME	Value transfer	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20080413

Method GET_ROOT_NAME on class CL_CRM_GENIL_ES has no exception.

Method GET_TEMPLATE_ID_FROM_QRESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QRESULT_NAME	Value transfer	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20080628
2	Returning	RV_TEMPLATE	Value transfer	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template ID for CRM ES	20080628

Method GET_TEMPLATE_ID_FROM_QRESULT on class CL_CRM_GENIL_ES has no exception.

Method GET_TEMPLATE_ID_FROM_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QUERY_NAME	Value transfer	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20080407
2	Returning	RV_TEMPLATE	Value transfer	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template ID for CRM ES	20080407

Method GET_TEMPLATE_ID_FROM_QUERY on class CL_CRM_GENIL_ES has no exception.

Method HOLD Signature

Method HOLD on class CL_CRM_GENIL_ES has no parameter.
Method HOLD on class CL_CRM_GENIL_ES has no exception.

Method MAP_ES_RESULT_TO_BOL_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESULT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20080403
2	Importing	IV_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20080404
3	Importing	IV_ROOT_LIST	Call by reference	☐	Object reference (TYPE REF TO)	IF_GENIL_CONT_ROOT_OBJECTLIST		Data Container - Root Object List Interface	20080403

Method MAP_ES_RESULT_TO_BOL_RESULT on class CL_CRM_GENIL_ES has no exception.

Method UNHOLD Signature

Method UNHOLD on class CL_CRM_GENIL_ES has no parameter.
Method UNHOLD on class CL_CRM_GENIL_ES has no exception.

History

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