SAP ABAP Interface IF_USMD_CONV_SOM_GOV_ENTITY (Governance API: Single Chg. Req. Convenience Governance API)

Hierarchy

☛ MDG_FND (Software Component) MDG Foundation
   ⤷ CA-MDG-AF (Application Component) Application Framework
     ⤷ USMD_GOVERNANCE_API (Package) Master Data Governance API

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface composition (i COMPRISING i_ref)	IF_USMD_CONV_SOM_GOV_API	Governance API: Single Chg. Req. Convenience Governance API	20101015
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_USMD_CONV_SOM_GOV_API	MD Governance API for Single Object Maint. (Convenience)	20101015

Properties

Interface	IF_USMD_CONV_SOM_GOV_ENTITY
Short Description	Governance API: Single Chg. Req. Convenience Governance API

General Data

Package	USMD_GOVERNANCE_API	Master Data Governance API
Created	20101015	SAP
Last changed	20131127	SAP
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

Interface IF_USMD_CONV_SOM_GOV_ENTITY has no interface.

Friends

Interface IF_USMD_CONV_SOM_GOV_ENTITY has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_STRUCT_KEY	Constant	Public	☐	Type reference (TYPE)	USMD_STRUCT	'KEY'	Only Key	20101101
2	GC_STRUCT_KEY_ATTACH	Constant	Public	☐	Type reference (TYPE)	USMD_STRUCT	'KATTA'	Keys + USMD_S_ATTACHMENT	20101101
3	GC_STRUCT_KEY_ATTACH_WO_CONT	Constant	Public	☐	Type reference (TYPE)	USMD_STRUCT	'KATTW'	Keys + USMD_S_ATTACHMENT_WO_CONTENT	20101101
4	GC_STRUCT_KEY_ATTR	Constant	Public	☐	Type reference (TYPE)	USMD_STRUCT	'KATTR'	Keys + Attributes According to IT_ATTRIBUTE	20101101
5	GC_STRUCT_KEY_FLD_PROP	Constant	Public	☐	Type reference (TYPE)	USMD_STRUCT	'KFLDP'	Field Properties	20110426
6	GC_STRUCT_KEY_SET	Constant	Public	☐	Type reference (TYPE)	USMD_STRUCT	'KSET'	Key + SET	20101101
7	GC_STRUCT_KEY_SET_SO	Constant	Public	☐	Type reference (TYPE)	USMD_STRUCT	'KSETS'	Keys + SET (Higher-Level Entity Types)	20101101
8	GC_STRUCT_KEY_TXT	Constant	Public	☐	Type reference (TYPE)	USMD_STRUCT	'KTXT'	Keys + Texts	20101101
9	GC_STRUCT_KEY_TXT_LANGU	Constant	Public	☐	Type reference (TYPE)	USMD_STRUCT	'KLTXT'	Keys + Texts + LANGU	20101101
10	MV_ENTITY_CHANGED	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL		Entity Data Changed	20110405

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUFFER_ENTITIES_FOR_EDIT	Instance method	Public	Method	Buffer Entity for Edit Action and Checks	20101015
2	CHECK_ENTITY_AUTHORIZATION	Instance method	Public	Method	Check Authorization for an Entity	20110721
3	CHECK_ENTITY_DATA	Instance method	Public	Method	Checks Entity Data	20101015
4	CONFIRM_ENTITY_DATA	Instance method	Public	Method	Writes write buffer to change request buffer (flush)	20110421
5	CREATE_ENTITY_TMP_KEY	Instance method	Public	Method	Generate Temporary Entity Key	20101015
6	DELETE_ENTITY_DATA	Instance method	Public	Method	Deletes Entity Data	20101015
7	DEQUEUE_ENTITY	Instance method	Public	Method	Unlocks the Entity	20101015
8	DEQUEUE_ENTITY_ALL	Instance method	Public	Method	Dequeues All Enqueued Entities (Buffer!)	20110715
9	ENQUEUE_ENTITY	Instance method	Public	Method	Locks the Entity and Change Request	20101015
10	EXCHANGE_ENTITY_KEY	Instance method	Public	Method	Replaces Entity Key	20101015
11	GET_DERIVE_ENTITY_RESULT	Instance method	Public	Method	Execute derive entity returning the result w/o writing	20130619
12	GET_ENTITY_FIELD_PROPERTIES	Instance method	Public	Method	Field Properties of the Attributes of an Entity	20110131
13	GET_ENTITY_STRUCTURE	Instance method	Public	Method	Returns the Data Reference of an Entity	20101029
14	GET_KEY_DATA_FROM_EDIT_BUFFER	Instance method	Public	Method	Returns Entities/Keys buffered for Edit Action and Checks	20120518
15	GET_MAIN_ENTITY	Instance method	Public	Method	Returns the Main Entity of a Change Request	20101015
16	IS_NEW_ENTITY	Instance method	Public	Method	Checks If New Object Is Being Created	20101015
17	IS_TMP_KEY	Instance method	Public	Method	Checks If Key Is a Temporary Key	20101015
18	QUERY_ENTITY_DATA	Instance method	Public	Method	Query	20130313
19	READ_ENTITY_DATA	Instance method	Public	Method	Reads Entity Data	20101015
20	READ_OBSOLETE_ENTITY_DATA	Instance method	Public	Method	Liest obsolete Entitätsdaten	20111109
21	REMOVE_ENTITY	Instance method	Public	Method	Removes Entity from Processing (Deletion from Object List)	20110125
22	WRITE_ENTITY_DATA	Instance method	Public	Method	Writes Entity Data	20101015

Events

Interface IF_USMD_CONV_SOM_GOV_ENTITY has no event.

Types

Interface IF_USMD_CONV_SOM_GOV_ENTITY has no local type.

Method Signatures

Method BUFFER_ENTITIES_FOR_EDIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_REFRESH_BUFFER	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		##Refresh buffer before buffer values	20110421
2	Importing	IT_ENTITY_KEYS	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Tabelle vonTabelle von Entitätenstrukturen	20101103

Method BUFFER_ENTITIES_FOR_EDIT on Interface IF_USMD_CONV_SOM_GOV_ENTITY has no exception.

Method CHECK_ENTITY_AUTHORIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_IGNORE_MESSAGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	No messages in message container	20111125
2	Importing	IT_ENTITY_DATA	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		##Entity Name and Data	20110721
3	Importing	IV_ACTION	Call by reference	☐	Type reference (TYPE)	ACTIV_AUTH		Aktivität	20110721
4	Exporting	RT_AUTHORIZED	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		##Entity Name and Data with Authorizations	20110721

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API_CORE_ERROR	☐	General Processing Error (CX_USMD_CORE_DYNAMIC_CHECK)	20110721
2	CX_USMD_GOV_API_ENTITY_AUTH	☐	No Authorization for an Entity	20110721

Method CHECK_ENTITY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ENTITY_KEYS	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Tabelle vonTabelle von Entitätenstrukturen	20101103

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	Allgemeiner Verarbeitungsfehler GOV_API	20101110
2	CX_USMD_GOV_API_CORE_ERROR	☐	CX_USMD_CORE_DYNAMIC_CHECK	20101021

Method CONFIRM_ENTITY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_CHANGES_ALL	Value transfer	☐	Object reference (TYPE REF TO)	IF_USMD_DELTA_BUFFER_READ		Lesendes Interface zum Datenpuffer	20110428

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API_CORE_ERROR	☐	Allgemeiner Verarbeitungsfehler (CX_USMD_CORE_DYNAMIC_CHECK)	20110427

Method CREATE_ENTITY_TMP_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_KEY	Value transfer	☐	Type reference (TYPE)	ANY			20101103
2	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entitätstyp	20101015
3	Importing	IV_LOCK	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_TRUE	boolsche Variable (X=true, -=false, space=unknown)	20101116

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	Allgemeiner Verarbeitungsfehler GOV_API	20110525
2	CX_USMD_GOV_API_CORE_ERROR	☐	Allgemeiner Verarbeitungsfehler (CX_USMD_CORE_DYNAMIC_CHECK)	20110525

Method DELETE_ENTITY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ENTITY_KEYS	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Tabelle vonTabelle von Entitätenstrukturen	20101103
2	Importing	IV_STRUCT	Call by reference	☐	Type reference (TYPE)	USMD_STRUCT	GC_STRUCT_KEY_ATTR	Art der Datenstruktur	20101208

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	General Processing Error GOV_API	20120611
2	CX_USMD_GOV_API_CORE_ERROR	☐	CX_USMD_CORE_DYNAMIC_CHECK	20101021
3	CX_USMD_GOV_API_ENTITY_DEL	☑	RESUMABLE Fehler beim Löschen einer Entität	20101210

Method DEQUEUE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ENTITY_KEYS	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Tabelle vonTabelle von Entitätenstrukturen	20101103

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	CX_USMD_CORE_DYNAMIC_CHECK	20101110

Method DEQUEUE_ENTITY_ALL Signature

Method DEQUEUE_ENTITY_ALL on Interface IF_USMD_CONV_SOM_GOV_ENTITY has no parameter.
Method DEQUEUE_ENTITY_ALL on Interface IF_USMD_CONV_SOM_GOV_ENTITY has no exception.

Method ENQUEUE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ENTITY_KEYS	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Tabelle vonTabelle von Entitätenstrukturen	20101103
2	Importing	IV_LOCK_MODE	Call by reference	☐	Type reference (TYPE)	ENQMODE	'E'	Sperrmodus	20101015

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	Allgemeiner Verarbeitungsfehler GOV_API	20101110
2	CX_USMD_GOV_API_CORE_ERROR	☐	CX_USMD_CORE_DYNAMIC_CHECK	20101021
3	CX_USMD_GOV_API_ENTITY_LOCK	☑	Fehler beim Sperren einer Entität	20101117

Method EXCHANGE_ENTITY_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_NEW_KEY	Value transfer	☐	Type reference (TYPE)	DATA		Neuer Schlüssel in Schlüsselstruktur	20110318
2	Importing	IS_NEW_KEY	Call by reference	☐	Type reference (TYPE)	ANY		Neuer Schlüssel in Schlüsselstruktur	20101117
3	Importing	IS_OLD_KEY	Call by reference	☐	Type reference (TYPE)	ANY		Alter Schlüssel in Schlüsselstruktur	20101117
4	Importing	IV_ENTITY	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entitätstyp	20101015

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	Allgemeiner Verarbeitungsfehler GOV_API	20101110
2	CX_USMD_GOV_API_CORE_ERROR	☐	CX_USMD_CORE_DYNAMIC_CHECK	20101021
3	CX_USMD_GOV_API_ENTITY_LOCK	☐	Fehler beim Sperren einer Entität	20110309

Method GET_DERIVE_ENTITY_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Table containing key and data of the entity type	20130619
2	Importing	IV_EDITION	Call by reference	☑	Type reference (TYPE)	USMD_EDITION		Edition	20130619
3	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entity Type	20130619

Method GET_DERIVE_ENTITY_RESULT on Interface IF_USMD_CONV_SOM_GOV_ENTITY has no exception.

Method GET_ENTITY_FIELD_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_FLD_PROP_ATTR	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Field Properties of Entity	20110131
2	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Entity Key and Entity Data	20110131
3	Importing	IV_ACTION	Call by reference	☐	Type reference (TYPE)	ACTIV_AUTH	'03'	Aktivität	20110131
4	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entitätstyp	20110131
5	Importing	IV_GET_FLD_PROP_ATTR_TEXT	Call by reference	☑	Type reference (TYPE)	USMD_MULTI_LANGU		If Set, Structure with Language Dependent Key and Atrributes	20121022

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	General Processing Error GOV_API	20110131

Method GET_ENTITY_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_STRUCTURE	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Rückgabestruktur	20101101
2	Exporting	ER_TABLE	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Rückgabetabelle	20101101
3	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entitätstyp	20101101
4	Importing	IV_STRUCT_TYPE	Call by reference	☐	Type reference (TYPE)	USMD_STRUCT	GC_STRUCT_KEY	Art der Datenstruktur	20101101

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	CX_USMD_CORE_DYNAMIC_CHECK	20101110

Method GET_KEY_DATA_FROM_EDIT_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ENTITY_KEYS	Value transfer	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Table Type for Table of Entities Structure	20120518

Method GET_KEY_DATA_FROM_EDIT_BUFFER on Interface IF_USMD_CONV_SOM_GOV_ENTITY has no exception.

Method GET_MAIN_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_ENTITY_KEY	Value transfer	☐	Type reference (TYPE)	USMD_GOV_API_S_ENT_STRUC		MDG: Entitätstyp mit referenzierter Struktur	20101105

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	Allgemeiner Verarbeitungsfehler GOV_API	20101110

Method IS_NEW_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ENTITY_KEY	Call by reference	☑	Type reference (TYPE)	USMD_GOV_API_S_ENT_STRUC		MDG: Entitätstyp mit referenzierter Struktur	20101015
2	Returning	RV_NEW_ENTITY	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20101103

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	Allgemeiner Verarbeitungsfehler GOV_API	20101110

Method IS_TMP_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ENTITY_KEY	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_S_ENT_STRUC		MDG: Entitätstyp mit referenzierter Struktur	20101105
2	Returning	RV_TMP_KEY	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20101103

Method IS_TMP_KEY on Interface IF_USMD_CONV_SOM_GOV_ENTITY has no exception.

Method QUERY_ENTITY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ACTIVE_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Query results from active / snapshot data	20130313
2	Exporting	ET_INACTIVE_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Query results from inactive data only	20130313
3	Importing	IT_SELECTION_CONDITION	Call by reference	☐	Type reference (TYPE)	USMD_TS_SEL		Sorted Table: Selection Condition (Range per Field)	20130313
4	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	USMD_ENTITY		Entity Type	20130313
5	Importing	IV_NO_AUTHORITY_CHECK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	FALSE = Authorization check will be performed	20130313
6	Importing	IV_NO_OF_ENTRIES	Call by reference	☐	Type reference (TYPE)	I	0	0 means no restriction	20130313

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API_CORE_ERROR	☐	General Processing Error (CX_USMD_CORE_DYNAMIC_CHECK)	20130313

Method READ_ENTITY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ACTIVE_DATA	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	''	Aktive Daten lesen	20101111
2	Importing	IF_SELECT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	It_entity_keys sind select-keys	20110131
3	Importing	IT_ENTITY_KEYS	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Tabelle vonTabelle von Entitätenstrukturen	20101103
4	Importing	IV_STRUCT	Call by reference	☐	Type reference (TYPE)	USMD_STRUCT	GC_STRUCT_KEY_ATTR	Art der Datenstruktur	20101206
5	Returning	RT_ENTITY_DATA	Value transfer	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Tabelle vonTabelle von Entitätenstrukturen	20101103

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	Allgemeiner Verarbeitungsfehler GOV_API	20101110
2	CX_USMD_GOV_API_CORE_ERROR	☐	CX_USMD_CORE_DYNAMIC_CHECK	20101021

Method READ_OBSOLETE_ENTITY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ENTITY_KEYS	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Tabelle vonTabelle von Entitätenstrukturen	20111109
2	Importing	IV_STRUCT	Call by reference	☐	Type reference (TYPE)	USMD_STRUCT	GC_STRUCT_KEY_ATTR	Art der Datenstruktur	20111109
3	Returning	RT_ENTITY_DATA	Value transfer	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Tabelle vonTabelle von Entitätenstrukturen	20111109

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	Allgemeiner Verarbeitungsfehler GOV_API	20111109
2	CX_USMD_GOV_API_CORE_ERROR	☐	CX_USMD_CORE_DYNAMIC_CHECK	20111109

Method REMOVE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ENTITY_KEYS	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_TABL		MDG: Schlüssel von Entitäten der Objektliste	20110125

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	General Processing Error GOV_API	20110125
2	CX_USMD_GOV_API_CORE_ERROR	☐	CX_USMD_CORE_DYNAMIC_CHECK	20110125

Method WRITE_ENTITY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ENTITY_DATA	Call by reference	☐	Type reference (TYPE)	USMD_GOV_API_TS_ENT_DATA		MDG: Tabelle vonTabelle von Entitätenstrukturen	20101015

#	Exception	Resumable	Description	Created on
1	CX_USMD_GOV_API	☐	Allgemeiner Verarbeitungsfehler GOV_API	20101110
2	CX_USMD_GOV_API_CORE_ERROR	☐	CX_USMD_CORE_DYNAMIC_CHECK	20101021
3	CX_USMD_GOV_API_ENTITY_WRITE	☑	RESUMABLE Fehler beim Schreiben einer Entität	20101214

History

Last changed by/on	SAP	20131127
SAP Release Created in	703