SAP ABAP Class CL_HC_UTIL_DOCS ('Worth Knowing')

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

Properties

Class	CL_HC_UTIL_DOCS
Short Description	'Worth Knowing'
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	20080310	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

Class CL_HC_UTIL_DOCS has no interface implemented.

Friends

Class CL_HC_UTIL_DOCS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	FIRST_PART_FILE_URL	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20080312
2	IS_BUFFERED	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20081203
3	IS_LANG_DEPENDENT	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20081203
4	SEC_LANGU	Static Attribute	Private	☐	Type reference (TYPE)	SYLANGU		Secondary Language ZCSA	20080319

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DOCUMENT_AVAILABILITY	Static method	Public	Method	Delete Linked Documents from the Table	20081114
2	CREATE_DOC	Static method	Public	Method		20080312
3	DELETE_DOC	Static method	Public	Method		20080312
4	DOCUMENTS_TYPE_FILE_AVAILABLE	Static method	Public	Method		20081211
5	GET_DOCS	Static method	Public	Method		20080311
6	GET_DOCS_ADMIN	Static method	Public	Method		20081031
7	GET_DOCUMENT_TYPE_TEXT	Static method	Public	Method		20081205
8	GET_DOC_FOR_GUID	Static method	Public	Method		20081111
9	GET_FIRST_PART_FILE_URL	Static method	Public	Method		20080312
10	GET_LINKS_GUIDS_FOR_APPL	Static method	Private	Method		20081111
11	GET_TEXT	Static method	Private	Method		20080319
12	GET_URL	Static method	Public	Method		20081205
13	GET_URL_DOCUMENT_TYPE_FILE	Static method	Public	Method	URL File	20080312
14	GET_URL_DOCUMENT_TYPE_KW	Static method	Private	Method	URL from KW Help Link	20080312
15	MODIFY_HEAD	Static method	Private	Method		20081202
16	MODIFY_TEXT	Static method	Private	Method		20081111
17	UPDATE_APPL_ASSIGNMENT	Static method	Private	Method		20081111
18	UPDATE_APPL_ASSIGNMENTS	Static method	Private	Method		20081119
19	UPDATE_DOC	Static method	Public	Method		20080312
20	UPDATE_DOC_ADMIN	Static method	Public	Method		20090727

Events

Class CL_HC_UTIL_DOCS has no event.

Types

Class CL_HC_UTIL_DOCS has no local type.

Method Signatures

Method CHECK_DOCUMENT_AVAILABILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	IT_DOCUMENTS	Call by reference	☐	Type reference (TYPE)	SAPGUIHC_DOC_TT		Tabelle der Dokumente	20081114
2	Importing	I_APPL	Call by reference	☐	Type reference (TYPE)	SAPHC_APPL		Anwendung	20090713

Method CHECK_DOCUMENT_AVAILABILITY on class CL_HC_UTIL_DOCS has no exception.

Method CREATE_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_GUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20080312
2	Importing	I_APPL	Call by reference	☐	Type reference (TYPE)	SAPHC_APPL		Help Center Anwendungszuordnung	20081208
3	Importing	I_CATEGORY	Call by reference	☑	Type reference (TYPE)	WDHC_CATEGORY		Help Center: Kategorie	20081204
4	Importing	I_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Dokument Schlüssel	20080812
5	Importing	I_DOCUMENT_TYPE	Call by reference	☐	Type reference (TYPE)	WDHC_DOCUMENT_TYPE		Dokument Typ	20080312
6	Importing	I_FLAG_TEXT_FROM_SOLMAN	Call by reference	☑	Type reference (TYPE)	FLAG_TEXT_FROM_SOLMAN		Text wurde von Solution Manager übernommen	20081112
7	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Sprachenschlüssel der aktuellen Textumgebung	20080312
8	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	SAPHC_LINKS_TEXT-TEXT		Textfeld der Länge 60	20080312
9	Importing	I_VALIDITY	Call by reference	☐	Type reference (TYPE)	R_VALIDITY		Für Radiobuttons in Help Center	20080312

Method CREATE_DOC on class CL_HC_UTIL_DOCS has no exception.

Method DELETE_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		Objekttyp	20080312

Method DELETE_DOC on class CL_HC_UTIL_DOCS has no exception.

Method DOCUMENTS_TYPE_FILE_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_AVAILABLE	Value transfer	☐	Type reference (TYPE)	WDHC_ACTIVE			20081211

Method DOCUMENTS_TYPE_FILE_AVAILABLE on class CL_HC_UTIL_DOCS has no exception.

Method GET_DOCS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPL	Call by reference	☑	Type reference (TYPE)	SAPHC_APPL		Help Center Anwendungszuordnung	20081205
2	Importing	I_CATEGORY	Call by reference	☑	Type reference (TYPE)	WDHC_CATEGORY		Help Center: Kategorie	20081204
3	Importing	I_FLAG_FILESHARE	Call by reference	☑	Type reference (TYPE)	BTFR_FLAG		Dokumente aus benutzereigener Ablage	20081203
4	Importing	I_FLAG_SOLMAN_DOCS	Call by reference	☑	Type reference (TYPE)	BTFR_FLAG		Dokumente aus Solution Manager	20081125
5	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Sprachenschlüssel der aktuellen Textumgebung	20080311
6	Returning	R_DOCS	Value transfer	☐	Type reference (TYPE)	SAPGUIHC_DOC_TT		Help Center: "Wissenswertes"	20080311

Method GET_DOCS on class CL_HC_UTIL_DOCS has no exception.

Method GET_DOCS_ADMIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LINKS_ADMIN	Call by reference	☐	Type reference (TYPE)	SAPGUIHC_LINKS_ADMIN_TT		Administration Links im Help Center	20081031
2	Exporting	E_LINKS_APP	Call by reference	☐	Type reference (TYPE)	SAPHC_LINKS_APP_TT		Help Center Links	20090713
3	Exporting	E_LINKS_TEXT	Call by reference	☐	Type reference (TYPE)	SAPHC_LINKS_TEXT_TT		Help Center: Texte zu Dokumenten	20081031
4	Importing	I_APPL	Call by reference	☐	Type reference (TYPE)	SAPHC_APPL		Help Center Anwendungszuordnung	20081031
5	Importing	I_CATEGORY	Call by reference	☑	Type reference (TYPE)	WDHC_CATEGORY		Help Center: Kategorie	20081204
6	Importing	I_CHAN_DATE_RANGE	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Reference to range of DATS	20090528
7	Importing	I_CHAN_NAME	Call by reference	☑	Type reference (TYPE)	SYUNAME		Benutzername	20090528
8	Importing	I_CREA_DATE_RANGE	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Reference to range of DATS	20090528
9	Importing	I_CREA_NAME	Call by reference	☑	Type reference (TYPE)	SYUNAME		Benutzername	20090528
10	Importing	I_DOCUMENT_TYPE	Call by reference	☑	Type reference (TYPE)	WDHC_DOCUMENT_TYPE		Dokument Typ	20081103
11	Importing	I_FLAG_NO_CURR_TRANSL	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Keine aktuellen Übersetzungen	20090325
12	Importing	I_FLAG_SOLMAN_DOCS	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		'X' = mit Solution Manager Dokumenten	20081210
13	Importing	I_INCL_VALIDITY_ALL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		'X' = mit anwendungsunabhängigen Links	20081127
14	Importing	I_INCL_VALIDITY_APPL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		'X' = mit anwendungsabhängigen Links	20090109
15	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20081031
16	Importing	I_LANGU_2	Call by reference	☑	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20081103

Method GET_DOCS_ADMIN on class CL_HC_UTIL_DOCS has no exception.

Method GET_DOCUMENT_TYPE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCUMENT_TYPE	Call by reference	☐	Type reference (TYPE)	WDHC_DOCUMENT_TYPE		Dokument Typ	20081205
2	Returning	R_DOCUMENT_TYPE_TEXT	Value transfer	☐	Type reference (TYPE)	SAPGUIHC_LINKS_ADMIN-DOCUMENT_TYPE_TEXT		Text in der Länge 40	20081205

Method GET_DOCUMENT_TYPE_TEXT on class CL_HC_UTIL_DOCS has no exception.

Method GET_DOC_FOR_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DOC	Value transfer	☐	Type reference (TYPE)	SAPGUIHC_DOC		Help Center: Struktur für "Wissenswertes"	20081111
2	Importing	I_CATEGORY	Call by reference	☑	Type reference (TYPE)	WDHC_CATEGORY		Help Center: Kategorie	20081204
3	Importing	I_FLAG_FILESHARE	Call by reference	☑	Type reference (TYPE)	BTFR_FLAG		Dokumente aus benutzereigener Ablage	20081203
4	Importing	I_FLAG_SOLMAN_DOCS	Call by reference	☑	Type reference (TYPE)	BTFR_FLAG		Dokumente aus Solution Manager	20081125
5	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20081111
6	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Sprachenschlüssel der aktuellen Textumgebung	20081111
7	Importing	I_VALIDITY	Call by reference	☐	Type reference (TYPE)	R_VALIDITY		Help Center Gültigkeitsbereich	20081111

Method GET_DOC_FOR_GUID on class CL_HC_UTIL_DOCS has no exception.

Method GET_FIRST_PART_FILE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20080313
2	Returning	R_FIRST_PART_FILE_URL	Value transfer	☐	Type reference (TYPE)	STRING			20080312

Method GET_FIRST_PART_FILE_URL on class CL_HC_UTIL_DOCS has no exception.

Method GET_LINKS_GUIDS_FOR_APPL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_GUIDS	Call by reference	☐	Type reference (TYPE)	SAPHC_KEY_HEAD_TT		Schlüssel von Help Center Objekten	20081111
2	Importing	I_APPL	Call by reference	☐	Type reference (TYPE)	SAPHC_APPL		Anwendung	20090713

Method GET_LINKS_GUIDS_FOR_APPL on class CL_HC_UTIL_DOCS has no exception.

Method GET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20080813
2	Exporting	E_TEXT	Call by reference	☐	Type reference (TYPE)	SAPHC_LINKS_TEXT-TEXT		Textfeld der Länge 60	20080319
3	Importing	I_CREA_LAN	Call by reference	☑	Type reference (TYPE)	SY-LANGU		Sprachenschlüssel der aktuellen Textumgebung	20080319
4	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20080319
5	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Sprachenschlüssel der aktuellen Textumgebung	20080319

Method GET_TEXT on class CL_HC_UTIL_DOCS has no exception.

Method GET_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20081205
2	Importing	I_DOCUMENT_TYPE	Call by reference	☐	Type reference (TYPE)	WDHC_DOCUMENT_TYPE		Dokument Typ	20081205
3	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20081205
4	Returning	R_DOCUMENT_URL	Value transfer	☐	Type reference (TYPE)	STRING			20081205

Method GET_URL on class CL_HC_UTIL_DOCS has no exception.

Method GET_URL_DOCUMENT_TYPE_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20080312
2	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Sprachenschlüssel der aktuellen Textumgebung	20080312
3	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20080812

Method GET_URL_DOCUMENT_TYPE_FILE on class CL_HC_UTIL_DOCS has no exception.

Method GET_URL_DOCUMENT_TYPE_KW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_URL	Call by reference	☐	Type reference (TYPE)	STRING			20080312
2	Importing	I_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20080312

Method GET_URL_DOCUMENT_TYPE_KW on class CL_HC_UTIL_DOCS has no exception.

Method MODIFY_HEAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CREATED	Call by reference	☐	Type reference (TYPE)	WDHC_BOOLEAN		true = created, false = updated	20090727
2	Exporting	E_DOCUMENT_TYPE	Call by reference	☐	Type reference (TYPE)	WDHC_DOCUMENT_TYPE		Dokument Typ	20090727
3	Importing	I_CATEGORY	Call by reference	☑	Type reference (TYPE)	WDHC_CATEGORY		Help Center: Kategorie	20081204
4	Importing	I_CREA_LAN	Call by reference	☑	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20081202
5	Importing	I_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20081202
6	Importing	I_DOCUMENT_TYPE	Call by reference	☑	Type reference (TYPE)	WDHC_DOCUMENT_TYPE		Dokument Typ	20081202
7	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20081202

#	Exception	Resumable	Description	Created on
1	MISSING_PARAMETERS_FOR_CREATE	☐		20090305

Method MODIFY_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20081111
2	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20081111
3	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	SAPHC_LINKS_TEXT-TEXT		Textfeld der Länge 60	20081111

Method MODIFY_TEXT on class CL_HC_UTIL_DOCS has no exception.

Method UPDATE_APPL_ASSIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPL	Call by reference	☐	Type reference (TYPE)	SAPHC_APPL		Anwendung	20090713
2	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20081111
3	Importing	I_VALIDITY	Call by reference	☐	Type reference (TYPE)	R_VALIDITY		Help Center Gültigkeitsbereich	20081111

Method UPDATE_APPL_ASSIGNMENT on class CL_HC_UTIL_DOCS has no exception.

Method UPDATE_APPL_ASSIGNMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLS	Call by reference	☐	Type reference (TYPE)	SAPHC_LINKS_APP_TT		Help Center Links	20090713
2	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20081119

Method UPDATE_APPL_ASSIGNMENTS on class CL_HC_UTIL_DOCS has no exception.

Method UPDATE_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPL	Call by reference	☐	Type reference (TYPE)	SAPHC_APPL		Help Center Anwendungszuordnung	20081208
2	Importing	I_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20080812
3	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	STRING			20080312
4	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Sprachenschlüssel der aktuellen Textumgebung	20080312
5	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	SAPHC_LINKS_TEXT-TEXT		UUID in Character-Darstellung	20080312
6	Importing	I_VALIDITY	Call by reference	☐	Type reference (TYPE)	R_VALIDITY		Für Radiobuttons in Help Center	20080312

Method UPDATE_DOC on class CL_HC_UTIL_DOCS has no exception.

Method UPDATE_DOC_ADMIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLS	Call by reference	☐	Type reference (TYPE)	SAPHC_LINKS_APP_TT		Help Center Links	20090727
2	Importing	I_ASSIGNMENT_CHANGED	Call by reference	☐	Type reference (TYPE)	WDHC_BOOLEAN		Boolesches Feld	20090727
3	Importing	I_CATEGORY	Call by reference	☐	Type reference (TYPE)	WDHC_CATEGORY		Help Center: Kategorie	20090727
4	Importing	I_CREA_LAN	Call by reference	☐	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20090727
5	Importing	I_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20090727
6	Importing	I_DOCUMENT_TYPE	Call by reference	☐	Type reference (TYPE)	WDHC_DOCUMENT_TYPE		Dokument Typ	20090727
7	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20090727
8	Importing	I_HEAD_CHANGED	Call by reference	☐	Type reference (TYPE)	WDHC_BOOLEAN		Boolesches Feld	20090727
9	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20090727
10	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	SAPHC_LINKS_TEXT-TEXT		Textfeld der Länge 60	20090727
11	Importing	I_TEXT_CHANGED	Call by reference	☐	Type reference (TYPE)	WDHC_BOOLEAN		Boolesches Feld	20090727

Method UPDATE_DOC_ADMIN on class CL_HC_UTIL_DOCS has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	701