SAP ABAP Class CL_ABAP_DOCU_EXTERNAL (External Version of ABAP Keyword Documentation)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ SABAPDOCU (Package) ABAP Documentation Objects in ABAP Workbench

Properties

Class	CL_ABAP_DOCU_EXTERNAL
Short Description	External Version of ABAP Keyword Documentation
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SABAPDOCU	ABAP Documentation Objects in ABAP Workbench
Created	20121029	SAP
Last change	20141121
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_ABAP_DOCU_EXTERNAL has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_HTTP_EXT_ABAP_DOCU	☐	20130919	Call ABAP Keyword Documentation Using HTTP

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONTEXT_ABAP	Constant	Private	☐	Type reference (TYPE)	DOCUMENT-CONTEXT	`ABAP`		20130826
2	CONTEXT_CDS	Constant	Private	☐	Type reference (TYPE)	DOCUMENT-CONTEXT	`CDS`		20130826
3	FORMAT_CLASSIC	Constant	Public	☐	Type reference (TYPE)	STRING	`CLASSIC`		20130919
4	FORMAT_ECLIPSE	Constant	Public	☐	Type reference (TYPE)	STRING	`ECLIPSE`		20130919
5	FORMAT_STANDARD	Constant	Public	☐	Type reference (TYPE)	STRING	`STANDARD`		20130919
6	ICF_SERVICES	Static Attribute	Private	☐	See coding				20130114
7	INTERNAL_PATH	Constant	Private	☐	Type reference (TYPE)	STRING	`/SAP/BC/ABAP/DOCU`		20130114
8	PUBLIC_PATH	Constant	Public	☐	Type reference (TYPE)	STRING	`/SAP/PUBLIC/BC/ABAP/DOCU`	Path of http Service in ICF Hierarchy	20130114

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_ICF_SERVICES	Static method	Private	Method	In non-production SAP systems only	20130114
2	CHECK_DOCUMENT	Static method	Private	Method		20121029
3	CHECK_ENVIRONMENT	Static method	Private	Method		20121119
4	CHECK_FORM_FIELDS	Static method	Private	Method		20130320
5	CHECK_ICF_SERVICES	Static method	Private	Method		20130114
6	CHECK_INPUT	Static method	Private	Method		20121029
7	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20130114
8	DEBUG	Static method	Private	Method		20130227
9	EXECUTE_EXAMPLES	Static method	Private	Method		20121029
10	GET	Static method	Private	Method	Content of ABAP Keyword Documentation for External Display	20130919
11	GET_ABAP_DOCU_FOR_ADT	Static method	Public	Method	ABAP Syntax Documents for ADT F1 Help	20130919
12	GET_ABAP_DOCU_URL	Static method	Public	Method	URL for Document in ABAP Keyword Documentation	20131114
13	GET_CDS_DOCU_FOR_ADT	Static method	Public	Method	CDS Syntax Reference Documents for ADT F1 Help	20130919
14	GET_INITIAL_SCREEN	Static method	Private	Method		20121029
15	GET_INITIAL_TREE_SCREEN	Static method	Private	Method		20121029
16	GET_INPUT_FROM_TOKENS	Static method	Private	Method		20130506
17	GET_OPEN_SEARCH_XML	Static method	Private	Method		20121029
18	INPUT_HTML	Static method	Private	Method		20130504
19	INPUT_JS	Static method	Private	Method		20130507
20	SET_DEBUG	Static method	Private	Method		20130227
21	SUB_CHECK_INPUT	Static method	Private	Method		20121029

Events

Class CL_ABAP_DOCU_EXTERNAL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	DOCUMENT	Public	See coding			20130826	BEGIN OF document, context TYPE string, id TYPE string, END OF document
2	QUERY_PARAMETER	Public	See coding			20131121	BEGIN OF query_parameter, name TYPE string, value TYPE string, END OF query_parameter
3	QUERY_PARAMETERS	Public	See coding			20131121	query_parameters TYPE STANDARD TABLE OF query_parameter WITH EMPTY KEY

Method Signatures

Method ACTIVATE_ICF_SERVICES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	I			20130114

Method ACTIVATE_ICF_SERVICES on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method CHECK_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OBJECT	Value transfer	☐	Type reference (TYPE)	STRING			20121029
2	Returning	VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121029

Method CHECK_DOCUMENT on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method CHECK_ENVIRONMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	HTML	Call by reference	☐	Type reference (TYPE)	STRING			20121119
2	Importing	QUERY	Value transfer	☐	Type reference (TYPE)	STRING			20121119
3	Returning	RC	Value transfer	☐	Type reference (TYPE)	I			20121119
4	Importing	TOKENS	Call by reference	☐	Type reference (TYPE)	ABAPDOCU_TOKENS		Tabelle der Token der ausgewählten Anweisung	20121120

Method CHECK_ENVIRONMENT on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method CHECK_FORM_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEBUG	Call by reference	☐	Type reference (TYPE)	STRING			20130320
2	Importing	EXAINP	Call by reference	☐	Type reference (TYPE)	STRING			20130320
3	Importing	EXEC	Call by reference	☐	Type reference (TYPE)	STRING			20130320
4	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20130320
5	Importing	QUERY_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20130320
6	Returning	RC	Value transfer	☐	Type reference (TYPE)	I			20130320
7	Importing	TREE	Call by reference	☐	Type reference (TYPE)	STRING			20130320

Method CHECK_FORM_FIELDS on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method CHECK_ICF_SERVICES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR_HTML	Call by reference	☐	Type reference (TYPE)	STRING			20130114
2	Importing	LANGUAGE	Value transfer	☐	Type reference (TYPE)	STRING			20130114
3	Returning	RC	Value transfer	☐	Type reference (TYPE)	I			20130114

Method CHECK_ICF_SERVICES on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method CHECK_INPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HEADER	Value transfer	☐	Type reference (TYPE)	STRING			20121029
2	Importing	INPUT	Value transfer	☐	Type reference (TYPE)	STRING			20121029
3	Importing	QUERY	Value transfer	☐	Type reference (TYPE)	STRING			20121029
4	Returning	VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121029

Method CHECK_INPUT on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method DEBUG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADDRESS	Value transfer	☑	Type reference (TYPE)	STRING			20130227
2	Importing	CLIENT	Value transfer	☑	Type reference (TYPE)	STRING			20131113
3	Importing	EXAINP	Value transfer	☑	Type reference (TYPE)	STRING			20130227
4	Importing	EXEC	Call by reference	☑	Type reference (TYPE)	STRING			20130227
5	Importing	FORMAT	Value transfer	☑	Type reference (TYPE)	STRING			20130227
6	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20130227
7	Importing	ICF_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130227
8	Importing	INPUT	Value transfer	☑	Type reference (TYPE)	STRING			20130227
9	Importing	LANGUAGE	Value transfer	☑	Type reference (TYPE)	STRING			20130227
10	Importing	LOCAL_HOST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130227
11	Importing	OBJECT	Call by reference	☑	Type reference (TYPE)	STRING			20130227
12	Importing	PATH	Value transfer	☑	Type reference (TYPE)	STRING			20130227
13	Importing	QUERY	Call by reference	☑	Type reference (TYPE)	STRING			20130227
14	Importing	QUERY_STRING	Value transfer	☑	Type reference (TYPE)	STRING			20130227
15	Importing	TOKENS	Call by reference	☑	Type reference (TYPE)	ABAPDOCU_TOKENS			20130227
16	Importing	TREE	Value transfer	☑	Type reference (TYPE)	STRING			20130227

Method DEBUG on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method EXECUTE_EXAMPLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXAINP	Call by reference	☐	Type reference (TYPE)	STRING			20130212
2	Importing	EXEC	Call by reference	☐	Type reference (TYPE)	STRING			20121029
3	Changing	HTML	Call by reference	☐	Type reference (TYPE)	STRING			20121029
4	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20121029
5	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING			20121029

Method EXECUTE_EXAMPLES on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADDRESS	Value transfer	☑	Type reference (TYPE)	STRING		URL der http-Version	20130919
2	Importing	CLIENT	Value transfer	☑	Type reference (TYPE)	STRING		Mandant	20131113
3	Exporting	CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		Inhaltsart	20130919
4	Importing	DEBUG	Value transfer	☑	Type reference (TYPE)	STRING		Ausgabe der Eingabe	20130919
5	Importing	DOCUMENT	Call by reference	☑	Type reference (TYPE)	DOCUMENT		Dokument eines Kontexts, z.B. ABAP, CDS, ...	20130919
6	Importing	EXAINP	Value transfer	☑	Type reference (TYPE)	STRING		Eingabe in Beispielprogramme	20130919
7	Importing	EXEC	Value transfer	☑	Type reference (TYPE)	STRING		Beispielprogramm ausführbar darstellen oder ausführen	20130919
8	Importing	FORMAT	Value transfer	☑	Type reference (TYPE)	STRING		Format (STANDARD, ECLIPSE, CLASSIC)	20130919
9	Exporting	HTML	Call by reference	☐	Type reference (TYPE)	STRING		zeichenartige HTML-Datei	20130919
10	Importing	ICF_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	ABAP_TRUE, falls bereits über HTTP-Service erfolgt	20130919
11	Importing	INPUT	Value transfer	☑	Type reference (TYPE)	STRING		Puffer der Eingabe für Einstiegsbild	20130919
12	Importing	LANGUAGE	Value transfer	☑	Type reference (TYPE)	STRING		Sprache (EN, DE oder D; andere werden nach EN umgesetzt)	20130919
13	Importing	LOCAL_HOST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	ABAP_TRUE für Einmischen des aktuellen Servers	20130919
14	Importing	OBJECT	Value transfer	☑	Type reference (TYPE)	STRING		ABAP-Doku-Objekt (z.B. ABENABAP, ABAPDO, DYNPCHAIN)	20130919
15	Importing	PATH	Value transfer	☑	Type reference (TYPE)	STRING		Pfad zum Einmischen in Verweise	20130919
16	Importing	QUERY	Value transfer	☑	Type reference (TYPE)	STRING		Suchstring (Schlüsselwort, Begriff, Freitext)	20130919
17	Importing	QUERY_STRING	Value transfer	☑	Type reference (TYPE)	STRING		Query-String der URL	20130919
18	Importing	TOKENS	Call by reference	☑	Type reference (TYPE)	ABAPDOCU_TOKENS		Token-Tabelle für F1-Hilfe aus ABAP Editor	20130919
19	Importing	TREE	Value transfer	☑	Type reference (TYPE)	STRING		Baumanzeige auf der linken Seite	20130919
20	Exporting	XHTML	Call by reference	☐	Type reference (TYPE)	XSTRING		byteartige Datei (Bilder etc.)	20130919

Method GET on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method GET_ABAP_DOCU_FOR_ADT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		Inhaltsart	20130919
2	Exporting	HTML	Call by reference	☐	Type reference (TYPE)	STRING		HTML-Datei	20130919
3	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	`EN`	Sprache	20130919
4	Importing	TOKENS	Call by reference	☑	Type reference (TYPE)	ABAPDOCU_TOKENS		Token-Tabelle für F1-Hilfe aus ABAP Editor	20130919

Method GET_ABAP_DOCU_FOR_ADT on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method GET_ABAP_DOCU_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ADDRESS	Call by reference	☐	Type reference (TYPE)	STRING			20131121
2	Importing	FORMAT	Call by reference	☐	Type reference (TYPE)	STRING	FORMAT_STANDARD		20131114
3	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	`EN`		20131114
4	Importing	OBJECT	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20131114
5	Importing	QUERY	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20131121
6	Exporting	QUERY_PARAMETERS	Call by reference	☐	Type reference (TYPE)	QUERY_PARAMETERS			20131121
7	Returning	URL	Value transfer	☐	Type reference (TYPE)	STRING			20131114

Method GET_ABAP_DOCU_URL on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method GET_CDS_DOCU_FOR_ADT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Name des Dokuments	20130919
2	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING		HTML-Datei	20130919
3	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Sprachenschlüssel der Textumgebung	20130919

Method GET_CDS_DOCU_FOR_ADT on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method GET_INITIAL_SCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	STRING			20131113
2	Importing	FORMAT	Call by reference	☑	Type reference (TYPE)	STRING			20121029
3	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20121029
4	Importing	INPUT	Value transfer	☑	Type reference (TYPE)	STRING			20121029
5	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING		Sprache	20121029

Method GET_INITIAL_SCREEN on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method GET_INITIAL_TREE_SCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	STRING			20131113
2	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20121029
3	Importing	INPUT	Value transfer	☑	Type reference (TYPE)	STRING			20121029
4	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20121029

Method GET_INITIAL_TREE_SCREEN on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method GET_INPUT_FROM_TOKENS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INPUT	Value transfer	☐	Type reference (TYPE)	STRING			20130506
2	Importing	LANGUAGE	Value transfer	☐	Type reference (TYPE)	STRING			20130506
3	Importing	TOKENS	Call by reference	☐	Type reference (TYPE)	ABAPDOCU_TOKENS		Tabelle der Token der ausgewählten Anweisung	20130506

Method GET_INPUT_FROM_TOKENS on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method GET_OPEN_SEARCH_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADDRESS	Call by reference	☐	Type reference (TYPE)	STRING			20121029
2	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	STRING			20131113
3	Importing	FORMAT	Call by reference	☑	Type reference (TYPE)	STRING			20121029
4	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20121029
5	Returning	XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20121029

Method GET_OPEN_SEARCH_XML on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method INPUT_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	STRING			20131113
2	Importing	FORMAT	Call by reference	☐	Type reference (TYPE)	STRING			20130504
3	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20130504
4	Importing	INPUT	Value transfer	☐	Type reference (TYPE)	STRING			20130504
5	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20130504

Method INPUT_HTML on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method INPUT_JS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADDRESS	Value transfer	☐	Type reference (TYPE)	STRING			20130507
2	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	STRING			20131113
3	Importing	FORMAT	Call by reference	☐	Type reference (TYPE)	STRING			20130507
4	Returning	JS	Value transfer	☐	Type reference (TYPE)	STRING			20130507
5	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20130507

Method INPUT_JS on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method SET_DEBUG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DEBUG	Call by reference	☐	Type reference (TYPE)	STRING			20130227
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	STRING			20130227

Method SET_DEBUG on class CL_ABAP_DOCU_EXTERNAL has no exception.

Method SUB_CHECK_INPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HEADER	Call by reference	☐	Type reference (TYPE)	STRING			20121029
2	Importing	INPUT	Call by reference	☐	Type reference (TYPE)	STRING			20121029
3	Importing	QUERY	Call by reference	☐	Type reference (TYPE)	STRING			20121029
4	Importing	SYMBOL	Call by reference	☐	Type reference (TYPE)	STRING			20121029
5	Returning	VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121029

Method SUB_CHECK_INPUT on class CL_ABAP_DOCU_EXTERNAL has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	740