SAP ABAP Class CL_BTP_DL_DOCU (BTP Portfolio Item Documentation Object)

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	Inheritance (c INHERITING FROM c_ref)	CL_BTP_DL_PFITEM	BTP Portfolio Item	20091230

Properties

Class	CL_BTP_DL_DOCU
Short Description	BTP Portfolio Item Documentation Object
Super Class	CL_BTP_DL_PFITEM	BTP Portfolio Item
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

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_BTP_DL_DOCU has no interface implemented.

Friends

Class CL_BTP_DL_DOCU has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	NC_DOCUTYPE_61DE	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'61DE'	BTP Docu Type SE61 DE	20111031
2	NC_DOCUTYPE_61RE	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'61RE'	BTP Docu Type SE61 RE	20130425
3	NC_DOCUTYPE_61TX	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'61TX'	BTP Docu Type SE61 TX	20091230
4	NC_DOCUTYPE_61UO	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'61UO'	BTP Docu Type SE61 UO	20130425
5	NC_DOCUTYPE_APPL	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'APPL'	BTP Docu Type SAP Application Help	20100324
6	NC_DOCUTYPE_CHAP	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'CHAP'	BTP Docu Type Chapter in Structure	20100809
7	NC_DOCUTYPE_MIME	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'MIME'	BTP Docu Type MIME Object	20091230
8	NC_DOCUTYPE_SIMG	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'SIMG'	BTP Docu Type IMG Chapter	20100809
9	NC_DOCUTYPE_SNOT	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'SNOT'	BTP Docu Type SAP Note	20091230
10	NC_DOCUTYPE_WURL	Constant	Public	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE	'WURL'	BTP Docu Type Web URL	20091230
11	PC_HP_PATH_LT100	Constant	Private	☐	Type reference (TYPE)	BTP_DL_HELPPORTAL_PATH	'lt100'	Help portal path LT100	20110502
12	PC_HP_PATH_LT200	Constant	Private	☐	Type reference (TYPE)	BTP_DL_HELPPORTAL_PATH	'lt200'	Help portal path LT200	20110502
13	PC_HP_PATH_TD400	Constant	Private	☐	Type reference (TYPE)	BTP_DL_HELPPORTAL_PATH	'td400'	Help portal path TD400	20110615
14	PS_DOCU	Instance attribute	Private	☐	Type reference (TYPE)	BTP_DL_DOCU		BTP Portfolio Item Documentation Object	20091230
15	PT_DOCULV	Instance attribute	Private	☐	See coding				20100108
16	PT_DOCUREL	Instance attribute	Private	☐	See coding				20100105
17	PT_SE61_LINE	Instance attribute	Private	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20110328
18	PV_EXT_APPL_CONTEXT	Instance attribute	Private	☐	Type reference (TYPE)	STRING	''	External application help context	20110307
19	PV_SE61_HEADER	Instance attribute	Private	☐	Type reference (TYPE)	THEAD		SAPscript: Text Header	20110328

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_RELATED_DOCU	Instance method	Public	Method	Add a related docu object to this docu object	20100105
2	CLEANUP	Static method	Public	Method	Cleanup database	20100216
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20091230
4	CONVERT_DOCU_ID_TO_DOCU_TYPE	Static method	Public	Method	Convert the docu id to the btp docu tpe	20130419
5	FIX_61TX_LINES	Static method	Private	Method	Fix the lines of a SE61 document	20110715
6	GET_ALL	Static method	Public	Method	Get all docu's	20100127
7	GET_ALL_HP_PATHS	Static method	Public	Method	Get all available help portal paths	20110502
8	GET_DOCUOBJ	Instance method	Public	Method	Get documentation object	20091230
9	GET_DOCUTYPE	Instance method	Public	Method	Get documentation type	20091230
10	GET_DOCU_61TX	Instance method	Public	Method	Get Header and Lines via DOCU_GET for SE61 docu objects	20100104
11	GET_HP_PATH	Instance method	Public	Method	Get the SAP help portal path	20110502
12	GET_KW_CONTEXT	Static method	Public	Method	Get the internal KW context for a help portal path	20110502
13	GET_LANGU	Instance method	Public	Method	Get language of docu object (initial if lang. indep.)	20091230
14	GET_LANGUAGE_VERSIONS	Instance method	Public	Method	Get all language versions of this docu object	20100303
15	GET_RELATED_DOCU	Instance method	Public	Method	Get all related docu objects	20100105
16	GET_URL	Instance method	Public	Method	Get URL of docu object if supported for docu object type	20100104
17	REMOVE_LANGUAGE_VERSION	Instance method	Public	Method	Remove version of this docu object for a given language	20100108
18	REMOVE_RELATED_DOCU	Instance method	Public	Method	Remove related docu objects from this docu objects	20100105
19	SET_DOCUOBJ	Instance method	Public	Method	Set documentation object	20091230
20	SET_DOCUTYPE	Instance method	Public	Method	Set documentation type	20091230
21	SET_EXT_APPL_CONTEXT	Instance method	Public	Method	Set a new external application help context (only temporary)	20110307
22	SET_HP_PATH	Instance method	Public	Method	Set a new SAP help portal path	20110502
23	SET_LANGU	Instance method	Public	Method	Set language of docu object (initial if lang. indep.)	20091230
24	SET_LANGUAGE_VERSION	Instance method	Public	Method	Add a new language version to this docu object	20100126
25	SET_SE61_LINES	Instance method	Public	Method	Set temporarily a SE61 header and lines	20110328

Events

Class CL_BTP_DL_DOCU has no event.

Types

Class CL_BTP_DL_DOCU has no local type.

Method Signatures

Method ADD_RELATED_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	20100105

Method ADD_RELATED_DOCU on class CL_BTP_DL_DOCU has no exception.

Method CLEANUP Signature

Method CLEANUP on class CL_BTP_DL_DOCU has no parameter.
Method CLEANUP on class CL_BTP_DL_DOCU has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID	Call by reference	☑	Type reference (TYPE)	BTP_DL_GUID		BTP GUID	20110128
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	BTP_DL_OBJ_NAME		BTP Technical Object Name	20100129
3	Importing	IV_SCENARIO	Call by reference	☐	Type reference (TYPE)	CNV_MBT_SCENARIO	NC_SCENARIO_SLOP	MBT PCL: Scenario	20100224

#	Exception	Resumable	Description	Created on
1	CX_BTP_DL_OBJECT	☐	BTP Exceptions on Objects	20100930

Method CONVERT_DOCU_ID_TO_DOCU_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOCU_ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID		Document class	20130419
2	Importing	IV_DOCU_OBJECT	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Documentation Object	20130419
3	Returning	RV_DOCUTYPE	Value transfer	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE		BTP Docu Object Type	20130419

Method CONVERT_DOCU_ID_TO_DOCU_TYPE on class CL_BTP_DL_DOCU has no exception.

Method FIX_61TX_LINES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XT_LINE	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20110715

Method FIX_61TX_LINES on class CL_BTP_DL_DOCU has no exception.

Method GET_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BYPASS_BUFFER	Call by reference	☐	Type reference (TYPE)	BTP_DL_BYPASS_BUFFER	ABAP_FALSE	BTP Bypass Buffer for Read Access	20100729
2	Importing	IV_GET_HIDDEN	Call by reference	☐	Type reference (TYPE)	BTP_DL_OBJ_HIDDEN	ABAP_FALSE	Get also hidden objects	20100416
3	Importing	IV_SCENARIO	Call by reference	☐	Type reference (TYPE)	CNV_MBT_SCENARIO	NC_SCENARIO_SLOP	MBT PCL: Scenario	20100226
4	Returning	RT_DOCU	Value transfer	☐	Type reference (TYPE)	BTP_DL_T_REF_DOCU		Table with References to docu	20100127

Method GET_ALL on class CL_BTP_DL_DOCU has no exception.

Method GET_ALL_HP_PATHS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_HP_PATH	Value transfer	☐	Type reference (TYPE)	BTP_DL_T_HELPPORTAL_PATH		BTP List of SAP Help Portal Paths	20110502

Method GET_ALL_HP_PATHS on class CL_BTP_DL_DOCU has no exception.

Method GET_DOCUOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	LANGU		Language Key	20100108
2	Returning	RV_DOCUOBJ	Value transfer	☐	Type reference (TYPE)	BTP_DL_DOCUOBJ		BTP Documentation Object	20091230

Method GET_DOCUOBJ on class CL_BTP_DL_DOCU has no exception.

Method GET_DOCUTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_DOCUTYPE	Value transfer	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE		BTP Docu Object Type	20091230

Method GET_DOCUTYPE on class CL_BTP_DL_DOCU has no exception.

Method GET_DOCU_61TX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINE	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20100104
2	Exporting	EV_HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		SAPscript: Text Header	20100104
3	Exporting	EV_ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID		Document class	20111122
4	Exporting	EV_OBJECT	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Documentation Object	20111122

Method GET_DOCU_61TX on class CL_BTP_DL_DOCU has no exception.

Method GET_HP_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_HP_PATH	Value transfer	☐	Type reference (TYPE)	BTP_DL_HELPPORTAL_PATH		BTP URL path in SAP help portal	20110502

Method GET_HP_PATH on class CL_BTP_DL_DOCU has no exception.

Method GET_KW_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HP_PATH	Call by reference	☐	Type reference (TYPE)	BTP_DL_HELPPORTAL_PATH		BTP URL path in SAP help portal	20110502
2	Returning	RV_KW_CONTEXT	Value transfer	☐	Type reference (TYPE)	BTP_DL_KW_CONTEXT		BTP KW Context Information	20110502

Method GET_KW_CONTEXT on class CL_BTP_DL_DOCU has no exception.

Method GET_LANGU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LANGU	Value transfer	☐	Type reference (TYPE)	LANGU		Language Key	20091230

Method GET_LANGU on class CL_BTP_DL_DOCU has no exception.

Method GET_LANGUAGE_VERSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_LANGUAGE_VERSION	Value transfer	☐	Type reference (TYPE)	BTP_DL_T_DOCU_LANGUAGE_VERSION		BTP Language Versions of a Docu Object	20100303

Method GET_LANGUAGE_VERSIONS on class CL_BTP_DL_DOCU has no exception.

Method GET_RELATED_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GET_HIDDEN	Call by reference	☐	Type reference (TYPE)	BTP_DL_OBJ_HIDDEN	ABAP_FALSE	Get also hidden objects	20100420
2	Returning	RT_DOCU	Value transfer	☐	Type reference (TYPE)	BTP_DL_T_REF_DOCU		BTP References to Documentation Objects	20100105

Method GET_RELATED_DOCU on class CL_BTP_DL_DOCU has no exception.

Method GET_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	LANGU		Language Key	20100105
2	Importing	IV_PORTFOLIO_CONTENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Get URL to display in the portfolio	20100430
3	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL of the docu object	20100104

Method GET_URL on class CL_BTP_DL_DOCU has no exception.

Method REMOVE_LANGUAGE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	LANGU		Language Key	20100108

#	Exception	Resumable	Description	Created on
1	CX_BTP_DL_DOCU	☐	BTP Exceptions on Docu Objects	20100310

Method REMOVE_RELATED_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		Docu object to remove	20100105
2	Importing	IT_DOCU	Call by reference	☑	Type reference (TYPE)	BTP_DL_T_REF_DOCU		List of docu objects to remove	20100105
3	Importing	IV_DOCUGUID	Call by reference	☑	Type reference (TYPE)	BTP_DL_GUID		GUID of a docu object to remove	20100105

Method REMOVE_RELATED_DOCU on class CL_BTP_DL_DOCU has no exception.

Method SET_DOCUOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOCUOBJ	Call by reference	☐	Type reference (TYPE)	BTP_DL_DOCUOBJ		BTP Docu Object	20100126

Method SET_DOCUOBJ on class CL_BTP_DL_DOCU has no exception.

Method SET_DOCUTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TYPE	Call by reference	☐	Type reference (TYPE)	BTP_DL_DOCUTYPE		BTP Docu Object Type	20091230

Method SET_DOCUTYPE on class CL_BTP_DL_DOCU has no exception.

Method SET_EXT_APPL_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT	Call by reference	☐	Type reference (TYPE)	STRING		Application help context (help.sap.com)	20110307

Method SET_EXT_APPL_CONTEXT on class CL_BTP_DL_DOCU has no exception.

Method SET_HP_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HP_PATH	Call by reference	☐	Type reference (TYPE)	BTP_DL_HELPPORTAL_PATH		BTP URL path in SAP help portal	20110502

#	Exception	Resumable	Description	Created on
1	CX_BTP_DL_DOCU	☐	BTP Exceptions on Docu Objects	20110502

Method SET_LANGU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	LANGU		Language Key	20091230

Method SET_LANGU on class CL_BTP_DL_DOCU has no exception.

Method SET_LANGUAGE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOCUOBJ	Call by reference	☐	Type reference (TYPE)	BTP_DL_DOCUOBJ		BTP Docu Object	20100126
2	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	LANGU		Language Key	20100126

#	Exception	Resumable	Description	Created on
1	CX_BTP_DL_DOCU	☐	BTP Exceptions on Docu Objects	20100310

Method SET_SE61_LINES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LINE	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20110328
2	Importing	IV_HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		SAPscript: Text Header	20110328

Method SET_SE61_LINES on class CL_BTP_DL_DOCU has no exception.

History

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