SAP ABAP Interface /IWBEP/IF_V4_RESPONSE_INFO (V4 Response Information)
Hierarchy
☛
IW_BEP (Software Component)
⤷
OPU-BSE-BEP (Application Component) Gateway Business Eventing and Provisioning
⤷
/IWBEP/V4_RUNTIME (Package) OData Channel V4 - Runtime
IW_BEP (Software Component) ⤷
OPU-BSE-BEP (Application Component) Gateway Business Eventing and Provisioning⤷
/IWBEP/V4_RUNTIME (Package) OData Channel V4 - Runtime
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /IWBEP/CL_V4_RESPONSE_INFO | V4 Response information | 20131206 |
Properties
| Interface | /IWBEP/IF_V4_RESPONSE_INFO | |
| Short Description | V4 Response Information |
General Data
| Package | /IWBEP/V4_RUNTIME | OData Channel V4 - Runtime |
| Created | 20110203 | SAP |
| Last changed | 20141120 | |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | /IWBEP/CL_MGW_UTIL_VERSIONS | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | /IWBEP/IF_MGW_CORE_SRV_RUNTIME | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface /IWBEP/IF_V4_RESPONSE_INFO has no interface.
Friends
Interface /IWBEP/IF_V4_RESPONSE_INFO has no friend.
Attributes
Interface /IWBEP/IF_V4_RESPONSE_INFO has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | IF_MESS_CONT_ADD_MESSAGE |
Instance method | Public | Method | Placeholder: DPCs add messages to the Response Info directly | 20140117 |
| 2 | SET_BUSI_DATA |
Instance method | Public | Method | Set the business data (e.g. Entity Set) | 20131210 |
| 3 | SET_EXCEPTION_INFO |
Instance method | Public | Method | Set the exception (e.g. triggered by the application) info | 20131217 |
| 4 | SET_HTTP_HEADERS |
Instance method | Public | Method | Set a list of http headers to be added to the response | 20140211 |
| 5 | SET_MESSAGES |
Instance method | Public | Method | Set the list of messages (from the message container class) | 20131217 |
| 6 | SET_PERFORMANCE_TRACES |
Instance method | Public | Method | Set the list of performance trace entries | 20140127 |
| 7 | SET_RESPONSE_META_INFO |
Instance method | Public | Method | Set the response meta info (e.g. COUNT, LAST_MODIFIED) | 20140211 |
| 8 | TO_STRING |
Instance method | Public | Method | Get the xString representation of the response info object | 20131210 |
Events
Interface /IWBEP/IF_V4_RESPONSE_INFO has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | RESPONSE_INFO_S | Public | See coding | All response relevant information | 20131206 | BEGIN OF response_info_s,
meta_info TYPE ty_s_response_meta_info,
exception TYPE ty_s_exception,
messages TYPE ty_t_messages,
perf_traces TYPE ty_t_perf_traces,
http_headers TYPE tihttpnvp,
* backend_version TYPE ty_s_bep_system_info,
END OF response_info_s
|
|
| 2 | TY_S_EXCEPTION | Public | See coding | Exception that was e.g. triggered by the application | 20131217 | BEGIN OF ty_s_exception,
exception_category TYPE /iwbep/sup_exception_category, " Exception Category (e.g. "Business Exception") see /IWBEP/IF_MESSAGE_CONTAINER=>gcs_exception_category
http_code TYPE /iwbep/mgw_http_status_code, " http status code (e.g. 403)
sap_note_id TYPE /iwbep/mgw_sap_note_id, " SAP Note number set in the exception
message_class TYPE symsgid, " Message Class
message_number TYPE symsgno, " Message Number
text TYPE string,
END OF ty_s_exception
|
|
| 3 | TY_S_MESSAGE | Public | See coding | Message | 20131217 | BEGIN OF ty_s_message,
message_class TYPE symsgid, " Message Class
message_number TYPE symsgno, " Message Number
message_code TYPE string, " Alternative for MESSAGE_CLASS and MESSAGE_NUMBER if they are not available (e.g. Exception Class)
message_type TYPE bapi_mtype, " Message type (Severity): S Success, E Error, W Warning, I Info, A Abort
text TYPE string,
target TYPE string, " Message target, e.g. the property this message referres to
is_leading_message TYPE abap_bool, " Indicates the "Leading message"
is_for_response_header TYPE abap_bool, " Relevant for client if there is no error response. (Returned in the http header "sap-message")
END OF ty_s_message
|
|
| 4 | TY_S_PERF_TRACE | Public | See coding | Performance Trace Entry | 20140127 | BEGIN OF ty_s_perf_trace,
time_start TYPE int4,
time_stop TYPE int4,
source_class TYPE seoclname,
source_method TYPE seomtdname,
ncalls TYPE int4,
levelno TYPE int4,
packetno TYPE int4,
END OF ty_s_perf_trace
|
|
| 5 | TY_S_RESPONSE_META_INFO | Public | See coding | Meta information of the response (e.g. COUNT, LAST_MODIFIED) | 20131211 | BEGIN OF ty_s_response_meta_info,
count TYPE string,
inlinecount TYPE string,
skiptoken TYPE string,
deltatoken TYPE string,
* expand_skiptokens TYPE string_table,
last_modified TYPE tzntstmps,
max_age TYPE int4,
is_not_modified TYPE /iwbep/mgw_is_not_modified, "constants: GC_IS_NOT_MODIFIED / GC_IS_MODIFIED / GC_MOD_IS_UNDEFINED
do_not_cache_on_client TYPE /iwbep/mgw_do_not_cache_on_cnt, "constants: GGC_DO_NOT_CACHE / GC_CAN_BE_CACHED
END OF ty_s_response_meta_info
|
|
| 6 | TY_T_MESSAGES | Public | See coding | List of messages (from the message container class) | 20131217 | ty_t_messages TYPE TABLE OF ty_s_message WITH DEFAULT KEY
|
|
| 7 | TY_T_PERF_TRACES | Public | See coding | List of performance trace entries | 20140127 | ty_t_perf_traces TYPE TABLE OF ty_s_perf_trace WITH DEFAULT KEY
|
Method Signatures
Method IF_MESS_CONT_ADD_MESSAGE Signature
Method IF_MESS_CONT_ADD_MESSAGE on Interface /IWBEP/IF_V4_RESPONSE_INFO has no parameter.
Method IF_MESS_CONT_ADD_MESSAGE on Interface /IWBEP/IF_V4_RESPONSE_INFO has no exception.
Method SET_BUSI_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IR_BUSI_DATA | Call by reference | Object reference (TYPE REF TO) | DATA | Business Data (e.g. Entity Set) | 20131210 |
Method SET_BUSI_DATA on Interface /IWBEP/IF_V4_RESPONSE_INFO has no exception.
Method SET_EXCEPTION_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_EXCEPTION_INFO | Call by reference | Type reference (TYPE) | TY_S_EXCEPTION | Exception that was e.g. triggered by the application | 20131217 |
Method SET_EXCEPTION_INFO on Interface /IWBEP/IF_V4_RESPONSE_INFO has no exception.
Method SET_HTTP_HEADERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_HTTP_HEADERS | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20140211 |
Method SET_HTTP_HEADERS on Interface /IWBEP/IF_V4_RESPONSE_INFO has no exception.
Method SET_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_MESSAGES | Call by reference | Type reference (TYPE) | TY_T_MESSAGES | List of messages (from the message container class) | 20131217 |
Method SET_MESSAGES on Interface /IWBEP/IF_V4_RESPONSE_INFO has no exception.
Method SET_PERFORMANCE_TRACES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_PERFORMANCE_TRACES | Call by reference | Type reference (TYPE) | TY_T_PERF_TRACES | 20140127 |
Method SET_PERFORMANCE_TRACES on Interface /IWBEP/IF_V4_RESPONSE_INFO has no exception.
Method SET_RESPONSE_META_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_RESPONSE_META_INFO | Call by reference | Type reference (TYPE) | TY_S_RESPONSE_META_INFO | Meta information of the response (e.g. COUNT, LAST_MODIFIED) | 20140211 |
Method SET_RESPONSE_META_INFO on Interface /IWBEP/IF_V4_RESPONSE_INFO has no exception.
Method TO_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
EV_RESPONSE_INFO_STRING | Value transfer | Type reference (TYPE) | XSTRING | String representation of the response info | 20131210 |
Method TO_STRING on Interface /IWBEP/IF_V4_RESPONSE_INFO has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 200 |
