SAP ABAP Interface IF_SADL_ENTITY (d)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ESI-ESF-BSA (Application Component) Business Service Adaptation
     ⤷ SADL_ENTITY (Package) SADL Entity Metamodel
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_SADL_ENTITY CL_SADL_ENTITY Default Implementation of SADL Entity Model 20120707
Properties
Interface IF_SADL_ENTITY  
Short Description d    
General Data
Package SADL_ENTITY   SADL Entity Metamodel 
Created 20120707   SAP 
Last changed 20140121   SAP 
Unicode checks active    
Forward declarations
Interface IF_SADL_ENTITY has no forward declaration.
Interfaces
Interface IF_SADL_ENTITY has no interface.
Friends
Interface IF_SADL_ENTITY has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_AUTH_PREFIX Constant Public See coding '$auth$' 20130521
2 CO_CARDINALITY Constant Public See coding 20120814
3 CO_COMPONENT_SEPARATOR Constant Public Type reference (TYPE) C '-' 20120707
4 CO_JOIN_CONDITION_TYPE Constant Public See coding 20120707
5 CO_SYSTEM_VARIABLES Constant Public See coding 20120707
6 CO_UNIT_TYPE Constant Public See coding 20121022
Methods
# Method Level Visibility Method type Description Created on
1 GET_ACCESS_CONTROL_FIELDS Instance method Public Method 20130116
2 GET_ACTION Instance method Public Method 20120707
3 GET_ACTIONS Instance method Public Method 20120707
4 GET_ALTERNATIVE_KEY Instance method Public Method 20130903
5 GET_ALTERNATIVE_KEYS Instance method Public Method 20120814
6 GET_ASSOCIATION Instance method Public Method 20120707
7 GET_ASSOCIATIONS Instance method Public Method 20120707
8 GET_ASSOCIATION_TARGET Instance method Public Method 20120707
9 GET_CHECKSUM Instance method Public Method 20120822
10 GET_DB_INFO Instance method Public Method 20120707
11 GET_DESCRIPTION Instance method Public Method 20130612
12 GET_ELEMENT Instance method Public Method 20120707
13 GET_ELEMENTS Instance method Public Method 20120707
14 GET_ID Instance method Public Method 20120707
15 GET_KEY_ELEMENTS Instance method Public Method 20130903
16 GET_PRIMARY_KEY_ELEMENTS Instance method Public Method 20120707
17 GET_QUERIES Instance method Public Method 20120707
18 GET_QUERY Instance method Public Method 20120707
19 GET_ROW_TYPE_NAME Instance method Public Method 20130405
20 GET_TYPE Instance method Public Method 20120707
21 GET_UI_TEXTS Instance method Public Method 20130826
22 GET_UI_TEXTS_FOR_ELEMENT Instance method Public Method 20130826
23 HAS_ACTION Instance method Public Method 20120707
24 HAS_ASSOCIATION Instance method Public Method 20120707
25 HAS_ELEMENT Instance method Public Method 20120707
26 HAS_QUERY Instance method Public Method 20120707
Events
Interface IF_SADL_ENTITY has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TT_ACCESS_CONTROL_FIELDS Public See coding 20130115 tt_access_control_fields TYPE SORTED TABLE OF ty_access_control_field WITH UNIQUE KEY path
2 TT_ACTIONS Public See coding 20120707 tt_actions TYPE SORTED TABLE OF ty_action WITH UNIQUE KEY name
3 TT_ALTERNATIVE_KEYS Public See coding 20120814 tt_alternative_keys TYPE SORTED TABLE OF ty_alternative_key WITH UNIQUE KEY name
4 TT_ASSOCIATIONS Public See coding 20120707 tt_associations TYPE SORTED TABLE OF ty_association WITH UNIQUE KEY name
5 TT_ASSOCIATION_PARAMETERS Public See coding 20120822 tt_association_parameters TYPE STANDARD TABLE OF ty_association_parameter WITH DEFAULT KEY
6 TT_ELEMENTS Public See coding 20120707 tt_elements TYPE STANDARD TABLE OF ty_element WITH KEY name
7 TT_ENTITIES Public See coding 20130616 tt_entities TYPE STANDARD TABLE OF sadl_entity_id WITH DEFAULT KEY
8 TT_JOIN_CONDITIONS Public See coding 20120707 tt_join_conditions TYPE STANDARD TABLE OF ty_join_condition WITH DEFAULT KEY
9 TT_QUERIES Public See coding 20120707 tt_queries TYPE SORTED TABLE OF ty_query WITH UNIQUE KEY name
10 TT_UI_TEXTS_BY_ELEMENT_NAMES Public See coding 20130826 tt_ui_texts_by_element_names TYPE SORTED TABLE OF ty_ui_texts_by_element_name WITH UNIQUE KEY element_name
11 TY_ACCESS_CONTROL_FIELD Public See coding 20130115 BEGIN OF ty_access_control_field, "! Name of the access control field, including abql path path TYPE sadl_entity_element, "! Unique id for the access control field id TYPE sadl_entity_element, END OF ty_access_control_field
12 TY_ACTION Public See coding 20120707 BEGIN OF ty_action, "! Name of the action name TYPE sadl_entity_action, "! Description description TYPE sadl_description, END OF ty_action
13 TY_ALTERNATIVE_KEY Public See coding 20120814 BEGIN OF ty_alternative_key, name TYPE ty_key_name, description TYPE sadl_description, elements TYPE stringtab, END OF ty_alternative_key
14 TY_ASSOCIATION Public See coding 20120707 BEGIN OF ty_association, "! Name of the association name TYPE sadl_entity_association, "! Description description TYPE sadl_description, "! An association has always a source and a target entity. The source entity owns the association. The target entity is specified here. target_id TYPE ty_entity_id, "! Join conditions are the implementation of an association. "! Filter conditions are always defined on flat level. join_conditions TYPE tt_join_conditions, "! Association chain in path notation (e.g. ToRoot: 'ToParentToParent' ) association_chain TYPE string, "! A composition is an association with existence relationship (e.g. SalesOrder ~ Item) is_composition TYPE abap_bool, "! Cardinality of target entity instances cardinality TYPE i, "co_cardinality "! Parameter that are bound in the join conditions parameters TYPE tt_association_parameters, END OF ty_association
15 TY_ASSOCIATION_PARAMETER Public See coding 20120822 BEGIN OF ty_association_parameter, name TYPE string, description TYPE sadl_description, END OF ty_association_parameter
16 TY_CONDITION_OPERATOR Public See coding 20120707 ty_condition_operator TYPE c LENGTH 2
17 TY_CONSUMPTION Public Type reference (TYPE) SADL_CONSUMPTION 20130214
18 TY_DESCRIPTION Public Type reference (TYPE) SADL_DESCRIPTION 20130613
19 TY_ELEMENT Public See coding 20120707 BEGIN OF ty_element, "! Name of the element name TYPE sadl_entity_element, "! Description description TYPE sadl_description, ". include type ty_ui_texts. types: "! Name of the database table column of this element db_column_name TYPE string, "! Data type (proxy name) data_type TYPE string, "! Reference Field, e.g. currency / quantity unit_reference_element TYPE sadl_entity_element, "! Type of unit field: co_unit_type unit_type TYPE string, END OF ty_element
20 TY_ENTITY_DB_INFO Public See coding 20120707 BEGIN OF ty_entity_db_info, "! Name of the DDIC artifact artifact_name TYPE string, "! Client field which is used to restrict the result. In case the attribute is initial no restriction will be performed. client_field TYPE string, END OF ty_entity_db_info
21 TY_ENTITY_ID Public Type reference (TYPE) SADL_ENTITY_ID 20120707
22 TY_ENTITY_TYPE Public Type reference (TYPE) SADL_ENTITY_TYPE 20121122
23 TY_JOIN_CONDITION Public See coding 20120707 BEGIN OF ty_join_condition, target_entity_element_name TYPE sadl_entity_element, condition_type TYPE i, " values of co_join_condition_type operator TYPE ty_condition_operator, value TYPE string, " the type of value depends on the condition type; could be a literal, system-variable,... END OF ty_join_condition
24 TY_KEY_NAME Public Type reference (TYPE) STRING 20130822
25 TY_QUERY Public See coding 20120707 BEGIN OF ty_query, "! Name of the query name TYPE sadl_entity_query, "! Description description TYPE sadl_description, END OF ty_query
26 TY_SADL_ENTITY Public See coding 20120814 BEGIN OF ty_sadl_entity, id TYPE ty_entity_id, description TYPE sadl_description, type TYPE ty_entity_type, checksum TYPE string, primary_key TYPE stringtab, row_type_name TYPE string, db_info TYPE if_sadl_entity=>ty_entity_db_info, actions TYPE if_sadl_entity=>tt_actions, queries TYPE if_sadl_entity=>tt_queries, alternative_keys TYPE if_sadl_entity=>tt_alternative_keys, associations TYPE if_sadl_entity=>tt_associations, elements TYPE if_sadl_entity=>tt_elements, ui_texts_by_element_names type if_sadl_entity=>tt_ui_texts_by_element_names, access_control_fields TYPE if_sadl_entity=>tt_access_control_fields, END OF ty_sadl_entity
27 TY_SYSTEM_VARIABLE Public See coding 20120707 ty_system_variable TYPE c LENGTH 1
28 TY_UI_TEXTS Public See coding 20130814 BEGIN OF ty_ui_texts, short TYPE string, " also CDS annotation "label" medium TYPE string, " also CDS annotation "label" long TYPE string, " also CDS annotation "label" tooltip TYPE string, " reptext, also CDS annotation "quickInfo" END OF ty_ui_texts
29 TY_UI_TEXTS_BY_ELEMENT_NAME Public See coding 20130826 BEGIN OF ty_ui_texts_by_element_name, element_name TYPE sadl_entity_element, ui_texts TYPE ty_ui_texts, END OF ty_ui_texts_by_element_name
Method Signatures

Method GET_ACCESS_CONTROL_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ACCESS_CONTROL_FIELDS Call by reference Type reference (TYPE) TT_ACCESS_CONTROL_FIELDS 20130116
2 Exporting EV_MAPPING_NOT_POSSIBLE Call by reference Type reference (TYPE) ABAP_BOOL 20130116

Method GET_ACCESS_CONTROL_FIELDS on Interface IF_SADL_ENTITY has no exception.

Method GET_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) SADL_ENTITY_ACTION 20120707
2 Returning RS_ACTION Value transfer Type reference (TYPE) TY_ACTION 20120707
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20120713

Method GET_ACTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ACTIONS Call by reference Type reference (TYPE) TT_ACTIONS 20120707
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20121206

Method GET_ALTERNATIVE_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_ALT_KEY_WITH_ELEMENTS Call by reference Type reference (TYPE) TY_ALTERNATIVE_KEY 20130903
2 Importing IV_ALTERNATIVE_KEY_NAME Call by reference Type reference (TYPE) TY_KEY_NAME 20130903
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20130903

Method GET_ALTERNATIVE_KEYS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ALT_KEYS_WITH_ELEMENTS Call by reference Type reference (TYPE) TT_ALTERNATIVE_KEYS 20120814

Method GET_ALTERNATIVE_KEYS on Interface IF_SADL_ENTITY has no exception.

Method GET_ASSOCIATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) SADL_ENTITY_ASSOCIATION 20120707
2 Returning RS_ASSOCIATION Value transfer Type reference (TYPE) TY_ASSOCIATION 20120707
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20120713

Method GET_ASSOCIATIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ASSOCIATIONS Call by reference Type reference (TYPE) TT_ASSOCIATIONS 20120707
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20121206

Method GET_ASSOCIATION_TARGET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ASSOCIATION_NAME Call by reference Type reference (TYPE) SADL_ENTITY_ASSOCIATION 20120707
2 Returning RO_ENTITY Value transfer Object reference (TYPE REF TO) IF_SADL_ENTITY 20120707
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20121206
2 CX_SADL_STATIC 20130111

Method GET_CHECKSUM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CHECKSUM Value transfer Type reference (TYPE) STRING 20120822

Method GET_CHECKSUM on Interface IF_SADL_ENTITY has no exception.

Method GET_DB_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_DB_INFO Value transfer Type reference (TYPE) TY_ENTITY_DB_INFO 20120707

Method GET_DB_INFO on Interface IF_SADL_ENTITY has no exception.

Method GET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_DESCRIPTION Value transfer Type reference (TYPE) SADL_DESCRIPTION 20130612

Method GET_DESCRIPTION on Interface IF_SADL_ENTITY has no exception.

Method GET_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) SADL_ENTITY_ELEMENT 20120707
2 Returning RS_ELEMENT Value transfer Type reference (TYPE) TY_ELEMENT 20120707
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20120713

Method GET_ELEMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ELEMENTS Call by reference Type reference (TYPE) TT_ELEMENTS 20120707
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20121206

Method GET_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_ID Value transfer Type reference (TYPE) TY_ENTITY_ID 20120707

Method GET_ID on Interface IF_SADL_ENTITY has no exception.

Method GET_KEY_ELEMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_KEY_ELEMENTS Call by reference Type reference (TYPE) STRINGTAB 20130903
2 Importing IV_ALTERNATIVE_KEY_NAME Call by reference Type reference (TYPE) TY_KEY_NAME 20130903

Method GET_KEY_ELEMENTS on Interface IF_SADL_ENTITY has no exception.

Method GET_PRIMARY_KEY_ELEMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_PRIMARY_KEY_ELEMENTS Call by reference Type reference (TYPE) STRINGTAB 20120707

Method GET_PRIMARY_KEY_ELEMENTS on Interface IF_SADL_ENTITY has no exception.

Method GET_QUERIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_QUERIES Call by reference Type reference (TYPE) TT_QUERIES 20120707
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20121206

Method GET_QUERY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) SADL_ENTITY_QUERY 20120707
2 Returning RS_QUERY Value transfer Type reference (TYPE) TY_QUERY 20120707
# Exception Resumable Description Created on
1 CX_SADL_ENTITY 20120713

Method GET_ROW_TYPE_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_ROW_TYPE_NAME Value transfer Type reference (TYPE) STRING 20130414

Method GET_ROW_TYPE_NAME on Interface IF_SADL_ENTITY has no exception.

Method GET_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_TYPE Value transfer Type reference (TYPE) IF_SADL_ENTITY=>TY_ENTITY_TYPE 20120707

Method GET_TYPE on Interface IF_SADL_ENTITY has no exception.

Method GET_UI_TEXTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_UI_TEXTS_BY_ELEMENT_NAMES Call by reference Type reference (TYPE) TT_UI_TEXTS_BY_ELEMENT_NAMES 20130826

Method GET_UI_TEXTS on Interface IF_SADL_ENTITY has no exception.

Method GET_UI_TEXTS_FOR_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_UI_TEXTS Call by reference Type reference (TYPE) TY_UI_TEXTS 20130826
2 Importing IV_ELEMENT Call by reference Type reference (TYPE) SADL_ENTITY_ELEMENT 20130826

Method GET_UI_TEXTS_FOR_ELEMENT on Interface IF_SADL_ENTITY has no exception.

Method HAS_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) SADL_ENTITY_ACTION 20120707
2 Returning RV_HAS_ACTION Value transfer Type reference (TYPE) ABAP_BOOL 20120707

Method HAS_ACTION on Interface IF_SADL_ENTITY has no exception.

Method HAS_ASSOCIATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) SADL_ENTITY_ASSOCIATION 20120707
2 Returning RV_HAS_ASSOCIATION Value transfer Type reference (TYPE) ABAP_BOOL 20120707

Method HAS_ASSOCIATION on Interface IF_SADL_ENTITY has no exception.

Method HAS_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) SADL_ENTITY_ELEMENT 20120707
2 Returning RV_HAS_ELEMENT Value transfer Type reference (TYPE) ABAP_BOOL 20120707

Method HAS_ELEMENT on Interface IF_SADL_ENTITY has no exception.

Method HAS_QUERY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) SADL_ENTITY_QUERY 20120707
2 Returning RV_HAS_QUERY Value transfer Type reference (TYPE) ABAP_BOOL 20120707

Method HAS_QUERY on Interface IF_SADL_ENTITY has no exception.
History
Last changed by/on SAP  20140121 
SAP Release Created in 740