/IWBEP/IF_MGW_REQ_ENTITYSET

Method GET_ENTITY_TYPE_NAME

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

Method GET_ENTITY_SET_NAME

This method returns the technical name of the target entity set.

Method GET_FILTER

This method is used to return the instance of the filter object.

Method GET_IF_MODIFIED_SINCE

This method is used to get the IF_MODIFIED_SINCE request header attribute.

Method GET_SOURCE_ENTITY_TYPE_NAME

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

Method GET_SOURCE_ENTITY_SET_NAME

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

Method GET_SOURCE_KEYS

This method is to be used when the entity is called by a navigation: Source entity type and target entity type are different.

This method returns a table of source entity keys. The returned key values are not converted even if they are defined in the Model Provider Class as convertible. Use method GET_CONVERTED_SOURCE_KEYS to get the key values converted automatically.

Method GET_NAVIGATION_PATH

This method is used to return the navigation path using technical names.

Method GET_TOP

This method is used to get the paging information of the $top parameter. The $top parameter indicates the number of entries which should be returned by the server.

Method GET_SKIP

This method is used to get the paging information of the $skip parameter. The $skip parameter indicates the number of entries which should be skipped by the server.

Method HAS_INLINECOUNT

If an inlincount is requested the response has to contain a count of entries embedded in the payload. The count has to be calculated by the application and has to be passed via the response context.

Method HAS_COUNT

This method indicates whether the client requested a count only.

If a count is requested the response contains the amount of entries only. The count can be calculated by the application and can be passed via the response context. If the counting is not done by the application the runtime derives the amount of entries via the returned data table.

Method GET_SKIPTOKEN

The server can limit the amount of entries send in a response in other to avoid a performance overhead if a huge number of entries is requested. A next link in the payload contains the skiptoken set by the server in the response context.

Method GET_DELTATOKEN

This method provides the delta token from a delta link within a feed. The delta token has previously been set in the response structure of a get feed call.

Note that a delta token needs to be issued in a normal feed to signal to the client that it supports delta tokens.

The way the delta token is issued and constructed is done by the issuer and is of his choice. For convenience sake you can use a date-time token (for default cases). In case of a date-time token you only need to take into account that the delta token should be related to one specific time zone, such as UTC.

A delta token call from a client needs to be handled appropriately. The delta token holds specific information which is known by the issuer. With this information it should be easy to extract the changed data. Deleted records are not supported at present.

Method GET_SEARCH_STRING

If a search is used then this method contains the search string.

A search string can be applied to a Collection request which can be used as a freetext parameter.

Method GET_SELECT

Select System Query Option ($select) to select only a subset of properties which should be returned by the server. The $select can be considered by the application for performance reasons and improvements. The SAP Gateway runtime takes care of applying the $select properly irrespective of whether $select is taken into account from the application or not. So, for the consumer, it is always the same behavior. It is only possible to specify a $select query for simple properties or for complex properties of the entity type itself. Note that it is not possible to select properties of complex properties.

Method GET_SELECT_WITH_MANDTRY_FIELDS

Select the system query option ($select) to select only a subset of properties which should be returned by the server. The $select can be considered by the application for performance reasons and improvements. The SAP Gateway runtime takes care of applying the $select properly irrespective of whether $select is taken into account from the application or not. So, for the consumer it is always the same behavior. The SAP Gateway runtime always adds the mandatory fields of the entity type (keys, etag, mime type mapping) to the select table irrespective of whether the key fields are already part of the original OData request or not. Therefore it is ensured that the result of this method can, for example, directly be applied to an SQL statement without any enrichment from the application developer.

It is only possible to specify a $select query for simple properties or for complex properties of the entity type itself according to the OData specification. Note that it is not possible to select properties of complex properties. A string table is anyway used for future purposes (for example, if OData will allow the selection of properties of complex properties in future versions - a possible notation would be MY_COMPLEX_PROP-MY_SIMPLE_PROP).

Method GET_ORDERBY

OrderBy system query option ($orderby) .

Method GET_CONVERTED_SOURCE_KEYS

This method is to be used when the entity set is called by a navigation: Source entity type and target entity type are different.

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_SOURCE_KEYS.

Method GET_FILTER_EXPRESSION_TREE

This method is to be used to get the filter expression tree.

Method GET_OSQL_WHERE_CLAUSE

This method is to be used to get an Open SQL WHERE clause.