SAP ABAP Class CL_HCS_BADI_LINKS (Help Center Search: BAdI Implementation - Link)

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	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BADI_ESH_IF_OBJECT_DATA	Object data by list of object ids	20090713
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BADI_INTERFACE	Tag Interface for BAdIs	20090713

Properties

Class	CL_HCS_BADI_LINKS
Short Description	Help Center Search: BAdI Implementation - Link
Super 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	20090708	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_BADI_ESH_IF_OBJECT_DATA	☐	☐	Object data by list of object ids	20090713
2	IF_BADI_INTERFACE	☐	☐	Tag Interface for BAdIs	20090713

Friends

Class CL_HCS_BADI_LINKS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_OBJECT_TYPE_LINK_FILE	Constant	Public	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE	'HC_LINK_FILE'	Object Type HC_LINK_FILE	20091008
2	C_OBJECT_TYPE_LINK_URL	Constant	Public	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE	'HC_LINK_URL'	Object Type HC_LINK_URL	20091008
3	M_LANGUAGES	Static Attribute	Private	☐	Type reference (TYPE)	T_LANGUAGES		Possible Languages	20090727
4	M_LANG_DEPENDENT	Static Attribute	Private	☐	Type reference (TYPE)	WDHC_LANG_DEPENDENT		Language-Dependent Folder Structure	20090713
5	M_PATH	Static Attribute	Private	☐	Type reference (TYPE)	STRING		Physical Path	20090727

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20090713
2	GET_DATA_HC_LINK	Instance method	Private	Method	Get Object Data by List of Object IDs	20090727
3	GET_HC_LINK	Instance method	Private	Method	Get Link	20090727
4	NEXT_HC_LINK	Instance method	Private	Method	Get Next Data Package by Last Object ID	20090713
5	READ_FILE	Instance method	Private	Method	Read File	20090727

Events

Class CL_HCS_BADI_LINKS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_LANGUAGE	Private	See coding			20090727	BEGIN OF t_language, internal TYPE sy-langu, external TYPE t002-laiso, END OF t_language
2	T_LANGUAGES	Private	See coding			20090727	T_LANGUAGES type standard table of t_language
3	T_LINKS_HEAD	Private	See coding			20090828	T_LINKS_HEAD type standard table of saphc_links_head

Method Signatures

Method CLASS_CONSTRUCTOR Signature

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

Method GET_DATA_HC_LINK 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	20090727
2	Importing	IT_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_EXTRACT_NODES		Extraction of nodes	20090727
3	Importing	IT_OBJECT_IDS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_CHANGED_OBJECTS		Changed Objects	20090727
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Objekttyp	20091008

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

Method GET_HC_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LINK_APPLICATION	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Tabelle mit Linkanwendungen	20090828
2	Importing	IT_LINK_COMPONENT	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Tabelle mit Linkkomponentenzuordnungen	20090828
3	Importing	IT_LINK_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Tabelle mit Linkdokumenten	20090828
4	Importing	IT_LINK_TEXT	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Tabelle mit Links	20090727
5	Importing	IT_LINK_TITLE	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Tabelle mit Linktiteln	20090828
6	Importing	I_LINKS_HEADS	Call by reference	☐	Type reference (TYPE)	T_LINKS_HEAD		Linkkopfdaten	20090828

Method GET_HC_LINK on class CL_HCS_BADI_LINKS has no exception.

Method NEXT_HC_LINK 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	20090713
2	Exporting	EV_LAST_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_GENERAL_ID		General ID	20090713
3	Exporting	EV_NO_MORE_DATA	Call by reference	☐	Type reference (TYPE)	XFELD		Checkbox	20090713
4	Importing	IT_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_EXTRACT_NODES		Extraction of nodes	20090713
5	Importing	IV_LAST_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_GENERAL_ID		General ID	20090713
6	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Objekttyp	20091008
7	Importing	IV_PACKAGE_SIZE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_PACKAGE_SIZE		Package size	20090713

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

Method READ_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Dateiinhalt	20090727
2	Exporting	E_EXISTS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Existiert Datei?	20090727
3	Exporting	E_SIZE	Call by reference	☐	Type reference (TYPE)	I		Dateigröße	20090727
4	Importing	I_LANGUAGE	Call by reference	☑	Type reference (TYPE)	T002-LAISO		Sprache	20090727
5	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Dateiname	20090727
6	Importing	I_SUPPORTED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		MIME Type unterstützt?	20090727

Method READ_FILE on class CL_HCS_BADI_LINKS has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in