SAP ABAP Class CL_ESH_RESULT_UI_ASSIST (Assistance Class for ESH_RESULT_UI)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class	20080721

Properties

Class	CL_ESH_RESULT_UI_ASSIST
Short Description	Assistance Class for ESH_RESULT_UI
Super Class	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_UI_SEARCH_UI	Search UI
Created	20080721	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_ESH_IF_SEARCH_RESPONSES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_WD_MESSAGE_MANAGER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_ESH_RESULT_UI_ASSIST has no interface implemented.

Friends

Class CL_ESH_RESULT_UI_ASSIST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_DOKU_ID_DT	Static Attribute	Public	☐	Type reference (TYPE)	DOKU_ID	'DT'	Document class 'Dialog Text'	20090224
2	CO_DOKU_OBJ_STATUS_INFO	Static Attribute	Public	☐	Type reference (TYPE)	DOKU_OBJ	'ESH_SEARCH_UI_STATUS_INFO'	Documentation object	20090224
3	CO_TYPE_VALUE	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_DISTRIBUTION_TYPE	CL_ESH_IF_SEARCH_RESPONSES=>CV_DIST_TYPE_VALUE	Distribution type value	20100325
4	GC_HALIGN	Constant	Public	☐	Type reference (TYPE)	STRING	'HALIGN_0'	Name of visible element	20091012
5	GC_LABEL	Constant	Public	☐	Type reference (TYPE)	STRING	'LABEL_0'	Name of label element	20080825
6	GC_LABEL_LONGTEXT	Constant	Public	☐	Type reference (TYPE)	STRING	'LABEL_LONGTEXT_0'	Name of label element	20110831
7	GC_MAX_ATTR	Constant	Public	☐	Type reference (TYPE)	I	9	Max. count of result attributes	20080826
8	GC_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'NAME_0'	Name of value element	20090904
9	GC_TT_LONGTEXT	Constant	Public	☐	Type reference (TYPE)	STRING	'TOOLTIP_LONGTEXT_0'	Name of tooltip value element	20110831
10	GC_TT_VALUE	Constant	Public	☐	Type reference (TYPE)	STRING	'TOOLTIP_VALUE_0'	Name of tooltip value element	20090402
11	GC_VALUE	Constant	Public	☐	Type reference (TYPE)	STRING	'VALUE_0'	Name of value element	20080825
12	GC_VALUE_LONGTEXT	Constant	Public	☐	Type reference (TYPE)	STRING	'VALUE_LONGTEXT_0'	Name of value element	20110831
13	GC_VISIBLE	Constant	Public	☐	Type reference (TYPE)	STRING	'VISIBLE_0'	Name of visible element	20080826
14	GC_VISIBLE_LONGTEXT	Constant	Public	☐	Type reference (TYPE)	STRING	'VISIBLE_LONGTEXT_0'	Name of visible element	20110831
15	GR_CA_HELPER	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_ESH_SEARCH_UI_CA_HELPER		Common attributes (helper class)	20100118
16	GR_SEARCH_REQUEST	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST		Search request	20081006
17	GR_UI_COMMON	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_ESH_SEARCH_UI_COMMON		Common Search UI methods	20100708
18	GR_VIEW_CONTROLLER	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_WD_VIEW_CONTROLLER		Web Dynpro: View controller	20081006
19	GT_BREAD_CRUMB	Instance attribute	Public	☐	Type reference (TYPE)	ESH_T_BREAD_CRUMB		BreadCrumb data	20081125
20	GT_RESULT_ITEM_UI	Instance attribute	Public	☐	Type reference (TYPE)	ESH_T_RESULT_ITEM_UI		Result item in UI format	20080725
21	GT_SCOPE_DISTRIBUTION	Instance attribute	Public	☐	Type reference (TYPE)	ESH_T_IF_SCOPE_DISTRIBUTION		Scope hierarchy with hit distribution	20081104
22	GT_SCOPE_DISTRIBUTION_UI	Instance attribute	Public	☐	Type reference (TYPE)	ESH_T_SCOPE_DISTRIBUTION_UI		Scope distribution in UI format	20090407
23	GT_STATISTICS	Instance attribute	Public	☐	Type reference (TYPE)	ESH_T_IF_CONNECTOR_STATISTICS		Search statistics for connectors	20081205
24	GV_ACTION_ITEM_LINKS_MAX	Instance attribute	Public	☐	Type reference (TYPE)	INT4		Counter with maximum number of result item links	20091007
25	GV_CENTRAL_DEPLOYMENT	Static Attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL		'X' = Central deployment	20090227
26	GV_CREATE_LINKS	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL		Create result item links flag	20090121
27	GV_MSG_TXT	Instance attribute	Public	☐	Type reference (TYPE)	STRING		Message text (only for message ... into GV_MSG_TXT)	20090320
28	GV_SEARCH_EXEC_ID	Instance attribute	Public	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_EXEC_ID		Search execution ID	20100201
29	GV_SEARCH_STARTED	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL		Search was started	20081106
30	GV_SEARCH_STATUS	Instance attribute	Public	☐	Type reference (TYPE)	I		Search status: 1 - ok, 2 - timed out, 3 - unsuccessful	20090224
31	GV_SEARCH_TIMEOUT	Instance attribute	Public	☐	Type reference (TYPE)	ESH_E_IF_TIMEOUT		Used search timeout (sec)	20090320
32	GV_SHOW_BREAD_CRUMB	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL		Show BreadCrumb mode is active	20090331
33	GV_TOTAL_RESULTS	Instance attribute	Public	☐	Type reference (TYPE)	INT4		Natural number	20081016

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_GROUP_ATTRIBUTE_VALUES	Instance method	Public	Method	Add group attribute values	20100304
2	ATTRIBUTE_TYPE_IS_NUMBER	Instance method	Public	Method	Attribute type is number	20100312
3	BUILD_RESULT_SUBREQUEST	Instance method	Public	Method	Build result subrequest	20091005
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20090227
5	CONVERT_HTML_2_XHTML	Instance method	Public	Method	Convert HTML to XHTML	20090206
6	CREATE_INSTANCE_CA_HELPER	Instance method	Public	Method	Create instance of CL_ESH_SEARCH_UI_CA_HELPER	20100118
7	CREATE_INSTANCE_UI_COMMON	Instance method	Public	Method	Create instance of CL_ESH_SEARCH_UI_COMMON	20100708
8	CUT_HTML_STRING	Static method	Public	Method	Cut HTML String for result value in display format	20101130
9	GET_DEFAULT_NAV_URL	Instance method	Public	Method	Get default navigation URL	20101116
10	GET_DOCU_OBJECT_TEXT	Instance method	Public	Method	Get document object text	20090224
11	GET_HIT_ATTRIBUTES	Static method	Public	Method	Get Hit Attribute Names	20110902
12	GET_LONG_TEXT	Static method	Public	Method	Get Longtext string for result value in display format	20110831
13	GET_RELATED_ACTIONS	Instance method	Public	Method	Get related actions (navigation targets, related requests)	20091002
14	GET_RESPONSE_ATTRIBUTES	Instance method	Public	Method	Get response attributes for subrequest search	20091009
15	GET_RESPONSE_ATTR_VALUES	Instance method	Public	Method	Get response attribute values	20100303
16	GET_RESPONSE_ATTR_VALUES_SUBRE	Instance method	Public	Method	Get response attribute values for subrequest	20100312
17	GET_SCOPE	Instance method	Public	Method	Get scope from search request	20081204
18	GET_SORT_ATTR_FOR_CATEGORY	Instance method	Public	Method	Get sort attributes for category	20100120
19	GET_SORT_ATTR_FOR_CONNECTOR	Instance method	Public	Method	Get sort attributes for connector	20100120
20	GET_UI_RESULT_ITEM	Instance method	Public	Method	Get result item in UI format	20091002
21	GET_UI_RESULT_VALUE	Instance method	Public	Method	Get result value in UI format	20091001
22	GET_UI_SEARCH_RESULTS	Instance method	Public	Method	Get search results in UI format	20091001
23	GET_UI_STATUS_INFORMATION	Instance method	Public	Method	Get status information for search	20091001
24	GET_UI_SUBREQUEST_RESULTS	Instance method	Public	Method	Get subrequest results in UI format	20091009
25	GET_UI_SUBREQUEST_RESULT_ITEM	Instance method	Public	Method	Get subrequest result item in UI format	20091009
26	REMOVE_CONTROL_CHARACTERS	Static method	Public	Method	Remove control characters (prevent HTML breaking)	20090108
27	REPORT_MESSAGE	Instance method	Public	Method	Report message	20090320
28	VALIDATE_FORMATTED_TEXT	Instance method	Private	Method	Validate formatted text	20090206

Events

Class CL_ESH_RESULT_UI_ASSIST has no event.

Types

Class CL_ESH_RESULT_UI_ASSIST has no local type.

Method Signatures

Method ADD_GROUP_ATTRIBUTE_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_HIT_ATTR_NAMES	Call by reference	☑	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20100826
2	Exporting	EV_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME		Attribute Name	20100304
3	Exporting	EV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_NAME		Readable Name	20100304
4	Exporting	EV_INT_TYPE	Call by reference	☐	Type reference (TYPE)	INTTYPE		ABAP data type (C,D,N,...)	20100304
5	Exporting	EV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Value	20100304
6	Exporting	EV_VALUE_TT	Call by reference	☐	Type reference (TYPE)	STRING		Value for Tooltip	20100825
7	Importing	IR_ATTR_GROUP	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTR_GROUP		Meta Data: Attribute Group	20100304
8	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20100304
9	Importing	IV_ESCAPE_HTML	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE	Escape HTML flag (Is set for formatted UI elements only	20101201
10	Importing	IV_UI_AREA_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_UI_AREA		UI Area	20100820

Method ADD_GROUP_ATTRIBUTE_VALUES on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method ATTRIBUTE_TYPE_IS_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INT_TYPE	Call by reference	☐	Type reference (TYPE)	INTTYPE		ABAP data type (C,D,N,...)	20100312
2	Returning	RV_IS_NUMBER	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20100312

Method ATTRIBUTE_TYPE_IS_NUMBER on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method BUILD_RESULT_SUBREQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SUBREQUEST_LIST	Call by reference	☐	Type reference (TYPE)	ESH_S_RESULT_SUBREQUEST_LIST		Results: Subrequest List	20091005
2	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20091005
3	Importing	IS_RELATED_REQ	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_REL_REQUEST_LIST		Related Search Connector Request List	20091005

Method BUILD_RESULT_SUBREQUEST on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_ESH_RESULT_UI_ASSIST has no parameter.
Method CLASS_CONSTRUCTOR on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method CONVERT_HTML_2_XHTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HTML	Call by reference	☐	Type reference (TYPE)	STRING		HTML String	20090206
2	Returning	RV_XHTML	Value transfer	☐	Type reference (TYPE)	STRING		XHTML String	20090206

Method CONVERT_HTML_2_XHTML on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method CREATE_INSTANCE_CA_HELPER Signature

Method CREATE_INSTANCE_CA_HELPER on class CL_ESH_RESULT_UI_ASSIST has no parameter.
Method CREATE_INSTANCE_CA_HELPER on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method CREATE_INSTANCE_UI_COMMON Signature

Method CREATE_INSTANCE_UI_COMMON on class CL_ESH_RESULT_UI_ASSIST has no parameter.
Method CREATE_INSTANCE_UI_COMMON on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method CUT_HTML_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20101130
2	Importing	IS_RESULT_ITEM_UI	Call by reference	☑	Type reference (TYPE)	ESH_S_RESULT_ITEM_UI		Result Item in UI Format	20101130
3	Importing	IV_ATTR_NUM	Call by reference	☑	Type reference (TYPE)	I			20101130
4	Importing	IV_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_NAME		Readable Name	20101130
5	Importing	IV_IS_TITLE	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE	Method is used for title (not for summary attribute)	20101130
6	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20101130

Method CUT_HTML_STRING on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_DEFAULT_NAV_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20101116
2	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_URL		Default navigation URL	20101116

Method GET_DEFAULT_NAV_URL on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_DOCU_OBJECT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOKU_ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID		Document class	20090224
2	Importing	IV_DOKU_OBJ	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Documentation Object	20090224
3	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20090224
4	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20090224

Method GET_DOCU_OBJECT_TEXT on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_HIT_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HIT_ATTR	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20110902
2	Exporting	ET_HIT_ATTR_ALL	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20110902
3	Importing	IR_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR		Metadata: Search Connector	20110902
4	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20110902

Method GET_HIT_ATTRIBUTES on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_LONG_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20110831
2	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20110831
3	Importing	IV_VALUE_TT	Call by reference	☐	Type reference (TYPE)	STRING			20110831

Method GET_LONG_TEXT on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_RELATED_ACTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_RESULT_ITEM_UI	Call by reference	☐	Type reference (TYPE)	ESH_S_RESULT_ITEM_UI		Result Item in UI Format	20091002
2	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20091002

Method GET_RELATED_ACTIONS on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_RESPONSE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTR_TYPES_SUMMARY	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_ATTRIBUTE_TYOBJ		Meta Data: Attribute Type Objects	20091009
2	Exporting	ET_ATTR_TYPES_TITLE	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_ATTRIBUTE_TYOBJ		Meta Data: Attribute Type Objects	20091009
3	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Web Dynpro: Interface for Node Element	20091009

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091009

Method GET_RESPONSE_ATTR_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_RESULT_ITEM_UI	Call by reference	☐	Type reference (TYPE)	ESH_S_RESULT_ITEM_UI			20100304
2	Exporting	ET_RESULT_ITEM_DETAIL	Call by reference	☐	Type reference (TYPE)	ESH_T_RESULT_ITEM_DETAIL			20100304
3	Exporting	EV_TITLE	Call by reference	☐	Type reference (TYPE)	STRING			20100304
4	Importing	IR_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR		Meta Data: Search Connector	20100303
5	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20100304
6	Importing	IV_UI_AREAS_EXIST	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20100305

Method GET_RESPONSE_ATTR_VALUES on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_RESPONSE_ATTR_VALUES_SUBRE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SUBREQUEST_HEADER	Call by reference	☐	Type reference (TYPE)	ESH_S_RESULT_SUBREQUEST_HEADER		Result Item for subrequest	20100312
2	Exporting	ES_SUBREQUEST_VALUE_ITEM	Call by reference	☐	Type reference (TYPE)	ESH_S_RESULT_SUBREQUEST_TABLE		Result Item for subrequest	20100312
3	Importing	IR_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_CONNECTOR		Meta Data: Search Connector	20100312
4	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20100312
5	Importing	IV_UI_AREAS_EXIST	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20100312

Method GET_RESPONSE_ATTR_VALUES_SUBRE on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_SCOPE		Scope of Search Request	20081204
2	Importing	IR_SEARCH_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST		Search Request	20081204

Method GET_SCOPE on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_SORT_ATTR_FOR_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SORT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	ESH_T_SORT_ATTRIBUTES		Sort attributes for Search	20100120
2	Importing	IV_CATEGORY_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID		Category ID	20100120

Method GET_SORT_ATTR_FOR_CATEGORY on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_SORT_ATTR_FOR_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SORT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	ESH_T_SORT_ATTRIBUTES		Sort attributes for Search	20100120
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20100120

Method GET_SORT_ATTR_FOR_CONNECTOR on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_UI_RESULT_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_RESULT_ITEM_UI	Call by reference	☐	Type reference (TYPE)	ESH_S_RESULT_ITEM_UI		Result Item in UI Format	20091002
2	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20091002

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091002

Method GET_UI_RESULT_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_HIT_ATTR_NAMES	Call by reference	☑	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20100825
2	Exporting	ES_ATTR_TITLE_SNIPPET	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME		Attribute Name for Title Snippet	20110919
3	Exporting	EV_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME		Attribute Name	20091001
4	Exporting	EV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_NAME		Readable Name	20091001
5	Exporting	EV_INT_TYPE	Call by reference	☐	Type reference (TYPE)	INTTYPE		ABAP data type (C,D,N,...)	20091012
6	Exporting	EV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Result Value	20091001
7	Exporting	EV_VALUE_TT	Call by reference	☐	Type reference (TYPE)	STRING		Value for Tooltip	20100824
8	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20091001
9	Importing	IS_ATTRIBUTE_ENTITIES	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_MDATA_ATTR_ENTITY_OBJ		Meta Data: Attribute Type Object	20100312
10	Importing	IV_ESCAPE_HTML	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE	Escape HTML flag (Is set for formatted UI elements only	20101201
11	Importing	IV_UI_AREA_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_UI_AREA		UI Area	20100820

Method GET_UI_RESULT_VALUE on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_UI_SEARCH_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT_ITEM_UI	Call by reference	☐	Type reference (TYPE)	ESH_T_RESULT_ITEM_UI		Result Item in UI Format	20091001
2	Importing	IR_RESPONSES	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20091001
3	Importing	IR_SEARCH_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST		Search Request	20091001

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091001

Method GET_UI_STATUS_INFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESPONSES	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20091001

Method GET_UI_STATUS_INFORMATION on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method GET_UI_SUBREQUEST_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SUBREQUEST_HEADER	Call by reference	☐	Type reference (TYPE)	ESH_S_RESULT_SUBREQUEST_HEADER		Result Item for subrequest	20091009
2	Exporting	ET_SUBREQUEST_VALUE_ITEM	Call by reference	☐	Type reference (TYPE)	ESH_T_RESULT_SUBREQUEST_TABLE		SUBREQUEST_TABLE	20091009
3	Exporting	EV_TOTAL_HITS	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20091009
4	Importing	IR_RESPONSES	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20091009
5	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Web Dynpro: Interface for Node Element	20091009

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091009

Method GET_UI_SUBREQUEST_RESULT_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SUBREQUEST_HEADER	Call by reference	☐	Type reference (TYPE)	ESH_S_RESULT_SUBREQUEST_HEADER		Result Item for subrequest	20091009
2	Exporting	ES_SUBREQUEST_VALUE_ITEM	Call by reference	☐	Type reference (TYPE)	ESH_S_RESULT_SUBREQUEST_TABLE		Result Item for subrequest	20091009
3	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20091009

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20100312

Method REMOVE_CONTROL_CHARACTERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20090108

Method REMOVE_CONTROL_CHARACTERS on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method REPORT_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_MSG_MAN	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER		Message Manager	20090320
2	Importing	IV_MESSAGE_TYPE	Call by reference	☐	Type reference (TYPE)	I	IF_WD_MESSAGE_MANAGER=>CO_TYPE_ERROR	Message Type	20090320
3	Importing	IV_VIEW	Call by reference	☑	Type reference (TYPE)	STRING		View Name	20090320

Method REPORT_MESSAGE on class CL_ESH_RESULT_UI_ASSIST has no exception.

Method VALIDATE_FORMATTED_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ONLY_CHECK	Call by reference	☐	Type reference (TYPE)	XFELD	'X'	Check Text Only	20090206
2	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		XHTML String	20090206
3	Returning	RV_IS_INVALID	Value transfer	☐	Type reference (TYPE)	XFELD		Text is invalid	20090206

Method VALIDATE_FORMATTED_TEXT on class CL_ESH_RESULT_UI_ASSIST has no exception.

History

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