SAP ABAP Class CL_BTP_DL_HELPCENTER (BTP Help Center)

Hierarchy

☛ DMIS (Software Component) DMIS 2011_1
   ⤷ CA-EUR (Application Component) European Monetary Union: Euro
     ⤷ BTP_DL (Package) BTP Application Data Layer Basis

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BTP_DL_WHEREUSED	BTP Where-Used Framework	20100128

Properties

Class	CL_BTP_DL_HELPCENTER
Short Description	BTP Help Center
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	BTP_DL	BTP Application Data Layer Basis
Created	20091230	SAP
Last change	20141030
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BTP_DL_HELPCENTER has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BTP_DL_WHEREUSED	☐	☐	BTP Where-Used Framework	20100128

Friends

Class CL_BTP_DL_HELPCENTER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	PT_WDCHELP	Static Attribute	Private	☐	See coding				20091230

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DOCU	Static method	Public	Method	Add a docu object to a WD component and view	20100406
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20091230
3	GET_ADDITIONAL_DOCU	Static method	Public	Method	Get additional docu for given docu objects	20100125
4	GET_ALL	Static method	Public	Method	Get all web dynpro help documents	20100406
5	GET_DOCU_BLUEPRINT_OIF	Static method	Public	Method	Get docu object for the blueprint OIF	20110412
6	GET_DOCU_COMPOSER_STEP1	Static method	Public	Method	Get docu object for project composer step 1	20110412
7	GET_DOCU_COMPOSER_STEP2	Static method	Public	Method	Get docu object for project composer step 2	20110412
8	GET_DOCU_COMPOSER_STEP3	Static method	Public	Method	Get docu object for project composer step 3	20110412
9	GET_DOCU_COMPOSER_STEP4	Static method	Public	Method	Get docu object for project composer step 4	20110412
10	GET_DOCU_COMPOSER_STEP5	Static method	Public	Method	Get docu object for project composer step 5	20110412
11	GET_DOCU_COMPOSER_STEP6	Static method	Public	Method	Get docu object for project composer step 6	20110412
12	GET_DOCU_GETTING_STARTED	Static method	Public	Method	Get docu object "Getting started"	20100319
13	GET_DOCU_LANDSCAPE_OIF	Static method	Public	Method	Get docu object for the system landscape OIF	20110412
14	GET_DOCU_OPTIONAL_ITAP	Static method	Public	Method	Get docu object for optional IT approaches	20110412
15	GET_DOCU_PCLACT_OIF	Static method	Public	Method	Get docu object for the PCL activity OIF	20110412
16	GET_DOCU_PCLPACK_OIF	Static method	Public	Method	Get docu object for the PCL package OIF	20110412
17	GET_DOCU_PROJECT_OIF	Static method	Public	Method	Get docu object for the project OIF	20110412
18	GET_DOCU_PROJPHASE_POWL	Static method	Public	Method	Get docu object for the project phases POWL	20110412
19	GET_DOCU_REQUIRED_ITAP	Static method	Public	Method	Get docu object for required IT approaches	20110412
20	GET_LOGON_DATA	Static method	Public	Method	Get logon data for page header	20100507
21	GET_URL_APP_HELP	Static method	Public	Method	Get URL of SAP LT application help	20100326
22	GET_URL_MARKET_PLACE	Static method	Public	Method	Get URL of SAP LT at market place	20100506
23	GET_URL_SOLUTION_MAP	Static method	Public	Method	Get URL of SAP LT solution map	20100506
24	GET_URL_TRAINING	Static method	Public	Method	Get URL of SAP LT training	20101216
25	REFRESH	Static method	Public	Method	Reload the help center data from database	20100805
26	REMOVE_DOCU	Static method	Public	Method	Remove a docu object from a WD component and view	20100406
27	REPLACE_DOCU	Static method	Public	Method	Replace a docu object of a WD component and view	20110310
28	SEARCH_BY_WDVIEW	Static method	Public	Method	Get all documentation objects for a web dynpro view	20091230

Events

Class CL_BTP_DL_HELPCENTER has no event.

Types

Class CL_BTP_DL_HELPCENTER has no local type.

Method Signatures

Method ADD_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DOCU	Call by reference	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20100406
2	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	WDY_COMPONENT_NAME		Web Dynpro: Component Name	20100406
3	Importing	IV_VIEWNAME	Call by reference	☑	Type reference (TYPE)	WDY_WB_VIEW_NAME		Web Dynpro: View Name	20100406

Method ADD_DOCU on class CL_BTP_DL_HELPCENTER has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method GET_ADDITIONAL_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DOCU	Call by reference	☑	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20100125
2	Importing	IT_DOCU	Call by reference	☑	Type reference (TYPE)	BTP_DL_T_REF_DOCU		BTP References to Documentation Objects	20100125
3	Returning	RT_DOCU	Value transfer	☐	Type reference (TYPE)	BTP_DL_T_REF_DOCU		Additional docu of the passed docu objects	20100125

Method GET_ADDITIONAL_DOCU on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO	Call by reference	☐	Type reference (TYPE)	CNV_MBT_SCENARIO	'SLOP'	MBT PCL: Scenario	20121105
2	Returning	RT_WDCHELP	Value transfer	☐	Type reference (TYPE)	BTP_DL_T_WDCHELP		BTP Web Dynpro Components Help	20100406

Method GET_ALL on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_BLUEPRINT_OIF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO	Call by reference	☐	Type reference (TYPE)	CNV_MBT_SCENARIO		MBT PCL: Scenario	20110620
2	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_BLUEPRINT_OIF on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_COMPOSER_STEP1 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_COMPOSER_STEP1 on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_COMPOSER_STEP2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_COMPOSER_STEP2 on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_COMPOSER_STEP3 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_COMPOSER_STEP3 on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_COMPOSER_STEP4 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_COMPOSER_STEP4 on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_COMPOSER_STEP5 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_COMPOSER_STEP5 on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_COMPOSER_STEP6 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_COMPOSER_STEP6 on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_GETTING_STARTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_OBJECT		BTP Object (Tests on Projects)	20100319

Method GET_DOCU_GETTING_STARTED on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_LANDSCAPE_OIF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO	Call by reference	☐	Type reference (TYPE)	CNV_MBT_SCENARIO		MBT PCL: Scenario	20110620
2	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_LANDSCAPE_OIF on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_OPTIONAL_ITAP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_OPTIONAL_ITAP on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_PCLACT_OIF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_PCLACT_OIF on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_PCLPACK_OIF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO	Call by reference	☐	Type reference (TYPE)	CNV_MBT_SCENARIO		MBT PCL: Scenario	20120817
2	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_PCLPACK_OIF on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_PROJECT_OIF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO	Call by reference	☐	Type reference (TYPE)	CNV_MBT_SCENARIO		MBT PCL: Scenario	20110620
2	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_PROJECT_OIF on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_PROJPHASE_POWL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_PROJPHASE_POWL on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_DOCU_REQUIRED_ITAP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCU	Value transfer	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110412

Method GET_DOCU_REQUIRED_ITAP on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_LOGON_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LOGON	Value transfer	☐	Type reference (TYPE)	STRING		Logon Data for Page Header	20100507

Method GET_LOGON_DATA on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_URL_APP_HELP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCENARIO	Call by reference	☑	Type reference (TYPE)	CNV_MBT_SCENARIO		MBT PCL: Scenario	20120906
2	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL of application help	20100326

Method GET_URL_APP_HELP on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_URL_MARKET_PLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL of application help	20100506

Method GET_URL_MARKET_PLACE on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_URL_SOLUTION_MAP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL of application help	20100506

Method GET_URL_SOLUTION_MAP on class CL_BTP_DL_HELPCENTER has no exception.

Method GET_URL_TRAINING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL of SAP LT Training	20101216

Method GET_URL_TRAINING on class CL_BTP_DL_HELPCENTER has no exception.

Method REFRESH Signature

Method REFRESH on class CL_BTP_DL_HELPCENTER has no parameter.
Method REFRESH on class CL_BTP_DL_HELPCENTER has no exception.

Method REMOVE_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DOCU	Call by reference	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20100406
2	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	WDY_COMPONENT_NAME		Web Dynpro: Component Name	20100406
3	Importing	IV_VIEWNAME	Call by reference	☐	Type reference (TYPE)	WDY_WB_VIEW_NAME		Web Dynpro: View Name	20100406

Method REMOVE_DOCU on class CL_BTP_DL_HELPCENTER has no exception.

Method REPLACE_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DOCU_NEW	Call by reference	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110310
2	Importing	IR_DOCU_OLD	Call by reference	☐	Object reference (TYPE REF TO)	CL_BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20110310
3	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	WDY_COMPONENT_NAME		Web Dynpro: Component Name	20110310
4	Importing	IV_VIEWNAME	Call by reference	☑	Type reference (TYPE)	WDY_WB_VIEW_NAME		Web Dynpro: View Name	20110310

Method REPLACE_DOCU on class CL_BTP_DL_HELPCENTER has no exception.

Method SEARCH_BY_WDVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	WDY_COMPONENT_NAME		Web Dynpro: Component Name	20091230
2	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	LANGU		Language Key	20091230
3	Importing	IV_SCENARIO	Call by reference	☐	Type reference (TYPE)	CNV_MBT_SCENARIO	'SLOP'	MBT PCL: Scenario	20121105
4	Importing	IV_VIEWNAME	Call by reference	☑	Type reference (TYPE)	WDY_WB_VIEW_NAME		Web Dynpro: View Name	20091230
5	Returning	RT_DOCU	Value transfer	☐	Type reference (TYPE)	BTP_DL_T_REF_DOCU		BTP References to Portfolio Items	20091230

Method SEARCH_BY_WDVIEW on class CL_BTP_DL_HELPCENTER has no exception.

History

Last changed by/on	SAP	20141030
SAP Release Created in	2006_1_700