SAP ABAP Class CL_HCS_BADI_LIBRARY (Help Center Search: BAdI Implementation - SAP Library)

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	20090903
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BADI_INTERFACE	Tag Interface for BAdIs	20090903

Properties

Class	CL_HCS_BADI_LIBRARY
Short Description	Help Center Search: BAdI Implementation - SAP Library
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	20090730	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_HCS_BADI_LIBRARY has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BADI_ESH_IF_OBJECT_DATA	☐	☐	Object data by list of object ids	20090903
2	IF_BADI_INTERFACE	☐	☐	Tag Interface for BAdIs	20090903

Friends

Class CL_HCS_BADI_LIBRARY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_OBJECT_TYPE_LIBRARY	Constant	Public	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE	'HC_LIBRARY'	Object Type HC_LIBRARY	20090903
2	M_KW_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_HCSKW_DATA		Data Interface for Static KW Library	20090903

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_HC_LIBRARY	Instance method	Private	Method	Get Library	20090903
2	NEXT_HC_LIBRARY	Instance method	Private	Method	Get Next Data Package by Last Object ID	20090903

Events

Class CL_HCS_BADI_LIBRARY has no event.

Types

Class CL_HCS_BADI_LIBRARY has no local type.

Method Signatures

Method GET_HC_LIBRARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LIBRARY_APPLICATION	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Tabelle mit SAP-Bibliotheksanwendungen	20090903
2	Importing	IT_LIBRARY_COMPONENT	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Tabelle mit SAP-Bibliothekskomponenten	20090903
3	Importing	IT_LIBRARY_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Tabelle mit SAP-Bibliotheksdokumenten	20090903
4	Importing	IT_LIBRARY_TEXT	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Tabelle mit SAP-Bibliothekseinträgen	20090903
5	Importing	I_DOCS	Call by reference	☐	Type reference (TYPE)	THCSKW_LDOC		SAP-Bibliotheksdokumente	20090903

Method GET_HC_LIBRARY on class CL_HCS_BADI_LIBRARY has no exception.

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

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

History

Last changed by/on	SAP	20110908
SAP Release Created in