SAP ABAP Class CL_WCF_ES_CONNECTOR_UTIL (WEBCUIF-ES connector utilities)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-ES (Application Component) Enterprise Search Integration
     ⤷ WCF_ES_NW_INTEG (Package) BOL-Enterprise Search integration

Properties

Class	CL_WCF_ES_CONNECTOR_UTIL
Short Description	WEBCUIF-ES connector utilities
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	WCF_ES_NW_INTEG	BOL-Enterprise Search integration
Created	20101008	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_CRM_ES_MODEL_MGR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_WCF_ES_CONNECTOR_UTIL has no interface implemented.

Friends

Class CL_WCF_ES_CONNECTOR_UTIL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GR_NW_CONNECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR		Meta Data: Search Connector	20101012
2	GT_CONNECTORS	Static Attribute	Private	☐	Type reference (TYPE)	TY_LT_CONNECTORS		Table holding connector references	20101008
3	GV_CONNECTOR_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20101012
4	GV_TEMPLATE_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20101015

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_STRUCTURE	Static method	Private	Method	Activation of generated DDIC-Objects	20101012
2	CALCULATE_HASH_CODE	Instance method	Private	Method	Calculate hash code	20101029
3	CHECK_FOR_ACTIVE_STRUCTURES	Instance method	Public	Method	Check if active request and response structures are availabl	20101207
4	COMPARE_HASH_CODES	Instance method	Public	Method	Compare has codes	20101201
5	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20101008
6	CREATE_STRUCTURE	Static method	Private	Method	Creates a structure	20101012
7	DELETE_CONNECTOR_REF	Static method	Public	Method	Delete connector reference	20101105
8	DELETE_STRUCTURE	Static method	Public	Method	Trigger deletion of request and response structures	20101103
9	FILTER_NW_CONNECTORS	Static method	Public	Method	Get NetWeaver connectors relevant to the system	20101012
10	FROM_TEMPLATE_NAME_TO_CONNID	Static method	Public	Method	Given the template name obtain the connector id	20101013
11	GENERATE_STRUCTURE	Instance method	Public	Method	Trigger generation of request and response structures	20101012
12	GET_DD_FIELDS_FROM_CONNECTOR	Instance method	Private	Method	Get dd-fields of a template	20101012
13	GET_DEVCLASS	Static method	Private	Method	Gets the dev class for the query structure generation	20101203
14	GET_FIELDS_OF_EXIST_STRUCTURES	Static method	Private	Method	Returns fields of active structure	20101012
15	GET_INSTANCE	Static method	Public	Method	Returns Reference of Instance	20101008
16	GET_INSTANCE_FROM_TEMPLATE	Static method	Public	Method	Returns Reference of Instance	20101015
17	GET_NAMESPACE	Static method	Private	Method	Gets the namespace for the query structure generation	20101203
18	GET_TEMPLATE_ID	Instance method	Public	Method	Get name of template	20101105
19	SET_TEMPLATE_ID	Instance method	Private	Method	Set gv_template_id	20101025
20	WRITE_TADIR_ENTRY	Static method	Private	Method	Write TADIR-Entry	20101012

Events

Class CL_WCF_ES_CONNECTOR_UTIL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_LS_CONNECTOR	Protected	See coding			20101008	begin of ty_ls_connector, connector_id type esh_e_if_search_connector_id, connector_ref type ref to cl_wcf_es_connector_util, end of ty_ls_connector
2	TY_LT_CONNECTORS	Protected	See coding			20101008	ty_lt_connectors type sorted table of ty_ls_connector with unique key connector_id

Method Signatures

Method ACTIVATE_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STRUCNAME	Call by reference	☐	Type reference (TYPE)	STRUKNAME		UI Object Type	20101012

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	Static exception class for web service consumption	20101012

Method CALCULATE_HASH_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_HASH_CODE	Value transfer	☐	Type reference (TYPE)	WCF_ES_HASH_CODE		Hash code	20101029

#	Exception	Resumable	Description	Created on
1	CX_WCF_ES_FAULT	☐	General exception in BOL-ES integration	20101029

Method CHECK_FOR_ACTIVE_STRUCTURES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OK	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20101207

Method CHECK_FOR_ACTIVE_STRUCTURES on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method COMPARE_HASH_CODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_EQUAL_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		'X' = true, ' ' = false	20101202
2	Exporting	EV_NEW_HASH_CODE	Call by reference	☐	Type reference (TYPE)	WCF_ES_HASH_CODE		Hash code	20101202
3	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_BADI_MD_CO_CONNECTOR		Connector id	20101201

#	Exception	Resumable	Description	Created on
1	CX_WCF_ES_FAULT	☐	General exception in BOL-ES integration	20101201

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20101008
2	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20101105

Method CONSTRUCTOR on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method CREATE_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DD_FIELDS	Call by reference	☐	Type reference (TYPE)	CL_CRM_ES_MODEL_MGR=>LT_DD03P_TAB			20101012
2	Importing	IV_STRUCNAME	Call by reference	☐	Type reference (TYPE)	STRUKNAME		Name of a structure	20101012

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	Static exception class for web service consumption	20101012

Method DELETE_CONNECTOR_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20101105

Method DELETE_CONNECTOR_REF on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method DELETE_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20101105

Method DELETE_STRUCTURE on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method FILTER_NW_CONNECTORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CONNECTORS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_BADI_MD_CO_CONNECTORS		Meta Data BAdI: Connectors	20101012

Method FILTER_NW_CONNECTORS on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method FROM_TEMPLATE_NAME_TO_CONNID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_MDATA_CONNECTOR		Connector id	20101013
2	Exporting	EV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_TEMPLATE_ID		Template id	20101013
3	Importing	IV_INCL_CONNECTOR_ID	Call by reference	☑	Type reference (TYPE)	BOOLEAN		X = return connector id	20101013
4	Importing	IV_SOFTWARE_COMPONENT	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Software component	20101013
5	Importing	IV_TEMPLATE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Template name	20101013

#	Exception	Resumable	Description	Created on
1	CX_WCF_ES_FAULT	☐	General exception in BOL-ES integration	20101013

Method GENERATE_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Messages	20101012
2	Importing	IV_INCLUDE_OLD_FIELDS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20101012

Method GENERATE_STRUCTURE on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method GET_DD_FIELDS_FROM_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DD_FIELDS_REQUEST	Call by reference	☐	Type reference (TYPE)	CL_CRM_ES_MODEL_MGR=>LT_DD03P_TAB		describe complete object	20101012
2	Exporting	ET_DD_FIELDS_RESPONSE	Call by reference	☐	Type reference (TYPE)	CL_CRM_ES_MODEL_MGR=>LT_DD03P_TAB			20101012
3	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20101012

Method GET_DD_FIELDS_FROM_CONNECTOR on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method GET_DEVCLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_DEVCLASS	Value transfer	☐	Type reference (TYPE)	DEVCLASS		Package	20101203

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	CRM ES exception class	20101203

Method GET_FIELDS_OF_EXIST_STRUCTURES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_REQUEST_FIELDS	Call by reference	☐	Type reference (TYPE)	CL_CRM_ES_MODEL_MGR=>LT_DD03P_TAB			20101012
2	Exporting	ET_RESPONSE_FIELDS	Call by reference	☐	Type reference (TYPE)	CL_CRM_ES_MODEL_MGR=>LT_DD03P_TAB			20101012
3	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		UUID for CRM Web Service Consumption Tool	20101012

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	Static exception class for web service consumption	20101012

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20101008
2	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_WCF_ES_CONNECTOR_UTIL		WEBCUIF-ES connector utilities	20101008

Method GET_INSTANCE on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method GET_INSTANCE_FROM_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SOFTWARE_COMPONENT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		Software Component	20101015
2	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Search Connector ID	20101015
3	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_WCF_ES_CONNECTOR_UTIL		WEBCUIF-ES connector utilities	20101015

Method GET_INSTANCE_FROM_TEMPLATE on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method GET_NAMESPACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NAMESPACE	Value transfer	☐	Type reference (TYPE)	NAMESPACE		Namespace	20101203

Method GET_NAMESPACE on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method GET_TEMPLATE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TEMPLATE_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20101105

Method GET_TEMPLATE_ID on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method SET_TEMPLATE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20101025

Method SET_TEMPLATE_ID on class CL_WCF_ES_CONNECTOR_UTIL has no exception.

Method WRITE_TADIR_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT	Call by reference	☐	Type reference (TYPE)	TROBJTYPE		Object Type	20101012
2	Importing	IV_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	SOBJ_NAME		Object Name in Object Directory	20101012

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	Static exception class for web service consumption	20101012

History

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