SAP ABAP Class CL_HCS_ASSIST (Help Center Search: Assistance Class for HCS_COMPONENT)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-HLP-ABA (Application Component) Help Infrastructure for ABAP
     ⤷ SWDP_HELP_CENTER (Package) Help Center ABAP Web Dynpro

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	20090713

Properties

Class	CL_HCS_ASSIST
Short Description	Help Center Search: Assistance Class for HCS_COMPONENT
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	SWDP_HELP_CENTER	Help Center ABAP Web Dynpro
Created	20090706	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

Class CL_HCS_ASSIST has no forward declaration.

Interfaces

Class CL_HCS_ASSIST has no interface implemented.

Friends

Class CL_HCS_ASSIST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_TITLE_APPENDIX	Constant	Private	☐	Type reference (TYPE)	STRING	'...'	Attachment for Truncated Title	20100706
2	C_TITLE_LENGTH	Constant	Private	☐	Type reference (TYPE)	INT4	72	Maximum Title Length (Incl. '...')	20100706
3	RESULTS	Instance attribute	Private	☐	Type reference (TYPE)	TT_LINK		Results List (Link and Area)	20100210
4	STATISTIC	Instance attribute	Private	☐	Type reference (TYPE)	TT_STATISTIC		Hits per Area	20100210

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_AREA_TEXT	Instance method	Private	Method		20100210
2	GET_FILTERED_RESULTS	Instance method	Public	Method	Filtered Results List of Last Search	20100210
3	GET_STATISTIC	Instance method	Public	Method	Number of Results per Section	20100210
4	SEARCH	Instance method	Public	Method	Find	20091008
5	SEARCH_PRO	Instance method	Public	Method	Search (New)	20100210

Events

Class CL_HCS_ASSIST has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_LINK	Private	See coding			20100210	begin of ts_link, text type wdhc_helpful_links-text, url type wdhc_helpful_links-url, tooltip type wdhc_helpful_links-tooltip, area type wdhc_area, "rank_value type esh_e_if_rank_value, end of ts_link
2	TS_STATISTIC	Public	See coding			20100210	begin of ts_statistic, area type wdhc_area, number type i, text type string, end of ts_statistic
3	TT_LINK	Private	See coding		Hits per Area	20100210	tt_link type standard table of ts_link
4	TT_STATISTIC	Public	See coding		Results List (Link and Area)	20100210	tt_statistic type standard table of ts_statistic

Method Signatures

Method GET_AREA_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA	Call by reference	☐	Type reference (TYPE)	WDHC_AREA		Notizen, FAQs, Links oder Lerninhalte	20100210
2	Returning	R_AREA_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20100210

Method GET_AREA_TEXT on class CL_HCS_ASSIST has no exception.

Method GET_FILTERED_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	WDHC_HELPFUL_LINKS_TT		Help Center: "Wissenswertes"/"Hilfreiche Links"	20100210
2	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	WDHC_AREA		Notizen, FAQs, Links oder Lerninhalte	20100210
3	Importing	IV_INDEX_FROM	Call by reference	☐	Type reference (TYPE)	I			20100210
4	Importing	IV_INDEX_TO	Call by reference	☐	Type reference (TYPE)	I			20100210

Method GET_FILTERED_RESULTS on class CL_HCS_ASSIST has no exception.

Method GET_STATISTIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_STATISTIC	Call by reference	☐	Type reference (TYPE)	TT_STATISTIC		Ergebnisliste (Link und Bereich)	20100210

Method GET_STATISTIC on class CL_HCS_ASSIST has no exception.

Method SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINK	Call by reference	☐	Type reference (TYPE)	WDHC_HELPFUL_LINKS_TT		Help Center: Struktur für "Wissenswertes"/"Hilfreiche Links"	20091008
2	Exporting	EV_TOTAL	Call by reference	☐	Type reference (TYPE)	I		Anzahl aller Ergebnisse	20091008
3	Importing	IR_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_HCS_REQUEST		Help Center Suche: Suchanfrage	20091008
4	Importing	IV_INDEX_FROM	Call by reference	☐	Type reference (TYPE)	I			20091008
5	Importing	IV_INDEX_TO	Call by reference	☐	Type reference (TYPE)	I			20091008

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

Method SEARCH_PRO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_HCS_REQUEST		Help Center Suche: Suchanfrage	20100210

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

History

Last changed by/on	SAP	20110908
SAP Release Created in