SAP ABAP Interface IF_USMD_GOV_API_ENTITY (Governance API: Master Data)
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_GOV_API Governance API 20100521
2 Interface implementation (CLASS c. INTERFACES i_ref)  CL_USMD_GOV_API Master Data Governance API 20100521
Properties
Interface IF_USMD_GOV_API_ENTITY  
Short Description Governance API: Master Data    
General Data
Package USMD_GOVERNANCE_API   Master Data Governance API 
Created 20100521   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_GOV_API_ENTITY has no interface.
Friends
Interface IF_USMD_GOV_API_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' Number only 20100617
2 GC_STRUCT_KEY_ATTACH Constant Public Type reference (TYPE) USMD_STRUCT 'KATTA' Keys + USMD_S_ATTACHMENT 20100617
3 GC_STRUCT_KEY_ATTACH_WO_CONT Constant Public Type reference (TYPE) USMD_STRUCT 'KATTW' Keys + USMD_S_ATTACHMENT_WO_CONTENT 20100617
4 GC_STRUCT_KEY_ATTR Constant Public Type reference (TYPE) USMD_STRUCT 'KATTR' Keys + Attributes According to IT_ATTRIBUTE 20100617
5 GC_STRUCT_KEY_SET Constant Public Type reference (TYPE) USMD_STRUCT 'KSET' Key + SET 20100617
6 GC_STRUCT_KEY_SET_SO Constant Public Type reference (TYPE) USMD_STRUCT 'KSETS' Keys + SET (Higher-Level Entity Types) 20100617
7 GC_STRUCT_KEY_TXT Constant Public Type reference (TYPE) USMD_STRUCT 'KTXT' Keys + Texts 20100617
8 GC_STRUCT_KEY_TXT_LANGU Constant Public Type reference (TYPE) USMD_STRUCT 'KLTXT' Keys + Texts + LANGU 20100617
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_ENTITY_AUTHORIZATION Instance method Public Method Execution of Authorization Checks for an Entity 20100521
2 CHECK_ENTITY_DATA Instance method Public Method Checking of Specific Entities 20100915
3 CHECK_ENTITY_LOCK_SINGLE Instance method Public Method Check If Single Entity is Blocked 20100806
4 CONFIRM_ENTITY_DATA Instance method Public Method Write Buffer Is Transferred to Chg.Req. (with Derivations) 20110120
5 CREATE_DATA_REFERENCE Instance method Public Method Generate Data References 20100521
6 CREATE_ENTITY_TMP_KEY Instance method Public Method Generate Temporary Entity Key 20101109
7 DELETE_ENTITY Instance method Public Method Delete Entity Data (from Change Request) 20100521
8 DEQUEUE_ENTITY Instance method Public Method Unblock Entity 20100521
9 DEQUEUE_ENTITY_ALL Instance method Public Method Dequeues All Enqueued Entities (Buffer!) 20110715
10 ENQUEUE_ENTITY Instance method Public Method Block Entity 20100521
11 EXCHANGE_ENTITY_KEY Instance method Public Method Exchange of Semantic Key 20100521
12 GET_DERIVE_ENTITY_RESULT Instance method Public Method Execute derive entity returning the result w/o writing 20130619
13 GET_ENTITY_FIELD_PROPERTIES Instance method Public Method Field Properties of the Attributes of an Entity 20101203
14 IS_NEW_ENTITY Instance method Public Method New Entity (Exists Inactively Only / in Change Request)? 20100604
15 IS_TMP_KEY Instance method Public Method Temporary Key? 20100604
16 QUERY_ENTITY Instance method Public Method Query 20130313
17 READ_ENTITY Instance method Public Method Read Entity Data (Active Data or from Change Request) 20100521
18 READ_OBSOLETE_ENTITY Instance method Public Method Obsolete Entitätsdaten lesen (Änderungsantrag) 20111109
19 RETRIEVE_ENTITY Instance method Public Method Read Entity Data (Active Data or from Change Request) 20110131
20 WRITE_ENTITY Instance method Public Method Write Entity Data (in Change Request) 20100521
Events
Interface IF_USMD_GOV_API_ENTITY has no event.
Types
Interface IF_USMD_GOV_API_ENTITY has no local type.
Method Signatures

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_DATA Call by reference Type reference (TYPE) ANY TABLE Muss Entitätsschlüssel enthalten 20100617
3 Importing IV_ACTION Call by reference Type reference (TYPE) ACTIV_AUTH Aktivität 20100521
4 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätsname 20100602
5 Exporting RT_AUTHORIZED Call by reference Type reference (TYPE) ANY TABLE Entitätstypen mit Berechtigungen 20101105
# Exception Resumable Description Created on
1 CX_USMD_GOV_API_CORE_ERROR CX_USMD_CORE_DYNAMIC_CHECK 20101021
2 CX_USMD_GOV_API_ENTITY_AUTH RESUMABLE Keine Berechtigung für eine Entität 20101213

Method CHECK_ENTITY_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_KEY Call by reference Type reference (TYPE) USMD_TS_ENTITY_DATA Zu prüfende Entitäten 20100915
2 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20100915
# 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 CHECK_ENTITY_LOCK_SINGLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DATA Call by reference Type reference (TYPE) ANY Muss Entitässchlüssel enthalten 20100806
2 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20100812
3 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20100806
4 Returning RV_ENTITY_LOCKED Value transfer Type reference (TYPE) BOOLEAN Entität gesperrt (X=true, space=false) 20101105

Method CHECK_ENTITY_LOCK_SINGLE on Interface IF_USMD_GOV_API_ENTITY has no exception.

Method CONFIRM_ENTITY_DATA Signature

Method CONFIRM_ENTITY_DATA on Interface IF_USMD_GOV_API_ENTITY has no parameter.
# Exception Resumable Description Created on
1 CX_USMD_GOV_API_CORE_ERROR CX_USMD_CORE_DYNAMIC_CHECK 20110120

Method CREATE_DATA_REFERENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ER_STRUCTURE Call by reference Object reference (TYPE REF TO) DATA Struktur 20100617
2 Exporting ER_TABLE Call by reference Object reference (TYPE REF TO) DATA Sortierte Tabelle (eindeutiger Schlüssel) 20100617
3 Importing IT_ATTRIBUTE Call by reference Type reference (TYPE) USMD_TS_FIELD Menge der zurückzuliefernden Attribute, falls gewünscht 20100819
4 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20100602
5 Importing IV_STRUCT Call by reference Type reference (TYPE) USMD_STRUCT GC_STRUCT_KEY Art der Datenstruktur 20100621
# Exception Resumable Description Created on
1 CX_USMD_GOV_API Allgemeiner Verarbeitungsfehler GOV_API 20101110

Method CREATE_ENTITY_TMP_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_KEY Call by reference Type reference (TYPE) ANY Entitätsschlüssel 20101109
2 Importing IV_ENTITY Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20101109

Method CREATE_ENTITY_TMP_KEY on Interface IF_USMD_GOV_API_ENTITY has no exception.

Method DELETE_ENTITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_DATA Call by reference Type reference (TYPE) ANY TABLE Muss Entitätsschlüssel enthalten 20100622
2 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20100604
3 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20100604
4 Importing IV_STRUCT Call by reference Type reference (TYPE) USMD_STRUCT GC_STRUCT_KEY Art der Datenstruktur 20101208
# 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_DEL RESUMABLE Fehler beim Löschen einer Entität 20101209

Method DEQUEUE_ENTITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_DATA Call by reference Type reference (TYPE) ANY TABLE Muss Entitätsschlüssel enthalten 20100617
2 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20100812
3 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entität 20100604
4 Importing IV_LOCK_MODE Call by reference Type reference (TYPE) ENQMODE 'E' Sperrmodus 20100621
5 Importing IV_SCOPE Call by reference Type reference (TYPE) CHAR1 '1' Sperrverhalten 20100621
# Exception Resumable Description Created on
1 CX_USMD_GOV_API Allgemeiner Verarbeitungsfehler GOV_API 20101110

Method DEQUEUE_ENTITY_ALL Signature

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

Method ENQUEUE_ENTITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_LOCKED Value transfer Type reference (TYPE) ANY TABLE Gesperrte Entitäten 20101105
2 Importing IT_DATA Call by reference Type reference (TYPE) ANY TABLE Muss Entitässchlüssel enthalten 20100617
3 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20100812
4 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp Verwendungsart 1 20100602
5 Importing IV_LOCK_MODE Call by reference Type reference (TYPE) ENQMODE 'E' Sperrmodus 20100602
6 Importing IV_SCOPE Call by reference Type reference (TYPE) CHAR1 '1' Sperrverhalten 20100621
# 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 RESUMABLE Fehler beim Sperren einer Entität 20101116

Method EXCHANGE_ENTITY_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_ENTITY_KEY_NEW Value transfer Type reference (TYPE) DATA Neuer Entitätsschlüssel 20110310
2 Importing IS_ENTITY_KEY_NEW Call by reference Type reference (TYPE) DATA Neuer Entitätsschlüssel 20100622
3 Importing IS_ENTITY_KEY_OLD Call by reference Type reference (TYPE) DATA Aktueller Entitätsschlüssel 20100622
4 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20110112
5 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20100604
# 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 Value transfer 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_GOV_API_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 Feldeigenschaften der Entität 20101217
2 Importing IT_DATA Call by reference Type reference (TYPE) ANY TABLE Entitätsschlüssel und Entitätsdaten 20101203
3 Importing IV_ACTION Call by reference Type reference (TYPE) ACTIV_AUTH Aktivität 20101203
4 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20101203
5 Importing IV_CREQUEST_TYPE Call by reference Type reference (TYPE) USMD_CREQUEST_TYPE Typ des Änderungsantrags 20101203
6 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20101203
7 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
8 Importing IV_WF_STEP Call by reference Type reference (TYPE) USMD_CREQUEST_APPSTEP Workflow-Schrittnummer 20110408
9 Importing IV_WI_ID Call by reference Type reference (TYPE) SWW_WIID Workitem-Kennung 20110324
# Exception Resumable Description Created on
1 CX_USMD_GOV_API General Processing Error GOV_API 20120417

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) DATA Entitätsschlüssel 20100622
2 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20100604
3 Returning RV_NEW_ENTITY Value transfer Type reference (TYPE) USMD_FLG Kennzeichen: Entität nur im Staging / Change Request 20101105

Method IS_NEW_ENTITY on Interface IF_USMD_GOV_API_ENTITY has no exception.

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) DATA Entitätsschlüssel 20100622
2 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20100604
3 Returning RV_TMP_KEY Value transfer Type reference (TYPE) USMD_FLG Kennzeichen: temporärer Schlüssel 20101105

Method IS_TMP_KEY on Interface IF_USMD_GOV_API_ENTITY has no exception.

Method QUERY_ENTITY 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 Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) ANY TABLE Entitätsschlüssel und Attribute 20101105
2 Importing IF_ACTIVE_DATA Call by reference Type reference (TYPE) USMD_FLG ' ' Kennzeichen: Nur aktive Daten lesen 20100630
3 Importing IF_EDITION_LOGIC Call by reference Type reference (TYPE) USMD_FLG Kennzeichen: Editionslogik verwenden 20100722
4 Importing IT_KEY Call by reference Type reference (TYPE) ANY TABLE Entitätsschlüssel der Verwendungsart 1 20100617
5 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20100604
6 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20100602
# 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 Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) ANY TABLE Entitätsschlüssel und Attribute 20111109
2 Importing IT_KEY Call by reference Type reference (TYPE) ANY TABLE Entitätsschlüssel der Verwendungsart 1 20111109
3 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20111109
4 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 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 RETRIEVE_ENTITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) ANY TABLE Entitätsschlüssel und Attribute 20110131
2 Importing IF_ACTIVE_DATA Call by reference Type reference (TYPE) USMD_FLG ' ' Nur aktive Daten Lesen (Kennzeichen) 20111109
3 Importing IT_KEY Call by reference Type reference (TYPE) ANY TABLE Entitätsschlüssel der Verwendungsart 1 20110131
4 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20111109
5 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20110131
# Exception Resumable Description Created on
1 CX_USMD_GOV_API Allgemeiner Verarbeitungsfehler GOV_API 20110131
2 CX_USMD_GOV_API_CORE_ERROR CX_USMD_CORE_DYNAMIC_CHECK 20110131

Method WRITE_ENTITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ATTRIBUTE Call by reference Type reference (TYPE) USMD_TS_FIELDNAME Liste der Feldnamen mit geänderten Daten 20110111
2 Importing IT_DATA Call by reference Type reference (TYPE) ANY TABLE Entitätsschlüssel und Attribute 20100622
3 Importing IV_CREQUEST_ID Call by reference Type reference (TYPE) USMD_CREQUEST Änderungsantrag 20100602
4 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) USMD_ENTITY Entitätstyp 20100701
# 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 20101213
History
Last changed by/on SAP  20131127 
SAP Release Created in 703