@openui5/sap.ui.core 1.97.1 → 1.100.0

package/src/sap/ui/model/odata/v4/ODataModel.js

@@ -52,6 +52,8 @@ sap.ui.define([
 		// system query options allowed within a $expand query option
 		aExpandQueryOptions = ["$count", "$expand", "$filter", "$levels", "$orderby", "$search",
 			"$select"],
+		// binding-specific parameters allowed in getKeepAliveContext
+		aGetKeepAliveParameters = ["$$groupId", "$$patchWithoutSideEffects", "$$updateGroupId"],
 		rGroupID = /^(\$auto(\.\w+)?|\$direct|\w+)$/,
 		MessageType = coreLibrary.MessageType,
 		aMessageTypes = [
@@ -85,269 +87,288 @@ sap.ui.define([
 		aSystemQueryOptions = ["$apply", "$count", "$expand", "$filter", "$orderby", "$search",
 			"$select"],
 		// valid header values: non-empty, only US-ASCII, no control chars
-		rValidHeader = /^[ -~]+$/;
+		rValidHeader = /^[ -~]+$/,
+		/**
+		 * Constructor for a new ODataModel.
+		 *
+		 * @param {object} mParameters
+		 *   The parameters
+		 * @param {string|string[]} [mParameters.annotationURI]
+		 *   The URL (or an array of URLs) from which the annotation metadata are loaded.
+		 *   The annotation files are merged into the service metadata in the given order (last one
+		 *   wins). The same annotations are overwritten; if an annotation file contains other
+		 *   elements (like a type definition) that are already merged, an error is thrown.
+		 *   Supported since 1.41.0
+		 * @param {boolean} [mParameters.autoExpandSelect]
+		 *   Whether the OData model's bindings automatically generate $select and $expand system
+		 *   query options from the binding hierarchy. Note: Dynamic changes to the binding
+		 *   hierarchy are not supported. This parameter is supported since 1.47.0, and since 1.75.0
+		 *   it also enables property paths containing navigation properties in
+		 *   <code>$select</code>.
+		 * @param {boolean} [mParameters.earlyRequests]
+		 *   Whether the following is requested at the earliest convenience:
+		 *   <ul>
+		 *     <li> root $metadata document and annotation files;
+		 *     <li> the security token.
+		 *   </ul>
+		 *   Note: The root $metadata document and annotation files are just requested but not yet
+		 *   converted from XML to JSON unless really needed.
+		 *   Supported since 1.53.0.
+		 *   <b>BEWARE:</b> The default value may change to <code>true</code> in later releases.
+		 *   You may also set {@link topic:26ba6a5c1e5c417f8b21cce1411dba2c Manifest Model Preload}
+		 *   in order to further speed up the start of a UI5 component.
+		 * @param {string} [mParameters.groupId="$auto"]
+		 *   Controls the model's use of batch requests: '$auto' bundles requests from the model in
+		 *   a batch request which is sent automatically before rendering; '$direct' sends requests
+		 *   directly without batch; other values result in an error
+		 * @param {object} [mParameters.groupProperties]
+		 *   Controls the use of batch requests for application groups. A map of application
+		 *   group IDs having an object with exactly one property <code>submit</code>. Valid values
+		 *   are 'API', 'Auto', 'Direct' see {@link sap.ui.model.odata.v4.SubmitMode}. Supported
+		 *   since 1.51.0
+		 * @param {object} [mParameters.httpHeaders]
+		 *   Map of HTTP header names to their values, see {@link #changeHttpHeaders}
+		 * @param {object} [mParameters.metadataUrlParams]
+		 *   Additional map of URL parameters used specifically for $metadata requests. Note that
+		 *   "sap-context-token" applies only to the service's root $metadata, but not to
+		 *   "cross-service references". Supported since 1.81.0
+		 * @param {string} [mParameters.odataVersion="4.0"]
+		 *   The version of the OData service. Supported values are "2.0" and "4.0".
+		 * @param {sap.ui.model.odata.OperationMode} [mParameters.operationMode]
+		 *   The operation mode for filtering and sorting. Since 1.39.0, the operation mode
+		 *   {@link sap.ui.model.odata.OperationMode.Server} is supported. All other operation modes
+		 *   including <code>undefined</code> lead to an error if 'vFilters' or 'vSorters' are given
+		 *   or if {@link sap.ui.model.odata.v4.ODataListBinding#filter} or
+		 *   {@link sap.ui.model.odata.v4.ODataListBinding#sort} is called.
+		 * @param {string} mParameters.serviceUrl
+		 *   Root URL of the service to request data from. The path part of the URL must end with a
+		 *   forward slash according to OData V4 specification ABNF, rule "serviceRoot". You may
+		 *   append OData custom query options to the service root URL separated with a "?", for
+		 *   example "/MyService/?custom=foo". See specification "OData Version 4.0 Part 2: URL
+		 *   Conventions", "5.2 Custom Query Options". OData system query options and OData
+		 *   parameter aliases lead to an error.
+		 * @param {boolean} [mParameters.sharedRequests]
+		 *   Whether all list bindings for the same resource path share their data, so that it is
+		 *   requested only once; only the value <code>true</code> is allowed; see parameter
+		 *   "$$sharedRequest" of {@link #bindList}. Additionally,
+		 *   {@link sap.ui.model.BindingMode.OneWay} becomes the default binding mode and
+		 *   {@link sap.ui.model.BindingMode.TwoWay} is forbidden. Note: This makes all bindings
+		 *   read-only, so it may be especially useful for value list models. Supported since 1.80.0
+		 * @param {boolean} [mParameters.supportReferences=true]
+		 *   Whether <code>&lt;edmx:Reference></code> and <code>&lt;edmx:Include></code> directives
+		 *   are supported in order to load schemas on demand from other $metadata documents and
+		 *   include them into the current service ("cross-service references").
+		 * @param {string} mParameters.synchronizationMode
+		 *   Controls synchronization between different bindings which refer to the same data for
+		 *   the case data changes in one binding. Must be set to 'None' which means bindings are
+		 *   not synchronized at all; all other values are not supported and lead to an error.
+		 * @param {string} [mParameters.updateGroupId]
+		 *   The group ID that is used for update requests. If no update group ID is specified,
+		 *   <code>mParameters.groupId</code> is used. Valid update group IDs are
+		 *   <code>undefined</code>, '$auto', '$direct' or an application group ID.
+		 * @throws {Error} If an unsupported synchronization mode is given, if the given service
+		 *   root URL does not end with a forward slash, if an unsupported parameter is given, if
+		 *   OData system query options or parameter aliases are specified as parameters, if an
+		 *   invalid group ID or update group ID is given, if the given operation mode is not
+		 *   supported, if an annotation file cannot be merged into the service metadata, if an
+		 *   unsupported value for <code>odataVersion</code> is given.
+		 *
+		 * @alias sap.ui.model.odata.v4.ODataModel
+		 * @author SAP SE
+		 * @class Model implementation for OData V4.
+		 *
+		 *   This model is not prepared to be inherited from.
+		 *
+		 *   Every resource path (relative to the service root URL, no query options) according to
+		 *   "4 Resource Path" in specification "OData Version 4.0 Part 2: URL Conventions" is
+		 *   a valid data binding path within this model if a leading slash is added; for example
+		 *   "/" + "SalesOrderList('A%2FB%26C')" to access an entity instance with key "A/B&C". Note
+		 *   that appropriate URI encoding is necessary, see the example of
+		 *   {@link sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions"
+		 *   needs an operation binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}.
+		 *
+		 *   Note that the OData V4 model has its own {@link sap.ui.model.odata.v4.Context} class.
+		 *   Bindings which are relative to such a V4 context depend on their corresponding parent
+		 *   binding and do not access data with their own service requests unless parameters are
+		 *   provided.
+		 *
+		 *   <b>Group IDs</b> control the model's use of batch requests. Valid group IDs are:
+		 *   <ul>
+		 *     <li> <b>$auto</b> and <b>$auto.*</b>: Bundles requests from the model in a batch
+		 *       request which is sent automatically before rendering. You can use different
+		 *       '$auto.*' group IDs to use different batch requests. The suffix may be any
+		 *       non-empty string consisting of alphanumeric characters from the basic Latin
+		 *       alphabet, including the underscore. The submit mode for these group IDs is always
+		 *       {@link sap.ui.model.odata.v4.SubmitMode#Auto}.
+		 *     <li> <b>$direct</b>: Sends requests directly without batch. The submit mode for this
+		 *       group ID is always {@link sap.ui.model.odata.v4.SubmitMode#Direct}.
+		 *     <li> An application group ID, which is a non-empty string consisting of alphanumeric
+		 *       characters from the basic Latin alphabet, including the underscore. By default, an
+		 *       application group has the submit mode {@link sap.ui.model.odata.v4.SubmitMode#API}.
+		 *       It is possible to use a different submit mode; for details see
+		 *       <code>mParameters.groupProperties</code>.
+		 *   </ul>
+		 *
+		 * @extends sap.ui.model.Model
+		 * @public
+		 * @since 1.37.0
+		 * @version 1.100.0
+		 */
+		ODataModel = Model.extend("sap.ui.model.odata.v4.ODataModel",
+			/** @lends sap.ui.model.odata.v4.ODataModel.prototype */{
+				constructor : constructor
+			});
+
+	//*********************************************************************************************
+	// ODataModel
+	//*********************************************************************************************
 
 	/**
 	 * Constructor for a new ODataModel.
 	 *
 	 * @param {object} mParameters
 	 *   The parameters
-	 * @param {string|string[]} [mParameters.annotationURI]
-	 *   The URL (or an array of URLs) from which the annotation metadata are loaded.
-	 *   The annotation files are merged into the service metadata in the given order (last one
-	 *   wins). The same annotations are overwritten; if an annotation file contains other elements
-	 *   (like a type definition) that are already merged, an error is thrown.
-	 *   Supported since 1.41.0
-	 * @param {boolean} [mParameters.autoExpandSelect]
-	 *   Whether the OData model's bindings automatically generate $select and $expand system query
-	 *   options from the binding hierarchy. Note: Dynamic changes to the binding hierarchy are not
-	 *   supported. This parameter is supported since 1.47.0, and since 1.75.0 it also enables
-	 *   property paths containing navigation properties in <code>$select</code>.
-	 * @param {boolean} [mParameters.earlyRequests]
-	 *   Whether the following is requested at the earliest convenience:
-	 *   <ul>
-	 *     <li> root $metadata document and annotation files;
-	 *     <li> the security token.
-	 *   </ul>
-	 *   Note: The root $metadata document and annotation files are just requested but not yet
-	 *   converted from XML to JSON unless really needed.
-	 *   Supported since 1.53.0.
-	 *   <b>BEWARE:</b> The default value may change to <code>true</code> in later releases.
-	 *   You may also set {@link topic:26ba6a5c1e5c417f8b21cce1411dba2c Manifest Model Preload} in
-	 *   order to further speed up the start of a UI5 component.
-	 * @param {string} [mParameters.groupId="$auto"]
-	 *   Controls the model's use of batch requests: '$auto' bundles requests from the model in a
-	 *   batch request which is sent automatically before rendering; '$direct' sends requests
-	 *   directly without batch; other values result in an error
-	 * @param {object} [mParameters.groupProperties]
-	 *   Controls the use of batch requests for application groups. A map of application
-	 *   group IDs having an object with exactly one property <code>submit</code>. Valid values are
-	 *   'API', 'Auto', 'Direct' see {@link sap.ui.model.odata.v4.SubmitMode}.
-	 *   Supported since 1.51.0
-	 * @param {object} [mParameters.httpHeaders]
-	 *   Map of HTTP header names to their values, see {@link #changeHttpHeaders}
-	 * @param {object} [mParameters.metadataUrlParams]
-	 *   Additional map of URL parameters used specifically for $metadata requests. Note that
-	 *   "sap-context-token" applies only to the service's root $metadata, but not to
-	 *   "cross-service references". Supported since 1.81.0
-	 * @param {string} [mParameters.odataVersion="4.0"]
-	 *   The version of the OData service. Supported values are "2.0" and "4.0".
-	 * @param {sap.ui.model.odata.OperationMode} [mParameters.operationMode]
-	 *   The operation mode for filtering and sorting. Since 1.39.0, the operation mode
-	 *   {@link sap.ui.model.odata.OperationMode.Server} is supported. All other operation modes
-	 *   including <code>undefined</code> lead to an error if 'vFilters' or 'vSorters' are given or
-	 *   if {@link sap.ui.model.odata.v4.ODataListBinding#filter} or
-	 *   {@link sap.ui.model.odata.v4.ODataListBinding#sort} is called.
-	 * @param {string} mParameters.serviceUrl
-	 *   Root URL of the service to request data from. The path part of the URL must end with a
-	 *   forward slash according to OData V4 specification ABNF, rule "serviceRoot". You may append
-	 *   OData custom query options to the service root URL separated with a "?", for example
-	 *   "/MyService/?custom=foo".
-	 *   See specification "OData Version 4.0 Part 2: URL Conventions", "5.2 Custom Query Options".
-	 *   OData system query options and OData parameter aliases lead to an error.
-	 * @param {boolean} [mParameters.sharedRequests]
-	 *   Whether all list bindings for the same resource path share their data, so that it is
-	 *   requested only once; only the value <code>true</code> is allowed; see parameter
-	 *   "$$sharedRequest" of {@link #bindList}. Additionally,
-	 *   {@link sap.ui.model.BindingMode.OneWay} becomes the default binding mode and
-	 *   {@link sap.ui.model.BindingMode.TwoWay} is forbidden. Note: This makes all bindings
-	 *   read-only, so it may be especially useful for value list models. Supported since 1.80.0
-	 * @param {boolean} [mParameters.supportReferences=true]
-	 *   Whether <code>&lt;edmx:Reference></code> and <code>&lt;edmx:Include></code> directives are
-	 *   supported in order to load schemas on demand from other $metadata documents and include
-	 *   them into the current service ("cross-service references").
-	 * @param {string} mParameters.synchronizationMode
-	 *   Controls synchronization between different bindings which refer to the same data for the
-	 *   case data changes in one binding. Must be set to 'None' which means bindings are not
-	 *   synchronized at all; all other values are not supported and lead to an error.
-	 * @param {string} [mParameters.updateGroupId]
-	 *   The group ID that is used for update requests. If no update group ID is specified, <code>
-	 *   mParameters.groupId</code> is used. Valid update group IDs are <code>undefined</code>,
-	 *   '$auto', '$direct' or an application group ID.
 	 * @throws {Error} If an unsupported synchronization mode is given, if the given service root
 	 *   URL does not end with a forward slash, if an unsupported parameter is given, if OData
 	 *   system query options or parameter aliases are specified as parameters, if an invalid group
 	 *   ID or update group ID is given, if the given operation mode is not supported, if an
 	 *   annotation file cannot be merged into the service metadata, if an unsupported value for
 	 *   <code>odataVersion</code> is given.
-	 *
-	 * @alias sap.ui.model.odata.v4.ODataModel
-	 * @author SAP SE
-	 * @class Model implementation for OData V4.
-	 *
-	 *   This model is not prepared to be inherited from.
-	 *
-	 *   Every resource path (relative to the service root URL, no query options) according to
-	 *   "4 Resource Path" in specification "OData Version 4.0 Part 2: URL Conventions" is
-	 *   a valid data binding path within this model if a leading slash is added; for example
-	 *   "/" + "SalesOrderList('A%2FB%26C')" to access an entity instance with key "A/B&C". Note
-	 *   that appropriate URI encoding is necessary, see the example of
-	 *   {@link sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions" needs an
-	 *   operation binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}.
-	 *
-	 *   Note that the OData V4 model has its own {@link sap.ui.model.odata.v4.Context} class.
-	 *   Bindings which are relative to such a V4 context depend on their corresponding parent
-	 *   binding and do not access data with their own service requests unless parameters are
-	 *   provided.
-	 *
-	 *   <b>Group IDs</b> control the model's use of batch requests. Valid group IDs are:
-	 *   <ul>
-	 *     <li> <b>$auto</b> and <b>$auto.*</b>: Bundles requests from the model in a batch request
-	 *       which is sent automatically before rendering. You can use different '$auto.*' group IDs
-	 *       to use different batch requests. The suffix may be any non-empty string consisting of
-	 *       alphanumeric characters from the basic Latin alphabet, including the underscore. The
-	 *       submit mode for these group IDs is always
-	 *       {@link sap.ui.model.odata.v4.SubmitMode#Auto}.
-	 *     <li> <b>$direct</b>: Sends requests directly without batch. The submit mode for this
-	 *       group ID is always {@link sap.ui.model.odata.v4.SubmitMode#Direct}.
-	 *     <li> An application group ID, which is a non-empty string consisting of alphanumeric
-	 *       characters from the basic Latin alphabet, including the underscore. By default, an
-	 *       application group has the submit mode {@link sap.ui.model.odata.v4.SubmitMode#API}. It
-	 *       is possible to use a different submit mode; for details see
-	 *       <code>mParameters.groupProperties</code>.
-	 *   </ul>
-	 *
-	 * @extends sap.ui.model.Model
-	 * @public
-	 * @since 1.37.0
-	 * @version 1.97.1
-	 */
-	var ODataModel = Model.extend("sap.ui.model.odata.v4.ODataModel",
-			/** @lends sap.ui.model.odata.v4.ODataModel.prototype */
-			{
-				constructor : function (mParameters) {
-					var sGroupId,
-						oGroupProperties,
-						sLanguageTag = sap.ui.getCore().getConfiguration().getLanguageTag(),
-						sODataVersion,
-						sParameter,
-						sServiceUrl,
-						oUri,
-						mUriParameters,
-						that = this;
-
-					// do not pass any parameters to Model
-					Model.call(this);
-
-					if (!mParameters || mParameters.synchronizationMode !== "None") {
-						throw new Error("Synchronization mode must be 'None'");
-					}
-					sODataVersion = mParameters.odataVersion || "4.0";
-					this.sODataVersion = sODataVersion;
-					if (sODataVersion !== "4.0" && sODataVersion !== "2.0") {
-						throw new Error("Unsupported value for parameter odataVersion: "
-							+ sODataVersion);
-					}
-					for (sParameter in mParameters) {
-						if (!(sParameter in mSupportedParameters)) {
-							throw new Error("Unsupported parameter: " + sParameter);
-						}
-					}
-					sServiceUrl = mParameters.serviceUrl;
-					if (!sServiceUrl) {
-						throw new Error("Missing service root URL");
-					}
-					oUri = new URI(sServiceUrl);
-					if (oUri.path()[oUri.path().length - 1] !== "/") {
-						throw new Error("Service root URL must end with '/'");
-					}
-					if (mParameters.operationMode
-							&& mParameters.operationMode !== OperationMode.Server) {
-						throw new Error("Unsupported operation mode: "
-							+ mParameters.operationMode);
-					}
-					this.sOperationMode = mParameters.operationMode;
-					// Note: strict checking for model's URI parameters, but "sap-*" is allowed
-					mUriParameters = this.buildQueryOptions(oUri.query(true), false, true);
-					// BEWARE: these are shared across all bindings!
-					this.mUriParameters = mUriParameters;
-					if (sap.ui.getCore().getConfiguration().getStatistics()) {
-						// Note: this way, "sap-statistics" is not sent within $batch
-						mUriParameters = Object.assign({"sap-statistics" : true}, mUriParameters);
-					}
-					this.sServiceUrl = oUri.query("").toString();
-					this.sGroupId = mParameters.groupId;
-					if (this.sGroupId === undefined) {
-						this.sGroupId = "$auto";
-					}
-					if (this.sGroupId !== "$auto" && this.sGroupId !== "$direct") {
-						throw new Error("Group ID must be '$auto' or '$direct'");
-					}
-					this.checkGroupId(mParameters.updateGroupId, false,
-						"Invalid update group ID: ");
-					this.sUpdateGroupId = mParameters.updateGroupId || this.getGroupId();
-					this.mGroupProperties = {};
-					for (sGroupId in mParameters.groupProperties) {
-						that.checkGroupId(sGroupId, true);
-						oGroupProperties = mParameters.groupProperties[sGroupId];
-						if (typeof oGroupProperties !== "object"
-								|| Object.keys(oGroupProperties).length !== 1
-								|| !(oGroupProperties.submit in SubmitMode)) {
-							throw new Error("Group '" + sGroupId + "' has invalid properties: '"
-								+ oGroupProperties + "'");
-						}
-					}
-					this.mGroupProperties = _Helper.clone(mParameters.groupProperties) || {};
-					this.mGroupProperties.$auto = {submit : SubmitMode.Auto};
-					this.mGroupProperties.$direct = {submit : SubmitMode.Direct};
-					if (mParameters.autoExpandSelect !== undefined
-							&& typeof mParameters.autoExpandSelect !== "boolean") {
-						throw new Error("Value for autoExpandSelect must be true or false");
-					}
-					this.bAutoExpandSelect = mParameters.autoExpandSelect === true;
-					if ("sharedRequests" in mParameters && mParameters.sharedRequests !== true) {
-						throw new Error("Value for sharedRequests must be true");
-					}
-					this.bSharedRequests = mParameters.sharedRequests === true;
-
-					this.mHeaders = {"Accept-Language" : sLanguageTag};
-					this.mMetadataHeaders = {"Accept-Language" : sLanguageTag};
-
-					// BEWARE: do not share mHeaders between _MetadataRequestor and _Requestor!
-					this.oMetaModel = new ODataMetaModel(
-						_MetadataRequestor.create(this.mMetadataHeaders, sODataVersion,
-							Object.assign({}, mUriParameters, mParameters.metadataUrlParams)),
-						this.sServiceUrl + "$metadata", mParameters.annotationURI, this,
-						mParameters.supportReferences);
-					this.oInterface = {
-						fetchEntityContainer :
-							this.oMetaModel.fetchEntityContainer.bind(this.oMetaModel),
-						fetchMetadata : this.oMetaModel.fetchObject.bind(this.oMetaModel),
-						fireSessionTimeout : function () {
-							that.fireEvent("sessionTimeout");
-						},
-						getGroupProperty : this.getGroupProperty.bind(this),
-						onCreateGroup : function (sGroupId) {
-							if (that.isAutoGroup(sGroupId)) {
-								that.addPrerenderingTask(
-									that._submitBatch.bind(that, sGroupId, true));
-							}
-						},
-						reportStateMessages : this.reportStateMessages.bind(this),
-						reportTransitionMessages : this.reportTransitionMessages.bind(this)
-					};
-					this.oRequestor = _Requestor.create(this.sServiceUrl, this.oInterface,
-						this.mHeaders, mUriParameters, sODataVersion);
-					this.changeHttpHeaders(mParameters.httpHeaders);
-					if (mParameters.earlyRequests) {
-						this.oMetaModel.fetchEntityContainer(true);
-						this.initializeSecurityToken();
-					}
+	 */
+	function constructor(mParameters) {
+		var sGroupId,
+			oGroupProperties,
+			sLanguageTag = sap.ui.getCore().getConfiguration().getLanguageTag(),
+			sODataVersion,
+			sParameter,
+			sServiceUrl,
+			oUri,
+			mUriParameters,
+			that = this;
 
-					this.aAllBindings = [];
-					this.mSupportedBindingModes = {
-						OneTime : true,
-						OneWay : true
-					};
-					if (mParameters.sharedRequests) {
-						this.sDefaultBindingMode = BindingMode.OneWay;
-					} else {
-						this.sDefaultBindingMode = BindingMode.TwoWay;
-						this.mSupportedBindingModes.TwoWay = true;
-					}
-					this.aPrerenderingTasks = null; // @see #addPrerenderingTask
+		// do not pass any parameters to Model
+		Model.call(this);
+
+		if (!mParameters || mParameters.synchronizationMode !== "None") {
+			throw new Error("Synchronization mode must be 'None'");
+		}
+		sODataVersion = mParameters.odataVersion || "4.0";
+		this.sODataVersion = sODataVersion;
+		if (sODataVersion !== "4.0" && sODataVersion !== "2.0") {
+			throw new Error("Unsupported value for parameter odataVersion: " + sODataVersion);
+		}
+		for (sParameter in mParameters) {
+			if (!(sParameter in mSupportedParameters)) {
+				throw new Error("Unsupported parameter: " + sParameter);
+			}
+		}
+		sServiceUrl = mParameters.serviceUrl;
+		if (!sServiceUrl) {
+			throw new Error("Missing service root URL");
+		}
+		oUri = new URI(sServiceUrl);
+		if (oUri.path()[oUri.path().length - 1] !== "/") {
+			throw new Error("Service root URL must end with '/'");
+		}
+		if (mParameters.operationMode && mParameters.operationMode !== OperationMode.Server) {
+			throw new Error("Unsupported operation mode: "
+				+ mParameters.operationMode);
+		}
+		this.sOperationMode = mParameters.operationMode;
+		// Note: strict checking for model's URI parameters, but "sap-*" is allowed
+		mUriParameters = this.buildQueryOptions(oUri.query(true), false, true);
+		// BEWARE: these are shared across all bindings!
+		this.mUriParameters = mUriParameters;
+		if (sap.ui.getCore().getConfiguration().getStatistics()) {
+			// Note: this way, "sap-statistics" is not sent within $batch
+			mUriParameters = Object.assign({"sap-statistics" : true}, mUriParameters);
+		}
+		this.sServiceUrl = oUri.query("").toString();
+		this.sGroupId = mParameters.groupId;
+		if (this.sGroupId === undefined) {
+			this.sGroupId = "$auto";
+		}
+		if (this.sGroupId !== "$auto" && this.sGroupId !== "$direct") {
+			throw new Error("Group ID must be '$auto' or '$direct'");
+		}
+		this.checkGroupId(mParameters.updateGroupId, false, "Invalid update group ID: ");
+		this.sUpdateGroupId = mParameters.updateGroupId || this.getGroupId();
+		this.mGroupProperties = {};
+		for (sGroupId in mParameters.groupProperties) {
+			that.checkGroupId(sGroupId, true);
+			oGroupProperties = mParameters.groupProperties[sGroupId];
+			if (typeof oGroupProperties !== "object"
+					|| Object.keys(oGroupProperties).length !== 1
+					|| !(oGroupProperties.submit in SubmitMode)) {
+				throw new Error("Group '" + sGroupId + "' has invalid properties: '"
+					+ oGroupProperties + "'");
+			}
+		}
+		this.mGroupProperties = _Helper.clone(mParameters.groupProperties) || {};
+		this.mGroupProperties.$auto = {submit : SubmitMode.Auto};
+		this.mGroupProperties.$direct = {submit : SubmitMode.Direct};
+		if (mParameters.autoExpandSelect !== undefined
+				&& typeof mParameters.autoExpandSelect !== "boolean") {
+			throw new Error("Value for autoExpandSelect must be true or false");
+		}
+		this.bAutoExpandSelect = mParameters.autoExpandSelect === true;
+		if ("sharedRequests" in mParameters && mParameters.sharedRequests !== true) {
+			throw new Error("Value for sharedRequests must be true");
+		}
+		this.bSharedRequests = mParameters.sharedRequests === true;
+
+		this.mHeaders = {"Accept-Language" : sLanguageTag};
+		this.mMetadataHeaders = {"Accept-Language" : sLanguageTag};
+
+		// BEWARE: do not share mHeaders between _MetadataRequestor and _Requestor!
+		this.oMetaModel = new ODataMetaModel(
+			_MetadataRequestor.create(this.mMetadataHeaders, sODataVersion,
+				Object.assign({}, mUriParameters, mParameters.metadataUrlParams)),
+			this.sServiceUrl + "$metadata", mParameters.annotationURI, this,
+			mParameters.supportReferences);
+		this.oInterface = {
+			fetchEntityContainer : this.oMetaModel.fetchEntityContainer.bind(this.oMetaModel),
+			fetchMetadata : this.oMetaModel.fetchObject.bind(this.oMetaModel),
+			fireSessionTimeout : function () {
+				that.fireEvent("sessionTimeout");
+			},
+			getGroupProperty : this.getGroupProperty.bind(this),
+			getOptimisticBatchEnabler : this.getOptimisticBatchEnabler.bind(this),
+			getReporter : this.getReporter.bind(this),
+			onCreateGroup : function (sGroupId) {
+				if (that.isAutoGroup(sGroupId)) {
+					that.addPrerenderingTask(that._submitBatch.bind(that, sGroupId, true));
 				}
-			});
+			},
+			reportStateMessages : this.reportStateMessages.bind(this),
+			reportTransitionMessages : this.reportTransitionMessages.bind(this)
+		};
+		this.oRequestor = _Requestor.create(this.sServiceUrl, this.oInterface, this.mHeaders,
+			mUriParameters, sODataVersion);
+		this.changeHttpHeaders(mParameters.httpHeaders);
+		this.bEarlyRequests = mParameters.earlyRequests;
+		if (this.bEarlyRequests) {
+			this.oMetaModel.fetchEntityContainer(true);
+			this.initializeSecurityToken();
+			this.oRequestor.sendOptimisticBatch();
+		}
+
+		this.aAllBindings = [];
+		// The bindings holding keep-alive contexts without a $$getKeepAlive binding
+		this.mKeepAliveBindingsByPath = {};
+		this.mSupportedBindingModes = {
+			OneTime : true,
+			OneWay : true
+		};
+		if (mParameters.sharedRequests) {
+			this.sDefaultBindingMode = BindingMode.OneWay;
+		} else {
+			this.sDefaultBindingMode = BindingMode.TwoWay;
+			this.mSupportedBindingModes.TwoWay = true;
+		}
+		this.aPrerenderingTasks = null; // @see #addPrerenderingTask
+		this.fnOptimisticBatchEnabler = null;
+	}
 
 	/**
 	 * Submits the requests associated with this group ID in one batch request.
@@ -435,7 +456,8 @@ sap.ui.define([
 	 * @private
 	 */
 	ODataModel.prototype.addPrerenderingTask = function (fnPrerenderingTask, bFirst) {
-		var fnRunTasks, iTimeoutId, that = this;
+		var fnRunTasks, iTimeoutId,
+			that = this;
 
 		function runTasks(aTasks) {
 			clearTimeout(iTimeoutId);
@@ -645,6 +667,12 @@ sap.ui.define([
 	 *   Whether a binding relative to a {@link sap.ui.model.odata.v4.Context} uses the canonical
 	 *   path computed from its context's path for data service requests; only the value
 	 *   <code>true</code> is allowed.
+	 * @param {boolean} [mParameters.$$getKeepAliveContext]
+	 *   Whether this binding is considered for a match when {@link #getKeepAliveContext} is called;
+	 *   only the value <code>true</code> is allowed. Must not be combined with <code>$apply</code>,
+	 *   <code>$$aggregation</code>, <code>$$canonicalPath</code>, or <code>$$sharedRequest</code>.
+	 *   If the binding is relative, <code>$$ownRequest</code> must be set as well.
+	 *   Supported since 1.99.0
 	 * @param {string} [mParameters.$$groupId]
 	 *   The group ID to be used for <b>read</b> requests triggered by this binding; if not
 	 *   specified, either the parent binding's group ID (if the binding is relative) or the
@@ -852,7 +880,7 @@ sap.ui.define([
 		 * @param {string[]} aAllowed The allowed system query options
 		 * @throws {error} If the given query option name is not allowed
 		 */
-		function parseAndValidateSystemQueryOption (mOptions, sOptionName, aAllowed) {
+		function parseAndValidateSystemQueryOption(mOptions, sOptionName, aAllowed) {
 			var sExpandOptionName,
 				mExpandOptions,
 				sExpandPath,
@@ -879,7 +907,7 @@ sap.ui.define([
 					}
 				}
 			} else if (sOptionName === "$count") {
-				if (typeof vValue  === "boolean") {
+				if (typeof vValue === "boolean") {
 					if (!vValue) {
 						delete mOptions.$count;
 					}
@@ -1125,7 +1153,7 @@ sap.ui.define([
 				+ "' without context");
 		}
 
-		iSeparator = sResolvedPath.indexOf('#');
+		iSeparator = sResolvedPath.indexOf("#");
 		if (iSeparator >= 0) {
 			sDataPath = sResolvedPath.slice(0, iSeparator);
 			sMetaPath = sResolvedPath.slice(iSeparator + 1);
@@ -1480,6 +1508,115 @@ sap.ui.define([
 		throw new Error("Unsupported operation: v4.ODataModel#getProperty");
 	};
 
+	/**
+	 * Returns a context with the given path belonging to a matching list binding that has been
+	 * marked with <code>$$getKeepAliveContext</code> (see {@link #bindList}). If such a matching
+	 * binding can be found, a context is returned and kept alive (see
+	 * {@link sap.ui.model.odata.v4.ODataListBinding#getKeepAliveContext}). Since 1.100.0 a
+	 * temporary binding is used if no such binding could be found. If such a binding is created or
+	 * resolved later, the context and its data are transferred to it, and the temporary binding is
+	 * destroyed again.
+	 *
+	 * A <code>$$getKeepAliveContext</code> binding matches if its resolved binding path is the
+	 * collection path of the context. If the context is created using a temporary binding and the
+	 * parameters of the <code>$$getKeepAliveContext</code> binding differ from the given
+	 * <code>mParameters</code> (except <code>$$groupId</code> which is especially used for the
+	 * context), that binding later runs into an error when trying to read data.
+	 *
+	 * <b>Note</b>: The context received by this function may change its
+	 * {@link sap.ui.model.odata.v4.Context#getBinding binding} during its lifetime.
+	 *
+	 * @param {string} sPath
+	 *   A list context path to an entity
+	 * @param {boolean} [bRequestMessages]
+	 *   Whether to request messages for the context's entity
+	 * @param {object} [mParameters]
+	 *   Parameters for the context or the temporary binding; supported since 1.100.0. All custom
+	 *   query options and the following binding-specific parameters for a list binding may be given
+	 *   (see {@link #bindList} for details).
+	 * @param {string} [mParameters.$$groupId]
+	 *   The group ID used for read requests for the context's entity or its properties. If not
+	 *   given, the model's {@link #getGroupId group ID} is used
+	 * @param {boolean} [mParameters.$$patchWithoutSideEffects]
+	 *   Whether implicit loading of side effects via PATCH requests is switched off
+	 * @param {string} [mParameters.$$updateGroupId]
+	 *   The group ID to be used for <b>update</b> requests triggered by the context's binding
+	 * @returns {sap.ui.model.odata.v4.Context|undefined}
+	 *   The context, or <code>undefined</code> if a binding with a suspended root binding matches
+	 *   and has no context with that path.
+	 * @throws {Error} If
+	 *   <ul>
+	 *     <li> the model does not use the <code>autoExpandSelect</code> parameter,
+	 *     <li> an invalid parameter was supplied,
+	 *     <li> the path is not a list context path to an entity,
+	 *     <li> multiple list bindings with <code>$$getKeepAliveContext</code> match, or
+	 *     <li> {@link sap.ui.model.odata.v4.Context#setKeepAlive} fails
+	 *   </ul>
+	 *
+	 * @public
+	 * @since 1.99.0
+	 */
+	ODataModel.prototype.getKeepAliveContext = function (sPath, bRequestMessages, mParameters) {
+		var oListBinding,
+			aListBindings,
+			sListPath;
+
+		if (!this.bAutoExpandSelect) {
+			throw new Error("Missing parameter autoExpandSelect");
+		}
+		if (sPath[0] !== "/") {
+			throw new Error("Not a list context path to an entity: " + sPath);
+		}
+		mParameters = mParameters || {};
+		// Only excess parameters are rejected here; the correctness is checked by ODLB
+		Object.keys(mParameters).forEach(function (sParameter) {
+			if (sParameter.startsWith("sap-") && !sParameter.startsWith("sap-valid-")
+					|| sParameter[0] === "$" && !aGetKeepAliveParameters.includes(sParameter)) {
+				throw new Error("Invalid parameter: " + sParameter);
+			}
+		});
+		sListPath = sPath.slice(0, this.getPredicateIndex(sPath));
+		oListBinding = this.mKeepAliveBindingsByPath[sListPath];
+		if (!oListBinding) {
+			aListBindings = this.aAllBindings.filter(function (oBinding) {
+				if (oBinding.mParameters && oBinding.mParameters.$$getKeepAliveContext) {
+					oBinding.removeCachesAndMessages(sListPath.slice(1), true);
+				}
+				return oBinding.isKeepAliveBindingFor && oBinding.isKeepAliveBindingFor(sListPath);
+			});
+			if (aListBindings.length > 1) {
+				throw new Error("Multiple bindings with $$getKeepAliveContext for: " + sPath);
+			}
+			oListBinding = aListBindings[0];
+			if (!oListBinding) {
+				oListBinding = this.bindList(sListPath, undefined, undefined, undefined,
+					mParameters);
+				this.mKeepAliveBindingsByPath[sListPath] = oListBinding;
+			}
+		}
+
+		return oListBinding.getKeepAliveContext(sPath, bRequestMessages, mParameters.$$groupId);
+	};
+
+	/**
+	 * Returns the index of the key predicate in the last segment of the given path.
+	 *
+	 * @param {string} sPath - The path
+	 * @returns {number} The index of the key predicate
+	 * @throws {Error} If the last segment contains no key predicate
+	 *
+	 * @private
+	 */
+	ODataModel.prototype.getPredicateIndex = function (sPath) {
+		var iPredicateIndex = sPath.indexOf("(", sPath.lastIndexOf("/"));
+
+		if (iPredicateIndex < 0 || !sPath.endsWith(")")) {
+			throw new Error("Not a list context path to an entity: " + sPath);
+		}
+
+		return iPredicateIndex;
+	};
+
 	/**
 	 * Returns the model's update group ID.
 	 *
@@ -1517,7 +1654,8 @@ sap.ui.define([
 	/**
 	 * Returns <code>true</code> if there are pending changes, meaning updates or created entities
 	 * (see {@link sap.ui.model.odata.v4.ODataListBinding#create}) that have not yet been
-	 * successfully sent to the server.
+	 * successfully sent to the server. Since 1.98.0,
+	 * {@link sap.ui.model.odata.v4.Context#isInactive inactive} contexts are ignored.
 	 *
 	 * @param {string} [sGroupId]
 	 *   A group ID as specified in {@link sap.ui.model.odata.v4.ODataModel}, except group IDs
@@ -1553,12 +1691,25 @@ sap.ui.define([
 		this.oRequestor.refreshSecurityToken().catch(function () {});
 	};
 
+	/**
+	 * Determines whether the given group ID uses mode {@link sap.ui.model.odata.v4.SubmitMode.API}
+	 *
+	 * @param {string} sGroupId
+	 *   The group ID
+	 * @returns {boolean|undefined} Whether it is an API group
+	 *
+	 * @private
+	 */
+	ODataModel.prototype.isApiGroup = function (sGroupId) {
+		return this.getGroupProperty(sGroupId, "submit") === SubmitMode.API;
+	};
+
 	/**
 	 * Determines whether the given group ID uses mode {@link sap.ui.model.odata.v4.SubmitMode.Auto}
 	 *
 	 * @param {string} sGroupId
 	 *   The group ID
-	 * @returns {boolean|undefined} Whether it is an auto group
+	 * @returns {boolean} Whether it is an auto group
 	 *
 	 * @private
 	 */
@@ -1572,7 +1723,7 @@ sap.ui.define([
 	 *
 	 * @param {string} sGroupId
 	 *   The group ID
-	 * @returns {boolean|undefined} Whether it is a direct group
+	 * @returns {boolean} Whether it is a direct group
 	 *
 	 * @private
 	 */
@@ -1663,7 +1814,8 @@ sap.ui.define([
 		}
 		this.checkGroupId(sGroupId);
 
-		// Note: getBindings() returns an array that contains all bindings with change listeners (owned by Model)
+		// Note: getBindings() returns an array that contains all bindings with change listeners
+		// (owned by Model)
 		this.getBindings().forEach(function (oBinding) {
 			if (oBinding.isRoot()) {
 				// ignore the group ID for suspended bindings to avoid mismatches and errors; they
@@ -1673,6 +1825,24 @@ sap.ui.define([
 		});
 	};
 
+	/**
+	 * Returns and releases the temporary keep-alive binding for the given path.
+	 *
+	 * @param {string} sPath - The path
+	 * @returns {sap.ui.model.odata.v4.ODataListBinding|undefined}
+	 *   The binding or <code>undefined</code> if there is none
+	 *
+	 * @private
+	 */
+	ODataModel.prototype.releaseKeepAliveBinding = function (sPath) {
+		var oBinding = this.mKeepAliveBindingsByPath[sPath];
+
+		if (oBinding) {
+			delete this.mKeepAliveBindingsByPath[sPath];
+			return oBinding;
+		}
+	};
+
 	/**
 	 * Reports a technical error by firing a <code>messageChange</code> event with a new message and
 	 * logging the error to the console. Takes care that the error is only reported once via the
@@ -1748,7 +1918,7 @@ sap.ui.define([
 	 *
 	 * @private
 	 */
-	 ODataModel.prototype.reportStateMessages = function (sResourcePath, mPathToODataMessages,
+	ODataModel.prototype.reportStateMessages = function (sResourcePath, mPathToODataMessages,
 			aCachePaths) {
 		var sDataBindingPath = "/" + sResourcePath,
 			aNewMessages = [],
@@ -1836,7 +2006,7 @@ sap.ui.define([
 	 * @param {string[]} aAbsolutePaths
 	 *   The absolute paths to request side effects for; each path must not start with the fully
 	 *   qualified container name.
-	 * @returns {sap.ui.base.SyncPromise}
+	 * @returns {sap.ui.base.SyncPromise|undefined}
 	 *   A promise resolving without a defined result, or rejecting with an error if loading of side
 	 *   effects fails, or <code>undefined</code> if there is nothing to do
 	 *
@@ -1906,7 +2076,7 @@ sap.ui.define([
 	 *   A relative or absolute path within the data model
 	 * @param {sap.ui.model.Context} [oContext]
 	 *   The context to be used as a starting point in case of a relative path
-	 * @returns {string}
+	 * @returns {string|undefined}
 	 *   Resolved path or <code>undefined</code>
 	 *
 	 * @private
@@ -1950,6 +2120,79 @@ sap.ui.define([
 		throw new Error("Unsupported operation: v4.ODataModel#setLegacySyntax");
 	};
 
+	/**
+	 * Getter for the optimistic batch enabler callback function; see
+	 * {@link sap.ui.model.odata.v4.ODataModel#setOptimisticBatchEnabler}.
+	 *
+	 *
+	 * @returns {function(string)}
+	 *   The optimistic batch enabler callback function
+	 *
+	 * @experimental As of version 1.100.0
+	 * @private
+	 * @ui5-restricted sap.fe
+	 */
+	ODataModel.prototype.getOptimisticBatchEnabler = function () {
+		return this.fnOptimisticBatchEnabler;
+	};
+
+	/**
+	 * Setter for the optimistic batch enabler callback function. Setting this callback activates
+	 * the optimistic batch feature. Via the callback the optimistic batch behavior can be enabled
+	 * or disabled by returning either a boolean or a promise resolving with a boolean.
+	 * As its first argument the callback gets the <code>window.location.href</code> at the point in
+	 * time when the OData model is instantiated.
+	 *
+	 * If the callback returns or resolves with <code>true</code>, the OData model remembers the
+	 * first sent $batch request. With the next model instantiation for the same key, this
+	 * remembered $batch request will be sent at the earliest point in time in order to have the
+	 * response already available when the first $batch request is triggered from the UI or the
+	 * binding. If the returned promise is rejected, this error will be reported and the optimistic
+	 * batch will be disabled.
+	 *
+	 * There are several preconditions on the usage of this API:
+	 * <ul>
+	 *   <li> Optimistic batch handling requires the "earlyRequests" model parameter; see
+	 *     {@link sap.ui.model.odata.v4.ODataModel#constructor},
+	 *   <li> the setter has to be called before the first $batch request is sent,
+	 *   <li> the setter may only be called once for an OData model,
+	 *   <li> the callback has to return a boolean, or a <code>Promise</code> resolving with a
+	 *     boolean
+	 *   <li> the callback is not called if the first $batch request is modifying, means that it
+	 *     contains not only GET requests.
+	 * </ul>
+	 *
+	 * @param {function(string):Promise<boolean>|boolean} fnOptimisticBatchEnabler
+	 *   The optimistic batch enabler callback controlling whether optimistic batch should be used
+	 * @throws {Error} If
+	 * <ul>
+	 *   <li> the earlyRequests model parameter is not set,
+	 *   <li> the setter is called after the first $batch request is sent,
+	 *   <li> the given <code>fnOptimisticBatchEnabler</code> parameter is not a function
+	 *   <li> the setter is called more than once
+	 * </ul>
+	 *
+	 * @experimental As of version 1.100.0
+	 * @private
+	 * @ui5-restricted sap.fe
+	 */
+	ODataModel.prototype.setOptimisticBatchEnabler = function (fnOptimisticBatchEnabler) {
+		if (!this.bEarlyRequests) {
+			throw new Error("The earlyRequests model parameter is not set");
+		}
+		if (this.oRequestor.isFirstBatchSent()) {
+			throw new Error("The setter is called after the first $batch request is sent");
+		}
+		if (typeof fnOptimisticBatchEnabler !== "function") {
+			throw new Error("The given fnOptimisticBatchEnabler parameter is not a function");
+		}
+		if (this.fnOptimisticBatchEnabler) {
+			throw new Error("The setter is called more than once");
+		}
+
+		this.fnOptimisticBatchEnabler = fnOptimisticBatchEnabler;
+	};
+
 	/**
 	 * Submits the requests associated with the given group ID in one batch request. Requests from
 	 * subsequent calls to this method for the same group ID may be combined in one batch request