SAP ABAP Interface /IWBEP/IF_MGW_ODATA_MODEL (Interface for a Script-Based Model)
Hierarchy
☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-BSE-SDE (Application Component) Gateway SAP Data Enablement
     ⤷ /IWBEP/MGW_MED_API (Package) OData Channel - Metadata - API
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface composition (i COMPRISING i_ref)  /IWBEP/IF_MGW_ODATA_FW_MODEL OData Model FPI 20110624
2 Interface implementation (CLASS c. INTERFACES i_ref)  /IWBEP/CL_MGW_ODATA_MODEL implementation of odata meta data model 20110404
Properties
Interface /IWBEP/IF_MGW_ODATA_MODEL  
Short Description Interface for a Script-Based Model    
General Data
Package /IWBEP/MGW_MED_API   OData Channel - Metadata - API 
Created 20110206   SAP 
Last changed 20141120    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 /IWBEP/IF_MGW_MED_ODATA_TYPES Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
2 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Interface /IWBEP/IF_MGW_ODATA_MODEL has no interface.
Friends
Interface /IWBEP/IF_MGW_ODATA_MODEL has no friend.
Attributes
Interface /IWBEP/IF_MGW_ODATA_MODEL has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 CALCULATE_EXTERNAL_ENTITY_ID Instance method Public Method Calculate the Entity ID of an included external Entity 20111212
2 CREATE_ACTION Instance method Public Method Creates an OData function import/action 20110307
3 CREATE_ASSOCIATION Instance method Public Method Creates an association between two Entity Types 20110223
4 CREATE_ASSOCIATION_SET Instance method Public Method Creates an association set between two Entity Sets 20110902
5 CREATE_COMPLEX_TYPE Instance method Public Method Creates a reusable OData complex type 20110215
6 CREATE_ENTITY_TYPE Instance method Public Method Creates a Data Object / an OData Entity Type 20110329
7 CREATE_TAG Instance method Public Method Creates a Service Tag (Keyword) 20130116
8 EXTEND_MODEL Instance method Public Method extends a Gateway ODC Model using the Model ID 20120221
9 GET_ACTION Instance method Public Method Returns an OData function import/action 20110307
10 GET_ASSOCIATION Instance method Public Method Returns an association between two Entity Types 20110309
11 GET_ASSOCIATION_SET Instance method Public Method Returns association set 20120523
12 GET_COMPLEX_TYPE Instance method Public Method Returns a reusable ODdata complex type 20110215
13 GET_ENTITY_SET Instance method Public Method Returns entity set 20120521
14 GET_ENTITY_TYPE Instance method Public Method Returns a Data Object / an OData Entity Type 20110415
15 GET_NO_CONVERSION Instance method Public Method gets the flag if conversions are executed on the model 20110725
16 INCLUDE_MODEL_BY_MAPPING_ID Instance method Public Method Include any Gateway Model using the External Mapping ID 20111027
17 INCLUDE_MODEL_BY_NAME Instance method Public Method Include a Gateway ODC Model using the Service & Model Name 20120323
18 INCLUDE_MODEL_BY_SERVICE_ID Instance method Public Method Include a Gateway ODC Model using the Service & Model ID 20111027
19 SET_NO_CONVERSION Instance method Public Method sets a flag so that conversions are not executed on the mdl 20110725
20 SET_SCHEMA_NAMESPACE Instance method Public Method Sets a fixed value for the schema namespace for model 20130802
21 SET_SERVICE_SCHEMA_VERSION Instance method Public Method Sets a fixed value for the service schema version 20140213
22 SET_SOFT_STATE_ENABLED Instance method Public Method Sets the flag if the DPC has implemented the soft-state intf 20140305
23 SET_USE_BATCH Instance method Public Method Sets a flag if use of batch is recommended 20130904
Events
Interface /IWBEP/IF_MGW_ODATA_MODEL has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 S Public Type reference (TYPE) CHAR1 Single-Character Indicator 20110206
Method Signatures

Method CALCULATE_EXTERNAL_ENTITY_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME 20111212
2 Returning R_ENTITY_ID Value transfer Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_ID 20111212
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION Meta data exception 20111212

Method CREATE_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ACTION_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME Name of the action as it will be shown in the service 20110309
2 Returning RO_ACTION Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_ACTION Returns an instance of an action to do futher changes 20110309
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20110307

Method CREATE_ASSOCIATION 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) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME name of the association 20110223
2 Importing IV_DEF_ASSOC_SET Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE if the default association set should be created 20110908
3 Importing IV_LEFT_CARD Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_CARDINALITY cardinality of the rifht entity 20110408
4 Importing IV_LEFT_TYPE Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME name of the left entity 20110408
5 Importing IV_RIGHT_CARD Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_CARDINALITY cardinality of the left entity 20110408
6 Importing IV_RIGHT_TYPE Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME name of the left entity 20110408
7 Returning RO_ASSOCIATION Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_ASSOC 20110223
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20110223

Method CREATE_ASSOCIATION_SET 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) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME 20110907
2 Importing IV_ASSOCIATION_SET_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME 20110902
3 Importing IV_LEFT_ENTITY_SET_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME 20110902
4 Importing IV_RIGHT_ENTITY_SET_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME 20110902
5 Returning RO_ASSOCIATION_SET Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_ASSOC_SET interface representing a script based odata association set 20110902
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20110902

Method CREATE_COMPLEX_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CPLX_TYPE_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME Name of the complex type 20110215
2 Returning RO_COMPLEX_TYPE Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_CMPLX_TYPE Returns the metadata instance for the new complex type 20110215
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20110215

Method CREATE_ENTITY_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DEF_ENTITY_SET Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE f the default entity set should be created 20110908
2 Importing IV_ENTITY_TYPE_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME Name of the new Data Object 20110329
3 Returning RO_ENTITY Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_ENTITY_TYP Instance of the metadata representation of a Data Object 20110329
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20110329

Method CREATE_TAG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TAG_ID Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_ID Tag as it will be shown in the service - same as the Tag ID 20130116
2 Returning RO_TAG Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_TAG Returns the instance of the newly created Service Tag 20130116
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20130116

Method EXTEND_MODEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MODEL_NAME Call by reference Type reference (TYPE) /IWBEP/MED_MDL_TECHNICAL_NAME 20120223
2 Importing IV_MODEL_VERSION Call by reference Type reference (TYPE) /IWBEP/MED_MDL_VERSION '0001' Model Version 20120221
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20120223

Method GET_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ACTION_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME Name of the action which shall be returned 20110309
2 Returning RO_ACTION Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_ACTION Returns the action instance for the name 20110309
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20110307

Method GET_ASSOCIATION 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) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME 20110309
2 Returning RO_ASSOCIATION Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_ASSOC 20110309
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20110309

Method GET_ASSOCIATION_SET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ASSOC_SET_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME 20120523
2 Returning RO_ASSOC_SET Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_ASSOC_SET interface representing a script based odata association set 20120523

Method GET_ASSOCIATION_SET on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method GET_COMPLEX_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CPLX_TYPE_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME Name of the complex type which shall be returned 20110215
2 Returning RO_COMPLEX_TYPE Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_CMPLX_TYPE Instance of the metadata representation for the type 20110215
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20110215

Method GET_ENTITY_SET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ENTITY_SET_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME 20120521
2 Returning RO_ENTITY_SET Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_ENTITY_SET interface representing a script based odata entity set 20120521

Method GET_ENTITY_SET on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method GET_ENTITY_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ENTITY_NAME Call by reference Type reference (TYPE) /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME 20110415
2 Returning RO_ENTITY_TYPE Value transfer Object reference (TYPE REF TO) /IWBEP/IF_MGW_ODATA_ENTITY_TYP 20110415
# Exception Resumable Description Created on
1 /IWBEP/CX_MGW_MED_EXCEPTION 20110415

Method GET_NO_CONVERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_NO_CONVERSION Value transfer Type reference (TYPE) ABAP_BOOL 20110725

Method GET_NO_CONVERSION on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method INCLUDE_MODEL_BY_MAPPING_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_EXTERNAL_MAPPING_ID Call by reference Type reference (TYPE) /IWBEP/MED_EXTERNAL_MAPPING_ID External Mapping ID 20111027

Method INCLUDE_MODEL_BY_MAPPING_ID on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method INCLUDE_MODEL_BY_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MODEL_TECH_NAME Call by reference Type reference (TYPE) /IWBEP/MED_MDL_TECHNICAL_NAME the technical model name 20120323
2 Importing IV_MODEL_VERSION Call by reference Type reference (TYPE) /IWBEP/MED_MDL_VERSION '0001' Model Version 20120323
3 Importing IV_SERVICE_EXTERNAL_NAME Call by reference Type reference (TYPE) /IWBEP/MED_GRP_TECHNICAL_NAME the optional external Service name 20120323
4 Importing IV_SERVICE_VERSION Call by reference Type reference (TYPE) /IWBEP/MED_GRP_VERSION '0001' Service Version 20120323

Method INCLUDE_MODEL_BY_NAME on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method INCLUDE_MODEL_BY_SERVICE_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MODEL_IDENTIFIER Call by reference Type reference (TYPE) /IWBEP/MED_MDL_TECHNICAL_NAME Model Identifier 20111027
2 Importing IV_MODEL_VERSION Call by reference Type reference (TYPE) /IWBEP/MED_MDL_VERSION '0001' Model Version 20111027
3 Importing IV_SERVICE_IDENTIFIER Call by reference Type reference (TYPE) /IWBEP/MED_GRP_TECHNICAL_NAME Service Identifier 20111027
4 Importing IV_SERVICE_VERSION Call by reference Type reference (TYPE) /IWBEP/MED_GRP_VERSION '0001' Service Version 20111027

Method INCLUDE_MODEL_BY_SERVICE_ID on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method SET_NO_CONVERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NO_CONVERSION Call by reference Type reference (TYPE) ABAP_BOOL 20110725

Method SET_NO_CONVERSION on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method SET_SCHEMA_NAMESPACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAMESPACE Call by reference Type reference (TYPE) STRING 20130802

Method SET_SCHEMA_NAMESPACE on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method SET_SERVICE_SCHEMA_VERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SERVICE_SCHEMA_VERSION Call by reference Type reference (TYPE) /IWBEP/MED_SRV_SCHEMA_VERSION Service Version 20140213

Method SET_SERVICE_SCHEMA_VERSION on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method SET_SOFT_STATE_ENABLED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SOFT_STATE_ENABLED Call by reference Type reference (TYPE) ABAP_BOOL 20140305

Method SET_SOFT_STATE_ENABLED on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.

Method SET_USE_BATCH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_USE_BATCH Call by reference Type reference (TYPE) ABAP_BOOL 20130904

Method SET_USE_BATCH on Interface /IWBEP/IF_MGW_ODATA_MODEL has no exception.
History
Last changed by/on SAP  20141120 
SAP Release Created in 200