Show TOC

OData V4 ModelLocate this document in the navigation structure

The sap.ui.model.odata.v4.ODataModel is the model implementation for consuming an OData V4 service.

Restriction

This is the first version of the SAPUI5 OData V4 model. Due to its limited feature scope, we recommend you do not use this release to develop applications that are to be used in production systems. Please look at the detailed documentation of the features, as certain parts of a feature may be missing which you might expect as given. While our intention was to be compatible with existing controls, existing controls might not work due to small incompatibilities compared to sap.ui.model.odata.(v2.)ODataModel, or due to missing features in the model. Up to now, only limited tests with controls have been done with the SAPUI5 OData V4 model. The interface for applications has been changed to make usage of the model easier and more efficient. A summary of these changes is documented in the section Changes Compared to OData V2 Model.

The OData V4 model supports the following:

  • Read access

  • Updating properties of OData entities via two-way-binding

  • Operation (function and action) execution

  • Grouping data requests in a batch request

  • Server-side sorting and filtering

Note

The OData V4 model documentation contains several code samples. These refer to the Sales Orders sample in the Explored app in the Demo Kit.


In this section:
    Model Instantiation and Data Access
    One OData V4 model instance can only cover one OData V4 service. Accessing OData services of any other version other than OData V4 is not supported. This section describes the creation of a model instance in more detail.
    Bindings
    Bindings connect SAPUI5 view elements to model data, allowing changes in the model to be reflected in the view element and vice versa.
    Binding Events
    The OData V4 model supports certain events intended for applications, and others that are to be used for controls, as outlined in this section.
    OData Operations
    The OData V4 model supports OData operations (ActionImport, FunctionImport and bound Actions). Unbound parameters are limited to primitive values.
    Batch Control
    OData V4 allows you to group multiple operations into a single HTTP request payload, as described in the official OData V4 specification Part 1, Batch Requests (see the link under Related Information for more details).
    Meta Model for OData V4
    Each OData V4 model offers access via getMetaModel to a corresponding metadata model sap.ui.model.odata.v4.ODataMetaModel, which is read-only and offers access to OData V4 metadata in a streamlined JSON format (see links under Related Information for more details). Only one-time bindings are supported by this model because the metadata is immutable.
    Performance Aspects
    The OData V4 model offers the features described below which influence performance.
    Unsupported Superclass Methods and Events
    Certain methods derived from SAPUI5 model and binding superclasses are not supported in OData V4 model classes or have limited support.
    Changes Compared to OData V2 Model
    This section outlines the main differences between the OData V2 and OData V4 models.
Related Information