SAP ABAP Class CL_ESH_DPS_DATA (Main Class: Data Provider Services Data)

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_ITERATOR	Object data iterator by last object id	20081114
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_ITERATOR_TIME	Object data iterator by last timestamp	20081114

Properties

Class	CL_ESH_DPS_DATA
Short Description	Main Class: Data Provider Services Data
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	20081114	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

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_IF_OBJECT_ITERATOR	☐	☐	Object data iterator by last object id	20081114
2	IF_ESH_IF_OBJECT_ITERATOR_TIME	☐	☐	Object data iterator by last timestamp	20081114

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_DPS_D_NEXT_BY_INST_RES	☐	20090507	Helper class Data Provider Services
2	CL_ESH_DPS_D_NEXT_BY_TIME_RES	☐	20090507	Helper class Data Provider Services

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_BOOLEAN_DOMNAME	Constant	Private	☐	Type reference (TYPE)	DOMNAME	'XSDBOOLEAN'	Domain name	20090508
2	GC_DATETIME_DOMNAME	Constant	Private	☐	Type reference (TYPE)	DOMNAME	'TZNTSTMPL'	Domain name	20090507
3	GC_DATE_DOMNAME	Constant	Private	☐	Type reference (TYPE)	DOMNAME	'DATS'	Domain name	20090507
4	GC_IN_DATATYPE_DEC	Constant	Private	☐	Type reference (TYPE)	STRING	'DEC'		20090508
5	GC_MSG_ID	Constant	Private	☐	Type reference (TYPE)	SYMSGID	'ESH_SEARCH'	Message class	20090511
6	GC_MSG_TYPE_W	Constant	Private	☐	Type reference (TYPE)	SYMSGTY	'W'	Message type	20090511
7	GC_TIME_DOMNAME	Constant	Private	☐	Type reference (TYPE)	DOMNAME	'TIME'	Domain name	20090507
8	GR_DATA_OUT	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CO_ESH_WS_SEARCH_DATA_OUT		Search data service	20100318
9	GV_COMPLETE_ERROR_COUNTER	Static Attribute	Private	☐	Type reference (TYPE)	INT4		Natural number	20090511
10	GV_ERROR_RECORDS_FINAL	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20090511
11	GV_RECORD_COUNTER	Static Attribute	Private	☐	Type reference (TYPE)	INT4		Natural number	20090511
12	HOME_SOFTWARE_COMPONENT	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Software component	20090203
13	OBJECT_TYPE_BACKEND_NAME	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Back-end name	20081218
14	OBJECT_TYPE_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20081218
15	R_CONNECTIVITY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_ADM_ANY_CONNECTIVITY		Connectivity details	20081218

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJUST_DECIMAL_VALUE	Static method	Private	Method	Adjusts decimal values if necessary and possible	20110210
2	BUILD_WARNING	Static method	Private	Method	Build a warning if the attribute value is not correct	20090511
3	BUILD_WARNING_MESSAGES	Static method	Private	Method	Build the messages from the warning string for log	20090511
4	CHECK_AND_ADJUST_DECIMAL_VALUE	Static method	Private	Method	Checks and adjusts decimal values if possible	20110210
5	CHECK_CASE_SENSITIVITY	Static method	Private	Method	Check case sensitivity of attributes for a better message	20100929
6	CHECK_FOR_MULTIPLE_DELIMITERS	Static method	Private	Method	Checks for multiple delimiters and their validity	20110210
7	CHECK_SPECIFIC_FORMATS	Static method	Private	Method	Check for specific formats e.g. time, date, date and time	20090507
8	CONSTRUCTOR	Instance method	Public	Constructor		20081218
9	EXTRACT_UNALLOWED_CHARACTERS	Static method	Private	Method	Extract unallowed characters from logical port name	20090507
10	RESTART_MULTIPLE_DPS	Instance method	Public	Method	Restart several objects	20090814
11	TEXT_MESSAGE_CONVERT_SHORT	Static method	Public	Method	Convert a text message (string) to sy-message	20090511

Events

Class CL_ESH_DPS_DATA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YESH_S_WS_CASE_SENSITIVITY	Private	See coding			20100929	BEGIN OF yesh_s_ws_case_sensitivity, original_attribute_id TYPE char255, upper_case_attribute_id TYPE char255, END OF yesh_s_ws_case_sensitivity
2	YESH_S_WS_UNALLOWED_CHARACTERS	Private	See coding			20090507	BEGIN OF yesh_s_ws_unallowed_characters, character TYPE char1, END OF yesh_s_ws_unallowed_characters
3	YESH_T_WS_CASE_SENSITIVITY	Private	See coding			20100929	yesh_t_ws_case_sensitivity TYPE STANDARD TABLE OF yesh_s_ws_case_sensitivity WITH KEY upper_case_attribute_id
4	YESH_T_WS_UNALLOWED_CHARACTERS	Private	See coding			20090507	yesh_t_ws_unallowed_characters TYPE STANDARD TABLE OF yesh_s_ws_unallowed_characters

Method Signatures

Method ADJUST_DECIMAL_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_HELP_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20110210
2	Importing	IV_FORMAT	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20110210

Method ADJUST_DECIMAL_VALUE on class CL_ESH_DPS_DATA has no exception.

Method BUILD_WARNING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ATTRIBUTE_VALUES	Call by reference	☑	Type reference (TYPE)	ESH_WS_SEARCH_ATTRIBUTE_VA_TAB		Attribute Value information for the search data service	20090511
2	Importing	IT_FIELD_INFO	Call by reference	☑	Type reference (TYPE)	ESH_T_IF_FIELD_DETAILS		Field details	20090511
3	Importing	IV_CURRENT_ATTRIBUTE_DATATYPE	Call by reference	☑	Type reference (TYPE)	DYNPTYPE		ABAP/4 Dictionary: Screen data type for Screen Painter	20090511
4	Importing	IV_CURRENT_ATTRIBUTE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20090511
5	Importing	IV_CURRENT_ATTRIBUTE_VALUE	Call by reference	☐	Type reference (TYPE)	ESH_WS_SEARCH_ATTRIBUTE_VALUE1		Attribute Value sub information for Enterprise Search	20090511
6	Importing	IV_IS_ATTRIBUTE_EXISTING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090512
7	Importing	IV_NODE_TYPE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20090511

Method BUILD_WARNING on class CL_ESH_DPS_DATA has no exception.

Method BUILD_WARNING_MESSAGES 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	20090511
2	Importing	IV_COMPLETE_RECORD_COUNTER	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20090511

Method BUILD_WARNING_MESSAGES on class CL_ESH_DPS_DATA has no exception.

Method CHECK_AND_ADJUST_DECIMAL_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_HELP_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20110210
2	Exporting	EV_INVALID_FORMAT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20110210

Method CHECK_AND_ADJUST_DECIMAL_VALUE on class CL_ESH_DPS_DATA has no exception.

Method CHECK_CASE_SENSITIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CASE_SENSITIVE_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100929
2	Exporting	EV_ORIGINAL_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20100929
3	Importing	IT_NODE_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	ESH_WS_SEARCH_ATTRIBUTE_VA_TAB		Attribute Value information for the search data service	20100929
4	Importing	IV_CHECK_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20100929

Method CHECK_CASE_SENSITIVITY on class CL_ESH_DPS_DATA has no exception.

Method CHECK_FOR_MULTIPLE_DELIMITERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_INVALID_FORMAT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20110210
2	Importing	IV_DECIMAL_SIGN	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20110210
3	Importing	IV_DELIMITER	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20110210
4	Importing	IV_HELP_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20110210
5	Importing	IV_NUMBER_DECIMAL_SIGN	Call by reference	☐	Type reference (TYPE)	I			20110210
6	Importing	IV_OFF_DECIMAL_SIGN	Call by reference	☐	Type reference (TYPE)	I			20110210
7	Importing	IV_OFF_DELIMITER	Call by reference	☐	Type reference (TYPE)	I			20110210

Method CHECK_FOR_MULTIPLE_DELIMITERS on class CL_ESH_DPS_DATA has no exception.

Method CHECK_SPECIFIC_FORMATS 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	20090507
2	Exporting	EV_ATTRIBUTE_VALUE	Call by reference	☐	Type reference (TYPE)	ESH_WS_SEARCH_ATTRIBUTE_VALUE1		Attribute Value sub information for Enterprise Search	20090507
3	Importing	IV_ATTRIBUTE_VALUE	Call by reference	☐	Type reference (TYPE)	ESH_WS_SEARCH_ATTRIBUTE_VALUE1		Attribute Value sub information for Enterprise Search	20090507
4	Importing	IV_DATATYPE	Call by reference	☐	Type reference (TYPE)	DYNPTYPE		ABAP/4 Dictionary: Screen data type for Screen Painter	20090508
5	Importing	IV_DOMNAME	Call by reference	☐	Type reference (TYPE)	DOMNAME		Domain name	20090507

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONNECTIVITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_ADM_ANY_CONNECTIVITY		Connectivity details	20081218
2	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Software Component	20090203
3	Importing	IV_OBJECT_TYPE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20081218
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20081218

Method CONSTRUCTOR on class CL_ESH_DPS_DATA has no exception.

Method EXTRACT_UNALLOWED_CHARACTERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_UNALLOWED_CHARACTERS	Call by reference	☐	Type reference (TYPE)	YESH_T_WS_UNALLOWED_CHARACTERS			20090507
2	Importing	IV_ALLOWED_CHARACTERS	Call by reference	☐	Type reference (TYPE)	STRING			20090507
3	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20090507

Method EXTRACT_UNALLOWED_CHARACTERS on class CL_ESH_DPS_DATA has no exception.

Method RESTART_MULTIPLE_DPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_BIN_ERROR_HEAD_DATA	Call by reference	☐	Type reference (TYPE)	ESH_S_ADM_BIN_ERROR_HEAD		Search Connector ID	20090814
2	Importing	IT_BIN_ERROR_DATA	Call by reference	☐	Type reference (TYPE)	ESH_T_ADM_BIN_ERROR_TABLE		table type for error protocol case of binary data deep form	20090814

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADM_BIN_ERROR	☐	Errors due to binary data	20090814

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

Method TEXT_MESSAGE_CONVERT_SHORT on class CL_ESH_DPS_DATA has no exception.

History

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