This interface offers several convenience methods provided by the framework.
Method COPY_DATA_TO_REF
This is a convenience method to get a data reference of a type any variable.
Parameter |
Description |
---|---|
IS_DATA |
Variable of type any which has to be either a structure or an internal table. |
CR_DATA |
Data reference of the imported variable. |
In case last-modified is older than if-modified-since then the data is up-to-date. In this case the returning parameter rv_is_not_modified is set to 'X' (/iwbep/if_mgw_appl_types=>gcs_modification_status-is_not_modified) This method can be used to fill es_response_context-is_not_modified. In case es_response_context-is_not_modified is set to 'X' ( /iwbep/if_mgw_appl_types=>gcs_modification_status-is_not_modified) then an HTTP response 304 ‚Not Modified‘ shall be sent.
Parameter | Description |
---|---|
IV_IF_MODIFIED_SINCE | Variable of type TZNTSTMPS, the if-modified-since time stamp |
IV_LAST_MODIFIED | Variable of type TZNTSTMPS, the last-modified-since time stamp. |
RV_IS_NOT_MODIFIED | Variable of type /IWBEP/MGW_IS_NOT_MODIFIED. |
Method SET_HEADER
This method adds the header parameters to the HTTP response in a key/value approach.
Parameter |
Description |
---|---|
IS_HEADER |
Name/value pair as header parameter of the HTTP response. By setting this parameter you can, for example, influence the caching behavior. |
Method SET_ETAG
This method sets the HTTP ETag in the HTTP resonse header.
This method is only needed in the OData Compatibility Mode for SP 02. The ETag needs to be set in the READ_ENTITY method with the value of the property which is marked as ETag. You do not have to set the ETag in the OData Standard Mode.
Parameter |
Description |
---|---|
IV_VALUE |
ETag value |
Method GET_LOGGER
This method returns an instance of the OData Channel logger. It should be used by the DPC (data provider class) for logging purposes.
Parameter |
Description |
---|---|
RO_LOGGER |
Instance |
Method GET_MESSAGE_CONTAINER
This method returns an instance of the OData Channel message container. It should be used by the DPC to pass messages back to the framework.
Parameter |
Description |
---|---|
RO_MESSAGE_CONTAINER |
Instance |
Method GET_RESPONSE_UTIL
This method returns an instance of an utility that supports the creation of specific information in the response message.
Parameter |
Description |
---|---|
RO_RESPONSE_UTIL |
Instance |
The response utility mainly provides two methods GET_TARGET_IN_ENTITY and GET_TARGET_IN_ENTITY_SET to construct syntactically correct target information for error messages or warnings (see method signatures of the message container). Input: the technical entity and/or entity set name, key information if required, and a path to a property in ABAP format. The methods return a target string that already has the required format or will be translated into the final format on the hub.
The target calculation method GET_TARGET_IN_ENTITY_SET at the response utility /IWBEP/CL_MGW_RESPONSE_UTIL has been extended to support specification of a message target relative to the service. In this case, the final message target starts with '/', for example, '/Managers('0001')'. A new optional importing parameter has been added. The information is encoded into the preliminary message target. The hub logic constructs the final target based on the new parameter, the entity set name, and all subsequent target segments.
Usage of method GET_TARGET_FROM_INTERNAL_NAMES should be replaced by GET_TARGET_IN_ENTITY.
Method GET_DP_FACADE
This method returns a facade which is reserved for future features supporting content development. Currently it does not contain any methods.
Parameter |
Description |
---|---|
RO_DP_FACADE |
To access special utility methods |
Parameter | Description |
---|---|
IS_REQUEST_CONTEXT | Structure containing the new request context for unit tests, TYPE /IWBEP/CL_MGW_REQUEST_UNITTST=>TY_S_MGW_REQUEST_CONTEXT_UNIT |
RO_REQUEST_CONTEXT | Request context object for further usage through the DPC. TYPE REF TO /IWBEP/CL_MGW_REQUEST_UNITTST |