SAP ABAP Class CL_APL_ECATT_DOCU (eCATT-Object Documentation)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-TWB-TST-ECA (Application Component) eCATT Extended Computer Aided Test Tool
     ⤷ SECATT_MIDDLEWARE (Package) eCATT Middleware Objects

Properties

Class	CL_APL_ECATT_DOCU
Short Description	eCATT-Object Documentation
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SECATT_MIDDLEWARE	eCATT Middleware Objects
Created	20001024	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_APL_ECATT_DOCU has no forward declaration.

Interfaces

Class CL_APL_ECATT_DOCU has no interface implemented.

Friends

Class CL_APL_ECATT_DOCU has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	EX_ECATT	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CX_ECATT		Basis Class for eCATT - Exceptions	20010711
2	MSGSTR	Static Attribute	Private	☐	Type reference (TYPE)	STRING		Message string	20010711

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_EXISTENCE	Static method	Public	Method	Check if Documentation Exists	20011105
2	CHECK_TADIR_AND_DOKIL_ENTRY	Static method	Public	Method	Correct TADIR Entry and DOKIL	20050405
3	CHECK_TADIR_ENTRY	Static method	Public	Method	Correct TADIR Entry	20030312
4	COPY_DOCU_CATT_TO_ECATT	Static method	Public	Method	Copying Documents/Long Texts from CATT to eCATT	20011126
5	COPY_OBJECT_DOCU	Static method	Public	Method	Copying Documents/Long Texts for eCATT Object	20011003
6	DELETE_OBJECT_DOCU	Static method	Public	Method	Deletion of Documents/Long Texts of eCATT Objects	20001024
7	EDIT_DOCU	Static method	Private	Method	Edit documentation	20010711
8	PROCESS_OBJECT_DOCU	Static method	Public	Method	Editing of Documents/Long Texts for eCATT Objects	20001024
9	RENAME_OBJECT_DOCU	Static method	Public	Method	Renaming of Documents/Long Texts for eCATT Objects	20011003
10	REQUEST_OBJECT_DOCU	Static method	Public	Method	Request Documentation for eCATT Object	20020516
11	SHOW_DOCU	Static method	Private	Method	Display documentation	20010711
12	TRANSPORT_OBJECT_DOCU	Static method	Public	Method	Transport of eCATT Object Documents	20001024

Events

Class CL_APL_ECATT_DOCU has no event.

Types

Class CL_APL_ECATT_DOCU has no local type.

Method Signatures

Method CHECK_EXISTENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ATTACH_TYPE	Call by reference	☐	Type reference (TYPE)	ETDOC_TYPE		Anlagentyp	20100302
2	Exporting	EX_DOKNAME	Call by reference	☐	Type reference (TYPE)	DOKHL-OBJECT		Name des Dokuments	20100217
3	Exporting	EX_EXISTS	Value transfer	☐	Type reference (TYPE)	ETONOFF		'X'-Dokumentation exitiert	20011105
4	Exporting	EX_LANGU	Call by reference	☐	Type reference (TYPE)	DOKU_LANGU		Sprache, falls in Doku in IM_LANGU nicht existiert	20011105
5	Importing	IM_LANGU	Call by reference	☑	Type reference (TYPE)	DOKU_LANGU		Dokumentationssprache	20011105
6	Importing	IM_NON_SAPSCRIPT	Call by reference	☐	Type reference (TYPE)	ETONOFF	SPACE	"X" - Existenzprüfung für alle Nicht-SAP-Script Anlagen	20100513
7	Importing	IM_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20011105
8	Importing	IM_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20011105
9	Importing	IM_VAR_NAME	Call by reference	☑	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20100507

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basisklasse für eCatt Middleware Ausnahmen	20011105

Method CHECK_TADIR_AND_DOKIL_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_CANCEL	Value transfer	☐	Type reference (TYPE)	ETONOFF		TADIR-Eintrag schreiben wurde abgebrochen	20050405
2	Exporting	EX_CHANGED	Value transfer	☐	Type reference (TYPE)	ETONOFF		TADIR wurde korrigiert	20050405
3	Exporting	EX_DOCU_TADIR	Value transfer	☐	Type reference (TYPE)	TADIR		Katalog der Repository-Objekte	20050405
4	Importing	IM_NO_MESSAGES	Value transfer	☐	Type reference (TYPE)	ETONOFF	SPACE	'X' - Keine Meldungen über Zustand d. Dokumentation ausgeben	20050405
5	Importing	IM_OBJ_NAME	Value transfer	☐	Type reference (TYPE)	ETOBJ_NAME		Basisklasse für eCATT Objekte.	20050405
6	Importing	IM_OBJ_TYPE	Value transfer	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20050405
7	Importing	IM_TADIR_REPAIR	Value transfer	☐	Type reference (TYPE)	ETONOFF	'X'	'X' - TADIR-Eintrag korrigieren	20050405

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL_TADIR	☐	Basisklasse für eCatt Middleware Ausnahmen	20050405

Method CHECK_TADIR_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_CANCEL	Value transfer	☐	Type reference (TYPE)	ETONOFF		TADIR-Eintrag schreiben wurde abgebrochen	20030320
2	Exporting	EX_CHANGED	Value transfer	☐	Type reference (TYPE)	ETONOFF		TADIR wurde korrigiert	20030312
3	Exporting	EX_DOCU_TADIR	Value transfer	☐	Type reference (TYPE)	TADIR		Katalog der Repository-Objekte	20030312
4	Importing	IM_NO_MESSAGES	Value transfer	☐	Type reference (TYPE)	ETONOFF	SPACE	'X' - Keine Meldungen über Zustand d. Dokumentation ausgeben	20030320
5	Importing	IM_OBJ_NAME	Value transfer	☐	Type reference (TYPE)	ETOBJ_NAME		Basisklasse für eCATT Objekte.	20030312
6	Importing	IM_OBJ_TYPE	Value transfer	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20030312
7	Importing	IM_TADIR_REPAIR	Value transfer	☐	Type reference (TYPE)	ETONOFF	'X'	'X' - TADIR-Eintrag korrigieren	20030320

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL_TADIR	☐	Basisklasse für eCatt Middleware Ausnahmen	20030312

Method COPY_DOCU_CATT_TO_ECATT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_LANGUAGES	Call by reference	☑	Type reference (TYPE)	TABLE		Sprachen	20020206
2	Importing	IM_NAME_FROM	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20011126
3	Importing	IM_NAME_TO	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20011126
4	Importing	IM_RFCDEST	Call by reference	☐	Type reference (TYPE)	RFCDEST	SPACE	logische Destination (Wird bei Funktionsaufruf angegeben)	20020205
5	Importing	IM_TYPE_TO	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE	'ECSC'	eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20020116

Method COPY_DOCU_CATT_TO_ECATT on class CL_APL_ECATT_DOCU has no exception.

Method COPY_OBJECT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_LANGUAGES	Call by reference	☑	Type reference (TYPE)	TABLE		Sprachen	20020206
2	Importing	IM_NAME_FROM	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20011003
3	Importing	IM_NAME_TO	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20011003
4	Importing	IM_TYPE_FROM	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20020116
5	Importing	IM_TYPE_TO	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20020116

Method COPY_OBJECT_DOCU on class CL_APL_ECATT_DOCU has no exception.

Method DELETE_OBJECT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ECATT_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	CL_APL_ECATT_OBJECT		Basisklasse für eCATT Objekte.	20001025

Method DELETE_OBJECT_DOCU on class CL_APL_ECATT_DOCU has no exception.

Method EDIT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_TEMPLATE_OBJECT	Call by reference	☐	Type reference (TYPE)	DOKHL-OBJECT	'TEMPLATE_ECATT'	Dokumentations-Objekt	20130208
2	Importing	IM_DOKNAME	Call by reference	☐	Type reference (TYPE)	STRING		Dokumentenname	20010711
3	Importing	IM_LANGU	Call by reference	☐	Type reference (TYPE)	DOKU_LANGU		Dokumentationssprache	20010711

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basisklasse für eCatt Middleware Ausnahmen	20010711

Method PROCESS_OBJECT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ECATT_OBJECT	Call by reference	☑	Object reference (TYPE REF TO)	CL_APL_ECATT_OBJECT		Basisklasse für eCATT Objekte.	20001024
2	Importing	IM_LANGU	Call by reference	☑	Type reference (TYPE)	SYLANGU		R/3-System, aktuelle Sprache	20010711
3	Importing	IM_OBJ_MODE	Call by reference	☑	Type reference (TYPE)	ETOBJ_MODE		Bearbeitungsmodus eines eCATT-Objektes	20020522
4	Importing	IM_OBJ_NAME	Call by reference	☑	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20020523
5	Importing	IM_OBJ_TYPE	Call by reference	☑	Type reference (TYPE)	ETOBJ_TYPE		eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20020523

Method PROCESS_OBJECT_DOCU on class CL_APL_ECATT_DOCU has no exception.

Method RENAME_OBJECT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME_FROM	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20011003
2	Importing	IM_NAME_TO	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20011003
3	Importing	IM_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20011003

Method RENAME_OBJECT_DOCU on class CL_APL_ECATT_DOCU has no exception.

Method REQUEST_OBJECT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_OBJ_MODE	Call by reference	☐	Type reference (TYPE)	ETOBJ_MODE		Bearbeitungsmodus eines eCATT-Objektes	20020516
2	Importing	IM_OBJ_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20020516
3	Importing	IM_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20020516

Method REQUEST_OBJECT_DOCU on class CL_APL_ECATT_DOCU has no exception.

Method SHOW_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOKNAME	Call by reference	☐	Type reference (TYPE)	STRING		Dokumentenname	20010711
2	Importing	IM_LANGU	Call by reference	☐	Type reference (TYPE)	DOKU_LANGU		Dokumentationssprache	20010711

#	Exception	Resumable	Description	Created on
1	CX_ECATT_APL	☐	Basisklasse für eCatt Middleware Ausnahmen	20010711

Method TRANSPORT_OBJECT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	ETOBJ_NAME		eCATT Objekt	20020129
2	Importing	IM_TYPE	Call by reference	☐	Type reference (TYPE)	ETOBJ_TYPE		eCATT Objekttyp (Testdaten, Skript, Konfiguration etc.)	20020129

Method TRANSPORT_OBJECT_DOCU on class CL_APL_ECATT_DOCU has no exception.

History

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