SAP ABAP Class CL_DML_HEADER (MDF Connection Header Data)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-GTF-MDF (Application Component) Master Data Framework
     ⤷ COM_DML_ENGINE (Package) MDF: Single Object Runtime

Properties

Class	CL_DML_HEADER
Short Description	MDF Connection Header Data
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	COM_DML_ENGINE	MDF: Single Object Runtime
Created	20030917	SAP
Last change	20040930	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_DML_CONST	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	SYDES	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_DML_HEADER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_DML_API	☐	20030917	MDF APIs
2	CL_DML_ARCHIVING	☐	20040726	MDF Connection for Archiving
3	CL_DML_ENGINE	☐	20030917	MDF Processing
4	CL_DML_RELATION	☐	20030917	DML Connection for Relationships
5	CL_DML_SERVICE_ECM	☐	20030917	MDF Connection Change Management
6	CL_DML_TEXT	☐	20030917	MDF Connection for Texts

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	T_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	TT_HEADER_UPD		Buffer Header Data	20030917
2	T_BUFFER_NEGATIVE	Static Attribute	Private	☐	Type reference (TYPE)	DML_T_OBJ_HEADER		Buffer of Objects Not Found	20040123
3	T_KEY_STRING	Static Attribute	Private	☐	Type reference (TYPE)	TT_KEY_STRING		Buffer of Concatenated Keys	20031014

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACCESS_DB	Static method	Private	Method	Database Access, Buffering	20040428
2	BUILD_KEY_STRING	Static method	Protected	Method	Concatenate External Key Fields	20030917
3	CHECK_KEY	Static method	Protected	Method	Convert and Check Key Fields	20031106
4	CONVERT_KEY	Static method	Public	Method	Key Conversion Internal <-> External	20030917
5	DELETE_HISTORY	Static method	Protected	Method	Delete All Data with History	20040728
6	GET_BUFFER	Static method	Public	Method	Export Buffer	20031217
7	GET_DATA	Static method	Protected	Method	Read Header Data (From Buffer or Database)	20030917
8	GET_INACTIVE_STATE	Static method	Private	Method	Read Inactive Created Objects	20040930
9	GET_VERSIONS	Static method	Protected	Method	Read All Versions of an Object	20030917
10	INIT_BUFFER	Static method	Protected	Method	Reset Changes in Buffer	20030917
11	POST	Static method	Protected	Method	Save Changes from Buffer	20030917
12	PROVIDE_HISTORY	Static method	Protected	Method	Read All Data with History	20040727
13	SEARCH	Static method	Protected	Method	Search by Header Data	20030917
14	SET_DATA	Static method	Protected	Method	Write Header Data to Buffer	20030917
15	SPLIT_KEY_STRING	Static method	Protected	Method	Split External Key Fields	20031014

Events

Class CL_DML_HEADER has no event.

Types

Class CL_DML_HEADER has no local type.

Method Signatures

Method ACCESS_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HEADER	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_HEADER		Kopfdaten	20040428
2	Importing	IT_OBJVERS_ID	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_KEY		Objektversionsschlüssel	20040428
3	Importing	I_NO_BUFFER	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Keine Pufferung	20040428
4	Importing	I_NO_DELETED	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Keine gelöschten Objekte lesen	20040428
5	Importing	I_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DML_OBJTYP		Objekttyp	20040428
6	Importing	I_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	DML_TMSTMP_MODIFY		Zeitstempel zum Lesen aus Historientabelle	20040428

Method ACCESS_DB on class CL_DML_HEADER has no exception.

Method BUILD_KEY_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXTERNAL_KEY	Call by reference	☐	Type reference (TYPE)	DML_OBJ_KEY_EXT		Externe Schlüsselfelder	20030917
2	Importing	I_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DML_OBJTYP		Objekttyp	20030917
3	Importing	I_OWNER_GUID	Call by reference	☑	Type reference (TYPE)	DML_OWNER		Eigentümer	20040119
4	Importing	I_SEPARATOR	Call by reference	☐	Type reference (TYPE)	CHAR1	';'	Trennzeichen zw. Einzelfeldern	20030917
5	Importing	I_VERSION	Call by reference	☑	Type reference (TYPE)	DML_VERSION		Versionszähler	20040119
6	Returning	R_STRING	Value transfer	☐	Type reference (TYPE)	STRING		Konkatenierter Schlüssel	20030917

Method BUILD_KEY_STRING on class CL_DML_HEADER has no exception.

Method CHECK_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_KEY_EXT	Value transfer	☐	Type reference (TYPE)	ANY		Schlüsselfelder	20031106
2	Importing	I_INST_ERROR_LOG	Call by reference	☑	Object reference (TYPE REF TO)	CL_DML_MESSAGE		Instanz Fehlerprotokoll	20031106
3	Importing	I_NO_CHECK	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>TRUE	Keine Prüfung, nur Konvertierung	20031106

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20031106

Method CONVERT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_KEYS	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_HEADER		Schlüssel	20030917
2	Importing	I_GET_ALL_VERSIONS	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Neueste Version lesen	20031211
3	Importing	I_GET_DELETED	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Auch Löscheinträge suchen	20031104
4	Importing	I_NO_BUFFER	Value transfer	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Keine Pufferung	20030917
5	Importing	I_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DML_OBJTYP		Objekttyp	20030917

Method CONVERT_KEY on class CL_DML_HEADER has no exception.

Method DELETE_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OBJECT_KEYS	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_KEY		Schlüssel	20040728
2	Importing	I_DELETE_CURRENT	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>TRUE	Aktuellen Stand löschen	20040728
3	Importing	I_DELETE_HISTORY	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>TRUE	Historie Settyp löschen	20040728
4	Importing	I_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DML_OBJTYP		MDF-Objekttyp	20040728

Method DELETE_HISTORY on class CL_DML_HEADER has no exception.

Method GET_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HEADER	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_HEADER		Kopfdaten	20031217
2	Importing	I_CHANGED_OBJECTS	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Geändert Objekte	20031217
3	Importing	I_COMPLETE	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>TRUE	Alles außer Löschsätzen	20031217
4	Importing	I_NEW_OBJECTS	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Neue Objekte	20031217
5	Importing	I_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	DML_OBJTYP		Objekttyp	20031217

Method GET_BUFFER on class CL_DML_HEADER has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HEADER	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_HEADER		Kopfdaten	20030917
2	Importing	IT_ECM_DATA	Value transfer	☑	Type reference (TYPE)	DML_T_CHANGE_GRAPH		Änderungsstände	20030917
3	Importing	IT_OBJVERS_ID	Value transfer	☐	Type reference (TYPE)	DML_T_OBJ_KEY		Objektversionsschlüssel	20030917
4	Importing	I_ECM_SPECIFIED	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Änderungsdienst berücksichtigen	20040331
5	Importing	I_NO_BUFFER	Value transfer	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Keine Pufferung	20030917
6	Importing	I_NO_DELETED	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>TRUE	Keine gelöschten Objekte lesen	20031013
7	Importing	I_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	DML_TMSTMP_MODIFY		Zeitstempel zum Lesen aus Historientabelle	20031007

Method GET_DATA on class CL_DML_HEADER has no exception.

Method GET_INACTIVE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_HEADER	Call by reference	☐	Type reference (TYPE)	DML_S_OBJ_HEADER		Kopfdaten	20040930
2	Importing	I_KEY_EXT	Call by reference	☑	Type reference (TYPE)	DML_OBJ_KEY_EXT		Externe Schlüsseldaten	20040930
3	Importing	I_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DML_OBJTYP		MDF-Objekttyp	20040930
4	Importing	I_OBJVERS_ID	Call by reference	☑	Type reference (TYPE)	DML_OBJVERS_ID		Schlüssel Objektversion	20040930
5	Importing	I_OWNER	Call by reference	☑	Type reference (TYPE)	DML_OWNER		Eigentümer	20040930
6	Importing	I_VERSION	Call by reference	☑	Type reference (TYPE)	DML_VERSION		Version	20040930

Method GET_INACTIVE_STATE on class CL_DML_HEADER has no exception.

Method GET_VERSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HEADER	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_HEADER		Kopfdaten	20030917
2	Importing	IT_OBJECT_KEYS	Call by reference	☐	Type reference (TYPE)	DML_T_OBJECT_KEY		Objektschlüssel	20030917
3	Importing	I_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DML_OBJTYP		Objektyp	20030917

Method GET_VERSIONS on class CL_DML_HEADER has no exception.

Method INIT_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OBJVERS_ID	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_KEY		Objecktversionsschlüssel	20030917

Method INIT_BUFFER on class CL_DML_HEADER has no exception.

Method POST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OBJVERS_ID	Value transfer	☐	Type reference (TYPE)	DML_T_OBJ_KEY		Objektversionsschlüssel	20030917

Method POST on class CL_DML_HEADER has no exception.

Method PROVIDE_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CURRENT	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_HEADER		Aktueller Stand	20040727
2	Exporting	ET_HISTORY	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_HEADER		Historie	20040727
3	Importing	IT_OBJVERS_ID	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_KEY		Schlüssel	20040727
4	Importing	I_GET_CURRENT	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>TRUE	Aktuellen Stand lesen	20040727
5	Importing	I_GET_HISTORY	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>TRUE	Historie lesen	20040727
6	Importing	I_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DML_OBJTYP		MDF-Objekttyp	20040727

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20040727

Method SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HEADER	Call by reference	☐	Type reference (TYPE)	DML_T_OBJ_HEADER		Kopfdaten	20030917
2	Importing	IT_SEARCH_CRITERIA	Call by reference	☐	Type reference (TYPE)	DML_T_SEARCH		Suchkriterien Kopfdaten	20030917
3	Importing	I_MAX_HITS	Call by reference	☐	Type reference (TYPE)	DML_NUMC5	99999	Maximale Trefferzahl	20030917
4	Importing	I_NO_BUFFER	Value transfer	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	Puffer nicht füllen	20030917
5	Importing	I_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DML_OBJTYP		Objekttyp	20030917
6	Importing	I_SEARCH_HISTORY	Call by reference	☐	Type reference (TYPE)	DML_BOOLEAN	CL_DML_CONST=>FALSE	In Historientabelle suchen	20040824

Method SEARCH on class CL_DML_HEADER has no exception.

Method SET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_HEADER	Call by reference	☑	Type reference (TYPE)	DML_T_OBJ_HEADER		Neue und zu ändernde Sätze	20030917
2	Importing	IT_OBJVERS_ID_DEL	Call by reference	☑	Type reference (TYPE)	DML_T_OBJ_KEY		Physisch zu löschende Objekte	20030917

Method SET_DATA on class CL_DML_HEADER has no exception.

Method SPLIT_KEY_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DML_OBJTYP		Objekttyp	20031014
2	Importing	I_SEPARATOR	Value transfer	☐	Type reference (TYPE)	CHAR1	';'	Trennzeichen zw. Einzelfeldern	20031014
3	Importing	I_STRING	Value transfer	☐	Type reference (TYPE)	STRING		Konkatenierter Schlüssel	20031014
4	Returning	R_EXTERNAL_KEY	Value transfer	☐	Type reference (TYPE)	DML_OBJ_KEY_EXT		Externe Schlüsselfelder	20031014

Method SPLIT_KEY_STRING on class CL_DML_HEADER has no exception.

History

Last changed by/on	SAP	20040930
SAP Release Created in	300