SAP ABAP Class CL_ESH_DPS_TOOLS (Tools class for Web Services)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_IF_DPS (Package) Enterprise Search - Search Data Provider Web Services

Properties

Class	CL_ESH_DPS_TOOLS
Short Description	Tools class for Web Services
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_IF_DPS	Enterprise Search - Search Data Provider Web Services
Created	20090107	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_ESH_DPS_TOOLS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	SEOO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_ESH_DPS_TOOLS has no interface implemented.

Friends

Class CL_ESH_DPS_TOOLS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ESH_PROVIDER_CLASS	Constant	Public	☐	Type reference (TYPE)	SEOCLSNAME	'CX_ESH_IF_PROVIDER_ERROR'	Object type name	20090113
2	GC_MESSAGE_ID	Constant	Public	☐	Type reference (TYPE)	SYST-MSGID	'ESH_SEARCH'	Message class	20090113

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_ADM_AUTHORITIES	Static method	Public	Method	Check for create, change, and display admin authorization	20090420
2	COMPLETE_MES_HANDLING_SUCCESS	Static method	Public	Method	Capsulate the success handling needed	20090119
3	COMPLETE_MES_HANDL_ERROR_DPS	Static method	Public	Method	Very detailed exception handling for DPS with text IDs	20090122
4	COMPLETE_MES_HANDL_ERROR_PROV	Static method	Public	Method	Capsulate the exception handling needed for framework	20090119
5	COMPLETE_MES_HANDL_ERR_PROV_DA	Static method	Public	Method	Capsulate the exception handling needed for framework	20090302
6	COMPLETE_MES_HANDL_ERR_PROV_EX	Static method	Public	Method	Capsulate the exception handling for external error messages	20110221
7	COMPLETE_MES_HANDL_ERR_PROV_TL	Static method	Public	Method	Capsulate the exception handling for framework in list	20090130
8	CREATE_REQUESTER_ID	Static method	Public	Method	Create the system ID used as requester	20090108
9	DETERMINE_CONNECTOR_ID	Static method	Public	Method	Determine the connector ID needed for the request	20090126
10	DETERMINE_NAMESPACE	Static method	Public	Method	Determine the namespace needed for the request	20090107
11	GET_ADDITION_FAULT_DATA_GEN	Static method	Private	Method	Gets the generic part of the addition fault data	20110221
12	GET_ADDITION_FAULT_DATA_INST	Static method	Private	Method	Gets the addition fault data for get next by instance	20110221
13	GET_ADDITION_FAULT_DATA_TSTMP	Static method	Private	Method	Gets the addition fault data for get next by timestamp	20110221
14	GET_STANDARD_FAULT_DATA	Static method	Private	Method	Gets the generic standard fault data for external errors	20110221
15	TEXT_CONVERT_LAST_INSTANCE_ID	Static method	Public	Method	Convert a url (string) to sy-message format	20110215
16	TEXT_CONVERT_SHORT	Static method	Public	Method	Convert a text message (string) to sy-message	20110124
17	TEXT_MESSAGE_CONVERT_SHORT	Static method	Public	Method	Convert a text message (string) to sy-message	20090112

Events

Class CL_ESH_DPS_TOOLS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YESH_S_WS_URL_ERROR	Public	See coding			20110215	BEGIN OF yesh_s_ws_url_error, message_v1 TYPE symsgv, message_v2 TYPE symsgv, message_v3 TYPE symsgv, message_v4 TYPE symsgv, END OF yesh_s_ws_url_error
2	YESH_T_WS_URL_ERROR	Public	See coding			20110215	yesh_t_ws_url_error TYPE STANDARD TABLE OF yesh_s_ws_url_error

Method Signatures

Method CHECK_ADM_AUTHORITIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_CHANGE_AUTHORIZED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090420
2	Exporting	EV_IS_CREATE_AUTHORIZED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090420
3	Exporting	EV_IS_DISPLAY_AUTHORIZED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090420

Method CHECK_ADM_AUTHORITIES on class CL_ESH_DPS_TOOLS has no exception.

Method COMPLETE_MES_HANDLING_SUCCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090119
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090119
3	Importing	IV_MSG_ID	Call by reference	☐	Type reference (TYPE)	SYST-MSGID		Message Class	20090119
4	Importing	IV_MSG_MSGV1	Call by reference	☑	Type reference (TYPE)	CHAR255		CHAR255	20090119
5	Importing	IV_MSG_MSGV2	Call by reference	☑	Type reference (TYPE)	CHAR255		CHAR255	20090119
6	Importing	IV_MSG_MSGV3	Call by reference	☑	Type reference (TYPE)	CHAR255		CHAR255	20090119
7	Importing	IV_MSG_MSGV4	Call by reference	☑	Type reference (TYPE)	CHAR255		CHAR255	20090119
8	Importing	IV_MSG_NO	Call by reference	☐	Type reference (TYPE)	SYST-MSGNO		Message Number	20090119
9	Importing	IV_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type	20090119

Method COMPLETE_MES_HANDLING_SUCCESS on class CL_ESH_DPS_TOOLS has no exception.

Method COMPLETE_MES_HANDL_ERROR_DPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090122
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090122
3	Importing	IR_ERROR	Call by reference	☑	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20090122
4	Importing	IS_EXCEPTION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	'X'		20110207
5	Importing	IV_MSG_ID	Call by reference	☐	Type reference (TYPE)	SYST-MSGID		Message Class	20090122
6	Importing	IV_MSG_MSGV1	Call by reference	☑	Type reference (TYPE)	CHAR255		Char255	20090122
7	Importing	IV_MSG_MSGV2	Call by reference	☑	Type reference (TYPE)	CHAR255		Char255	20090122
8	Importing	IV_MSG_MSGV3	Call by reference	☑	Type reference (TYPE)	CHAR255		Char255	20090122
9	Importing	IV_MSG_MSGV4	Call by reference	☑	Type reference (TYPE)	CHAR255		Char255	20090122
10	Importing	IV_MSG_NO	Call by reference	☐	Type reference (TYPE)	SYST-MSGNO		Message Number	20090122
11	Importing	IV_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type	20090122
12	Importing	IV_TEXTID	Call by reference	☐	Type reference (TYPE)	SCX_T100KEY		T100 Key with Parameters Mapped to Attribute Names	20090122

#	Exception	Resumable	Description	Created on
1	CX_ESH_DPS_ENGINE_ERROR	☐	General errors in dps services	20090122

Method COMPLETE_MES_HANDL_ERROR_PROV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090119
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090119
3	Importing	IR_ERROR	Call by reference	☑	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20090120
4	Importing	IV_MSG_ID	Call by reference	☐	Type reference (TYPE)	SYST-MSGID		Message Class	20090119
5	Importing	IV_MSG_MSGV1	Call by reference	☑	Type reference (TYPE)	CHAR255		char255	20090119
6	Importing	IV_MSG_MSGV2	Call by reference	☑	Type reference (TYPE)	CHAR255		char255	20090119
7	Importing	IV_MSG_MSGV3	Call by reference	☑	Type reference (TYPE)	CHAR255		char255	20090119
8	Importing	IV_MSG_MSGV4	Call by reference	☑	Type reference (TYPE)	CHAR255		char255	20090119
9	Importing	IV_MSG_NO	Call by reference	☐	Type reference (TYPE)	SYST-MSGNO		Message Number	20090119
10	Importing	IV_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type	20090119

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20090119

Method COMPLETE_MES_HANDL_ERR_PROV_DA 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		Table with BAPI Return Information	20090302
2	Importing	IR_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20090302
3	Importing	IT_MESSAGES	Call by reference	☑	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20110215
4	Importing	IV_MSG_ID	Call by reference	☑	Type reference (TYPE)	SYST-MSGID		Message Class	20090302
5	Importing	IV_MSG_MSGV1	Call by reference	☑	Type reference (TYPE)	CHAR255		char255	20090302
6	Importing	IV_MSG_MSGV2	Call by reference	☑	Type reference (TYPE)	CHAR255		char255	20090302
7	Importing	IV_MSG_MSGV3	Call by reference	☑	Type reference (TYPE)	CHAR255		char255	20090302
8	Importing	IV_MSG_MSGV4	Call by reference	☑	Type reference (TYPE)	CHAR255		char255	20090302
9	Importing	IV_MSG_NO	Call by reference	☑	Type reference (TYPE)	SYST-MSGNO		Message Number	20090302
10	Importing	IV_MSG_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY		Message Type	20090302

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20090302

Method COMPLETE_MES_HANDL_ERR_PROV_EX 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		Table with BAPI Return Information	20110221
2	Importing	IR_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20110221

Method COMPLETE_MES_HANDL_ERR_PROV_EX on class CL_ESH_DPS_TOOLS has no exception.

Method COMPLETE_MES_HANDL_ERR_PROV_TL 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		Table with BAPI Return Information	20090130
2	Importing	IR_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20090130

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20090130

Method CREATE_REQUESTER_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_REQUESTER_ID	Call by reference	☐	Type reference (TYPE)	ESH_WS_SEARCH_REQUESTER_ID		Identifier for the instance that sends the search request	20090108

Method CREATE_REQUESTER_ID on class CL_ESH_DPS_TOOLS has no exception.

Method DETERMINE_CONNECTOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090126
2	Exporting	EV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20090126
3	Importing	IR_CONNECTIVITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_ADM_ANY_CONNECTIVITY		Connectivity details	20090126
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20090126

#	Exception	Resumable	Description	Created on
1	CX_ESH_DPS_ENGINE_ERROR	☐	General errors in dps services	20090126

Method DETERMINE_NAMESPACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090121
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090121
3	Exporting	EV_NAMESPACE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20090107
4	Importing	IR_CONNECTIVITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_ADM_ANY_CONNECTIVITY		Connectivity details	20090107
5	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Software Component	20090203

#	Exception	Resumable	Description	Created on
1	CX_ESH_DPS_ENGINE_ERROR	☐	General errors in dps services	20090126

Method GET_ADDITION_FAULT_DATA_GEN 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		Table with BAPI Return Information	20110221
2	Importing	IT_SEARCH_NODE_ERROR	Call by reference	☐	Type reference (TYPE)	ESH_WS_SEARCH_NODE_ERROR_V_TAB		The data for the erroneous node type for the search data ser	20110221

Method GET_ADDITION_FAULT_DATA_GEN on class CL_ESH_DPS_TOOLS has no exception.

Method GET_ADDITION_FAULT_DATA_INST 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		Table with BAPI Return Information	20110221
2	Importing	IR_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	CX_ESH_WS_SEARCH_DATA_GET_NEXT		Fault message type for DPS data service	20110221

Method GET_ADDITION_FAULT_DATA_INST on class CL_ESH_DPS_TOOLS has no exception.

Method GET_ADDITION_FAULT_DATA_TSTMP 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		Table with BAPI Return Information	20110221
2	Importing	IR_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	CX_ESH_WS_SEARCH_DATA_GET_NEX1		Fault message type for DPS data service	20110221

Method GET_ADDITION_FAULT_DATA_TSTMP on class CL_ESH_DPS_TOOLS has no exception.

Method GET_STANDARD_FAULT_DATA 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		Table with BAPI Return Information	20110221
2	Importing	IS_STANDARD_FAULT_DATA	Call by reference	☐	Type reference (TYPE)	ESH_WS_EXCHANGE_FAULT_DATA			20110221

Method GET_STANDARD_FAULT_DATA on class CL_ESH_DPS_TOOLS has no exception.

Method TEXT_CONVERT_LAST_INSTANCE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE_PARAMETERS	Call by reference	☐	Type reference (TYPE)	CL_ESH_DPS_TOOLS=>YESH_T_WS_URL_ERROR			20110215
2	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20110215

Method TEXT_CONVERT_LAST_INSTANCE_ID on class CL_ESH_DPS_TOOLS has no exception.

Method TEXT_CONVERT_SHORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_MSG_MSGV1	Call by reference	☐	Type reference (TYPE)	CHAR255		Char255	20110124
2	Exporting	EV_MSG_MSGV2	Call by reference	☐	Type reference (TYPE)	CHAR255		Char255	20110124
3	Exporting	EV_MSG_MSGV3	Call by reference	☐	Type reference (TYPE)	CHAR255		Char255	20110124
4	Exporting	EV_MSG_MSGV4	Call by reference	☐	Type reference (TYPE)	CHAR255		Char255	20110124
5	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Message Text	20110124

Method TEXT_CONVERT_SHORT on class CL_ESH_DPS_TOOLS has no exception.

Method TEXT_MESSAGE_CONVERT_SHORT 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		Table with BAPI Return Information	20090112
2	Importing	IV_MESSAGE_ID	Call by reference	☑	Type reference (TYPE)	SYMSGID		Message ID	20090112
3	Importing	IV_MESSAGE_NO	Call by reference	☑	Type reference (TYPE)	SYMSGNO		Message No (has to contain &1&2&3&4)	20090112
4	Importing	IV_MESSAGE_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY		Message Type A, E, W, I, S	20090112
5	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Message Text	20090112

Method TEXT_MESSAGE_CONVERT_SHORT on class CL_ESH_DPS_TOOLS has no exception.

History

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