Show TOC

/IWBEP/IF_MGW_REQ_ENTITY_DLocate this document in the navigation structure

Use

This Interface is developed to provide all request information relevant for entity DELETE operation. All artifacts are returned in a technical format meaning with their technical naming.

Methods

Method GET_ENTITY_TYPE_NAME

This method is used to return the technical name of the target entity type.

Parameter

Description

RV_ENTITY_TYPE

This parameter of the type /IWBEP/IF_MGW_CORE_SRV_RUNTIME=>TY_E_TECHNICAL_NAME is used to return the technical name of the target entity type.

Method GET_ENTITY_SET_NAME

This method is used to return the technical name of target the entity set.

Parameter

Description

RV_ENTITY_SET

This parameter of the type /IWBEP/IF_MGW_CORE_SRV_RUNTIME=>TY_E_TECHNICAL_NAME is used to return the technical name of the target entity set.

Method GET_KEYS

This method is to be used when the entity is called directly: Source entity type and target entity type are the same. This method returns a table of keys for the requested entity. The returned key values are not converted even if they are defined in the model provider class as convertible. Use the new method GET_CONVERTED_KEYS to get the key values converted automatically.

Parameter

Description

RT_KEYS

This parameter of the type /IWBEP/IF_MGW_CORE_SRV_RUNTIME=>TY_E_TECHNICAL_PAIR is used to return the table of the target entity keys.

Method GET_CONVERTED_KEYS

This method is to be used when the entity is called directly: Source entity type and target entity type are the same.

ES_KEY_VALUES must be a structure which contains all defined keys including the reference fields for currency or quantity if necessary (that is, key value is an amount).

Data of type “Entity Return Structure” can be used because it already contains all keys and reference fields.

If a convertible field is used as key and the reference field for currency or quantity is needed, the reference field must also be defined as key. Otherwise, the returned key value cannot be converted and remains unchanged.

If a key field is missing in structure ES_KEY_VALUES the key value will not be provided to the provider application.

If one or more keys are defined in the model provider class as not convertible the returned key values are not converted. Therefore, this method can be used in general instead of GET_KEYS.

Parameter

Description

ES_KEY_VALUES

Type DATA

Method GET_CONDITIONAL_INFO

This method returns conditional/ETag information provided within the OData request.

The return type structure /IWBEP/IF_MGW_APPL_TYPES=>TY_S_CONDITIONS is defined as follows:

  • IF_MATCH - contains the list of If-Match tags defined as the structure type /IWBEP/IF_MGW_APPL_TYPES=>TY_S_E.

  • IF_NONE_MATCH - contains the list of If-None-Match tags as of the structure type /IWBEP/IF_MGW_APPL_TYPES=>TY_S_ETAG.

The method is to be used if the conditional/ETag handling needs to be done by application and not by the SAP Gateway framework.

The prerequisite to override any framework implementation is the implementation of the interface method /IWBEP/IF_MGW_APPL_SRV_RUNTIME~GET_IS_CONDITIONAL_IMPLEMENTED.

Parameter

Description

ES_CONDITIONS

Type /IWBEP/IF_MGW_APPL_TYPES=>TY_S_CONDITIONS.