@openui5/sap.ui.core 1.97.1 → 1.100.0

package/src/sap/ui/model/odata/v4/lib/_Cache.js

@@ -131,26 +131,29 @@ sap.ui.define([
 	/**
 	 * Deletes an entity on the server and in the cached data.
 	 *
-	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
-	 *   A lock for the group ID
+	 * @param {sap.ui.model.odata.v4.lib._GroupLock} [oGroupLock]
+	 *   A lock for the group ID to be used for the DELETE request; w/o a lock, no DELETE is sent.
+	 *   For a transient entity, the lock is ignored (use NULL)!
 	 * @param {string} sEditUrl
-	 *   The entity's edit URL
+	 *   The entity's edit URL to be used for the DELETE request;  w/o a lock, this is mostly
+	 *   ignored.
 	 * @param {string} sPath
 	 *   The entity's path within the cache (as used by change listeners)
 	 * @param {object} [oETagEntity]
 	 *   An entity with the ETag of the binding for which the deletion was requested. This is
 	 *   provided if the deletion is delegated from a context binding with empty path to a list
-	 *   binding.
+	 *   binding. W/o a lock, this is ignored.
 	 * @param {boolean} [bDoNotRequestCount]
 	 *   Whether not to request the new count from the server; useful in case of
 	 *   {@link sap.ui.model.odata.v4.Context#replaceWith} where it is known that the count remains
-	 *   unchanged
+	 *   unchanged; w/o a lock this should be true
 	 * @param {function} fnCallback
 	 *   A function which is called after a transient entity has been deleted from the cache or
 	 *   after the entity has been deleted from the server and from the cache; the index of the
-	 *   entity and the entity list are passed as parameter
+	 *   entity and the entity list are both passed as parameter, or none of them
 	 * @returns {sap.ui.base.SyncPromise}
-	 *   A promise for the DELETE request
+	 *   A promise which is resolved without a result in case of success, or rejected with an
+	 *   instance of <code>Error</code> in case of failure
 	 * @throws {Error} If the cache is shared
 	 *
 	 * @public
@@ -181,7 +184,6 @@ sap.ui.define([
 				throw new Error("No 'delete' allowed while waiting for server response");
 			}
 			if (sTransientGroup) {
-				oGroupLock.unlock();
 				that.oRequestor.removePost(sTransientGroup, oEntity);
 				return undefined;
 			}
@@ -192,38 +194,38 @@ sap.ui.define([
 			mHeaders = {"If-Match" : oETagEntity || oEntity};
 			sEditUrl += that.oRequestor.buildQueryString(that.sMetaPath, that.mQueryOptions, true);
 			return SyncPromise.all([
-				that.oRequestor.request("DELETE", sEditUrl, oGroupLock.getUnlockedCopy(), mHeaders,
-						undefined, undefined, undefined, undefined,
-						_Helper.buildPath(that.getOriginalResourcePath(oEntity), sEntityPath))
-					.catch(function (oError) {
-						if (oError.status !== 404) {
-							delete oEntity["$ui5.deleting"];
-							throw oError;
-						} // else: map 404 to 200
-					})
-					.then(function () {
-						if (Array.isArray(vCacheData)) {
-							fnCallback(
-								that.removeElement(vCacheData, iIndex, sKeyPredicate, sParentPath),
-								vCacheData);
-						} else {
-							if (vDeleteProperty) {
-								// set to null and notify listeners
-								_Helper.updateExisting(that.mChangeListeners, sParentPath,
-									vCacheData, _Cache.makeUpdateData([vDeleteProperty], null));
-							} else { // deleting at root level
-								oEntity["$ui5.deleted"] = true;
-							}
-							fnCallback();
-						}
-						that.oRequestor.getModelInterface().reportStateMessages(that.sResourcePath,
-							[], [sEntityPath]);
-					}),
+				oGroupLock
+					&& that.oRequestor.request("DELETE", sEditUrl, oGroupLock.getUnlockedCopy(),
+							mHeaders, undefined, undefined, undefined, undefined,
+							_Helper.buildPath(that.getOriginalResourcePath(oEntity), sEntityPath))
+						.catch(function (oError) {
+							if (oError.status !== 404) {
+								delete oEntity["$ui5.deleting"];
+								throw oError;
+							} // else: map 404 to 200
+						}),
 				iIndex === undefined // single element or kept-alive not in list
 					&& !bDoNotRequestCount
 					&& that.requestCount(oGroupLock),
-				oGroupLock.unlock() // unlock when all requests have been queued
-			]);
+				oGroupLock && oGroupLock.unlock() // unlock when all requests have been queued
+			]).then(function () {
+				if (Array.isArray(vCacheData)) {
+					fnCallback(
+						that.removeElement(vCacheData, iIndex, sKeyPredicate, sParentPath),
+						vCacheData);
+				} else {
+					if (vDeleteProperty) {
+						// set to null and notify listeners
+						_Helper.updateExisting(that.mChangeListeners, sParentPath,
+							vCacheData, _Cache.makeUpdateData([vDeleteProperty], null));
+					} else { // deleting at root level
+						oEntity["$ui5.deleted"] = true;
+					}
+					fnCallback();
+				}
+				that.oRequestor.getModelInterface().reportStateMessages(that.sResourcePath,
+					{}, [sEntityPath]);
+			});
 		}).finally(function () {
 			that.removePendingRequest();
 		});
@@ -258,7 +260,7 @@ sap.ui.define([
 	 *   A map from meta path to the entity type (as delivered by {@link #fetchTypes})
 	 * @param {string} sMetaPath
 	 *   The meta path for the entity
-	 * @returns {string}
+	 * @returns {string|undefined}
 	 *   The key predicate or <code>undefined</code>, if key predicate cannot be determined
 	 * @private
 	 */
@@ -290,7 +292,7 @@ sap.ui.define([
 	};
 
 	/**
-	 * Creates a transient entity at the front of the list and adds a POST request to the batch
+	 * Creates a transient entity, inserts it in the list and adds a POST request to the batch
 	 * group with the given ID. If the POST request failed, <code>fnErrorCallback</code> is called
 	 * with an Error object, the POST request is automatically added again to the same batch
 	 * group (for SubmitMode.API) or parked (for SubmitMode.Auto or SubmitMode.Direct). Parked POST
@@ -306,6 +308,9 @@ sap.ui.define([
 	 *   A (temporary) key predicate for the transient entity: "($uid=...)"
 	 * @param {string} [oEntityData={}]
 	 *   The initial entity data
+	 * @param {boolean} bAtEndOfCreated
+	 *   Whether the newly created entity should be inserted after previously created entities or at
+	 *   the front of the list.
 	 * @param {function} fnErrorCallback
 	 *   A function which is called with an error object each time a POST request for the create
 	 *   fails
@@ -319,8 +324,9 @@ sap.ui.define([
 	 * @public
 	 */
 	_Cache.prototype.create = function (oGroupLock, oPostPathPromise, sPath, sTransientPredicate,
-			oEntityData, fnErrorCallback, fnSubmitCallback) {
-		var aCollection,
+			oEntityData, bAtEndOfCreated, fnErrorCallback, fnSubmitCallback) {
+		var aCollection = this.getValue(sPath),
+			sGroupId = oGroupLock.getGroupId(),
 			bKeepTransientPath = oEntityData && oEntityData["@$ui5.keepTransientPath"],
 			oPostBody,
 			that = this;
@@ -330,10 +336,14 @@ sap.ui.define([
 			_Helper.removeByPath(that.mPostRequests, sPath, oEntityData);
 			aCollection.splice(aCollection.indexOf(oEntityData), 1);
 			aCollection.$created -= 1;
-			addToCount(that.mChangeListeners, sPath, aCollection, -1);
+			if (!oEntityData["@$ui5.context.isInactive"]) {
+				that.iActiveElements -= 1;
+				addToCount(that.mChangeListeners, sPath, aCollection, -1);
+			}
 			delete aCollection.$byPredicate[sTransientPredicate];
 			if (!sPath) {
 				// Note: sPath is empty only in a CollectionCache, so we may call adjustReadRequests
+				// Note: index 0 is OK here (see "Must not request created element")
 				that.adjustReadRequests(0, -1);
 			}
 			oGroupLock.cancel();
@@ -347,10 +357,8 @@ sap.ui.define([
 		}
 
 		function request(sPostPath, oPostGroupLock) {
-			var sPostGroupId = oPostGroupLock.getGroupId();
-
 			// mark as transient (again)
-			_Helper.setPrivateAnnotation(oEntityData, "transient", sPostGroupId);
+			_Helper.setPrivateAnnotation(oEntityData, "transient", sGroupId);
 			_Helper.addByPath(that.mPostRequests, sPath, oEntityData);
 			return SyncPromise.all([
 				that.oRequestor.request("POST", sPostPath, oPostGroupLock, null, oPostBody,
@@ -402,14 +410,22 @@ sap.ui.define([
 				if (that.fetchTypes().isRejected()) {
 					throw oError;
 				}
-				sPostGroupId = sPostGroupId.replace(rInactive, "");
-				return request(sPostPath, that.oRequestor.lockGroup(
-					that.oRequestor.getGroupSubmitMode(sPostGroupId) === "API" ?
-						sPostGroupId : "$parked." + sPostGroupId, that, true, true));
+				sGroupId = sGroupId.replace(rInactive, "");
+				sGroupId = that.oRequestor.getGroupSubmitMode(sGroupId) === "API"
+					? sGroupId
+					: "$parked." + sGroupId;
+
+				return request(sPostPath,
+					that.oRequestor.lockGroup(sGroupId, that, true, true));
 			});
 		}
 
 		this.checkSharedRequest();
+		if (!Array.isArray(aCollection)) {
+			throw new Error("Create is only supported for collections; '" + sPath
+				+ "' does not reference a collection");
+		}
+
 		// clone data to avoid modifications outside the cache
 		// remove any property starting with "@$ui5."
 		oEntityData = _Helper.publicClone(oEntityData, true) || {};
@@ -418,15 +434,19 @@ sap.ui.define([
 		_Helper.setPrivateAnnotation(oEntityData, "postBody", oPostBody);
 		_Helper.setPrivateAnnotation(oEntityData, "transientPredicate", sTransientPredicate);
 		oEntityData["@$ui5.context.isTransient"] = true;
+		if (sGroupId.startsWith("$inactive.")) {
+			oEntityData["@$ui5.context.isInactive"] = true;
+		} else {
+			this.iActiveElements += 1;
+			addToCount(this.mChangeListeners, sPath, aCollection, 1);
+		}
 
-		aCollection = this.getValue(sPath);
-		if (!Array.isArray(aCollection)) {
-			throw new Error("Create is only supported for collections; '" + sPath
-				+ "' does not reference a collection");
+		if (bAtEndOfCreated) {
+			aCollection.splice(aCollection.$created, 0, oEntityData);
+		} else {
+			aCollection.unshift(oEntityData);
 		}
-		aCollection.unshift(oEntityData);
 		aCollection.$created += 1;
-		addToCount(this.mChangeListeners, sPath, aCollection, 1);
 		// if the nested collection is empty $byPredicate is not available, create it on demand
 		aCollection.$byPredicate = aCollection.$byPredicate || {};
 		aCollection.$byPredicate[sTransientPredicate] = oEntityData;
@@ -634,7 +654,7 @@ sap.ui.define([
 	 * @param {string} sMissingPropertyPath
 	 *   The path of the missing property relative to oResource; this property is returned so that
 	 *   drillDown can proceed
-	 * @returns {sap.ui.base.SyncPromise}
+	 * @returns {sap.ui.base.SyncPromise|undefined}
 	 *   A promise resolving with the missing property value or <code>undefined</code> if the
 	 *   requested property is not an expected late property; it rejects with an error if the GET
 	 *   request failed, or if the key predicate or the ETag has changed
@@ -645,6 +665,7 @@ sap.ui.define([
 			sRequestedPropertyPath, sMissingPropertyPath) {
 		var sFullResourceMetaPath,
 			sFullResourcePath,
+			sGroupId,
 			sMergeBasePath, // full resource path plus custom query options
 			oPromise,
 			mQueryOptions,
@@ -673,7 +694,7 @@ sap.ui.define([
 				oEntityType = that.fetchType(mTypeForMetaPath, sMetaPath).getResult();
 			}
 			if (sBasePath) {
-				// Key properties, ETag and predicate must only be copied from the result for nested
+				// Key properties and predicate must only be copied from the result for nested
 				// properties. The root property is already loaded and has them already. We check
 				// that they are unchanged in this case.
 				(oEntityType.$Key || []).forEach(function (vKey) {
@@ -682,9 +703,10 @@ sap.ui.define([
 					}
 					aUpdateProperties.push(_Helper.buildPath(sBasePath, vKey));
 				});
-				aUpdateProperties.push(sBasePath + "/@odata.etag");
 				aUpdateProperties.push(sBasePath + "/@$ui5._/predicate");
 			}
+			// Always copy the ETag for the case that the cached entity is still initial
+			aUpdateProperties.push(_Helper.buildPath(sBasePath, "@odata.etag"));
 			if (mQueryOptions0.$expand) {
 				// intersecting the query options with sRequestedPropertyPath delivers exactly one
 				// entry in $expand at each level (one for each navigation property binding)
@@ -720,7 +742,9 @@ sap.ui.define([
 			// allow merge
 			sMergeBasePath = sFullResourcePath
 				+ this.oRequestor.buildQueryString(sFullResourceMetaPath, this.mQueryOptions, true);
-			oPromise = this.oRequestor.request("GET", sMergeBasePath, oGroupLock.getUnlockedCopy(),
+			sGroupId = _Helper.getPrivateAnnotation(oResource, "groupId");
+			oPromise = this.oRequestor.request("GET", sMergeBasePath,
+				sGroupId ? this.oRequestor.lockGroup(sGroupId, this) : oGroupLock.getUnlockedCopy(),
 				undefined, undefined, undefined, undefined, sFullResourceMetaPath, undefined,
 				false, mQueryOptions
 			).then(function (oData) {
@@ -740,7 +764,8 @@ sap.ui.define([
 				throw new Error("GET " + sRequestPath + ": Key predicate changed from "
 					+ _Helper.getPrivateAnnotation(oResource, "predicate") + " to " + sPredicate);
 			}
-			if (oData["@odata.etag"] !== oResource["@odata.etag"]) {
+			// we expect the server to always or never send an ETag for this entity
+			if (oResource["@odata.etag"] && oData["@odata.etag"] !== oResource["@odata.etag"]) {
 				throw new Error("GET " + sRequestPath + ": ETag changed");
 			}
 
@@ -811,7 +836,8 @@ sap.ui.define([
 	 * @private
 	 */
 	_Cache.prototype.fetchTypes = function () {
-		var aPromises, mTypeForMetaPath, that = this;
+		var aPromises, mTypeForMetaPath,
+			that = this;
 
 		/*
 		 * Recursively calls fetchType for all (sub)paths in $expand.
@@ -872,6 +898,24 @@ sap.ui.define([
 	 * @public
 	 */
 
+	/**
+	 * Returns an array containing all current elements of a collection or single cache for the
+	 * given relative path. If there are pending requests, the corresponding promises will be
+	 * ignored and set to <code>undefined</code>.
+	 *
+	 * @param {string} [sPath]
+	 *   Relative path to drill-down into, may be empty (only for collection cache)
+	 * @returns {object[]} The cache elements
+	 */
+	 _Cache.prototype.getAllElements = function (sPath) {
+		if (sPath) {
+			return this.getValue(sPath);
+		}
+		return this.aElements.map(function (oElement) {
+			return oElement instanceof SyncPromise ? undefined : oElement;
+		});
+	};
+
 	/**
 	 * Returns the query options to be used for downloading list data corresponding to the given
 	 * query options.
@@ -947,6 +991,7 @@ sap.ui.define([
 	 *
 	 * @public
 	 */
+	// eslint-disable-next-line valid-jsdoc -- in the subclasses the function does return a value
 	_Cache.prototype.getValue = function (_sPath) {
 		throw new Error("Unsupported operation");
 	};
@@ -999,13 +1044,18 @@ sap.ui.define([
 	 *   The relative path of a binding; must not end with '/'
 	 * @param {boolean} [bIgnoreKeptAlive]
 	 *   Whether to ignore changes which will not be lost by APIs like sort or filter because they
-	 *   relate to a context which is kept alive.
+	 *   relate to a context which is kept alive
+	 * @param {boolean} [bIgnoreTransient]
+	 *   Whether to ignore transient elements on top level which will not be lost by APIs like sort
+	 *   or filter
 	 * @returns {boolean}
 	 *   <code>true</code> if there are pending changes
 	 *
 	 * @public
+	 * @see _CollectionCache#reset
 	 */
-	_Cache.prototype.hasPendingChangesForPath = function (sPath, bIgnoreKeptAlive) {
+	_Cache.prototype.hasPendingChangesForPath = function (sPath, bIgnoreKeptAlive,
+			bIgnoreTransient) {
 		var that = this;
 
 		return Object.keys(this.mPatchRequests).some(function (sRequestPath) {
@@ -1015,7 +1065,12 @@ sap.ui.define([
 						return oPatchPromise.$isKeepAlive();
 					}));
 		}) || Object.keys(this.mPostRequests).some(function (sRequestPath) {
-			return isSubPath(sRequestPath, sPath);
+			return bIgnoreTransient && !sRequestPath
+				? false // ignore transient elements on top level
+				: isSubPath(sRequestPath, sPath)
+					&& that.mPostRequests[sRequestPath].some(function (oEntityData) {
+						return !oEntityData["@$ui5.context.isInactive"];
+					});
 		});
 	};
 
@@ -1178,9 +1233,9 @@ sap.ui.define([
 				oEntity = aElements.$byPredicate[sPredicate];
 			}
 			sKeyFilter = _Helper.getKeyFilter(oEntity, that.sMetaPath, mTypeForMetaPath);
-			sInCollectionFilter =
-				(mQueryOptions.$filter ? "(" + mQueryOptions.$filter + ") and " : "")
-				+ sKeyFilter;
+			sInCollectionFilter
+				= (mQueryOptions.$filter ? "(" + mQueryOptions.$filter + ") and " : "")
+					+ sKeyFilter;
 			delete mQueryOptions.$count;
 			delete mQueryOptions.$orderby;
 
@@ -1237,7 +1292,7 @@ sap.ui.define([
 				} else if (aReadResult.length === 0) {
 					that.removeElement(aElements, iIndex, sPredicate, sPath);
 					that.oRequestor.getModelInterface()
-						.reportStateMessages(that.sResourcePath, [], [sPath + sPredicate]);
+						.reportStateMessages(that.sResourcePath, {}, [sPath + sPredicate]);
 					fnOnRemove(false);
 				} else if (bRemoveFromCollection) {
 					that.removeElement(aElements, iIndex, sPredicate, sPath);
@@ -1271,7 +1326,7 @@ sap.ui.define([
 	/**
 	 * Removes the element at the given index from the given array, taking care of
 	 * <code>$byPredicate</code>, <code>$created</code>, the array's count, and a collection cache's
-	 * limit (if applicable).
+	 * limit and number of active elements (if applicable).
 	 *
 	 * @param {object[]} aElements
 	 *   The array of elements
@@ -1282,7 +1337,7 @@ sap.ui.define([
 	 *   The key predicate of the old element to be removed
 	 * @param {string} sPath
 	 *   The element collection's path within this cache (as used by change listeners), may be
-	 *   <code>""</code>
+	 *   <code>""</code> (only in a CollectionCache)
 	 * @returns {number} The index at which the element actually was (it might have moved due to
 	 *   parallel insert/delete)
 	 *
@@ -1303,14 +1358,18 @@ sap.ui.define([
 		sTransientPredicate = _Helper.getPrivateAnnotation(oElement, "transientPredicate");
 		if (sTransientPredicate) {
 			aElements.$created -= 1;
+			if (!sPath) {
+				this.iActiveElements -= 1;
+			}
 			delete aElements.$byPredicate[sTransientPredicate];
-		} else if (!sPath) {
+		}
+		if (!sPath && iIndex !== undefined) {
 			// Note: sPath is empty only in a CollectionCache, so we may use iLmit and
 			// adjustReadRequests
-			if (iIndex !== undefined) {
+			if (!sTransientPredicate) {
 				this.iLimit -= 1; // this doesn't change Infinity
-				this.adjustReadRequests(iIndex, -1);
 			}
+			this.adjustReadRequests(iIndex, -1);
 		}
 		return iIndex;
 	};
@@ -1369,7 +1428,7 @@ sap.ui.define([
 			mTypeForMetaPath, sPath) {
 		var oOldElement, sTransientPredicate;
 
-		if (iIndex === undefined) {// kept-alive element not in the list
+		if (iIndex === undefined) { // kept-alive element not in the list
 			aElements.$byPredicate[sPredicate] = oElement;
 		} else {
 			// the element might have moved due to parallel insert/delete
@@ -1394,13 +1453,15 @@ sap.ui.define([
 	 *
 	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
 	 *   A lock for the group ID
-	 * @returns {Promise}
-	 *   A promise that resolves if the count has been determined or undefined if no request needed
+	 * @returns {Promise|undefined}
+	 *   A promise that resolves if the count has been determined or <code>undefined</code> if no
+	 *   request needed
 	 *
 	 * @private
 	 */
 	_Cache.prototype.requestCount = function (oGroupLock) {
-		var sExclusiveFilter, mQueryOptions, sReadUrl, that = this;
+		var sExclusiveFilter, mQueryOptions, sReadUrl,
+			that = this;
 
 		if (this.mQueryOptions && this.mQueryOptions.$count) {
 			// now we are definitely in a CollectionCache
@@ -1427,7 +1488,7 @@ sap.ui.define([
 					}
 					throw oError;
 				}).then(function (oResult) {
-					var iCount = parseInt(oResult["@odata.count"]) + that.aElements.$created;
+					var iCount = parseInt(oResult["@odata.count"]) + that.iActiveElements;
 
 					setCount(that.mChangeListeners, "", that.aElements, iCount);
 					that.iLimit = iCount;
@@ -1468,9 +1529,11 @@ sap.ui.define([
 				aEntities = that.mPostRequests[sRequestPath];
 				for (i = aEntities.length - 1; i >= 0; i -= 1) {
 					sTransientGroup = _Helper.getPrivateAnnotation(aEntities[i], "transient");
-					that.oRequestor.removePost(sTransientGroup, aEntities[i]);
+					if (!sTransientGroup.startsWith("$inactive.")) {
+						// this also cleans up that.mPostRequests
+						that.oRequestor.removePost(sTransientGroup, aEntities[i]);
+					}
 				}
-				delete that.mPostRequests[sRequestPath];
 			}
 		});
 	};
@@ -1794,13 +1857,18 @@ sap.ui.define([
 			}
 			// remember the old value
 			vOldValue = _Helper.drillDown(oEntity, aPropertyPath);
-			// write the changed value into the cache
-			_Helper.updateAll(that.mChangeListeners, sEntityPath, oEntity, oUpdateData);
 			oPostBody = _Helper.getPrivateAnnotation(oEntity, "postBody");
 			if (oPostBody) {
-				// change listeners are already informed
+				// change listeners are informed later
 				_Helper.updateAll({}, sEntityPath, oPostBody, oUpdateData);
+				if (oEntity["@$ui5.context.isInactive"]) {
+					oUpdateData["@$ui5.context.isInactive"] = false;
+					that.iActiveElements += 1;
+					addToCount(that.mChangeListeners, "", that.aElements, 1);
+				}
 			}
+			// write the changed value into the cache
+			_Helper.updateAll(that.mChangeListeners, sEntityPath, oEntity, oUpdateData);
 			if (sUnitOrCurrencyPath) {
 				aUnitOrCurrencyPath = sUnitOrCurrencyPath.split("/");
 				sUnitOrCurrencyPath = _Helper.buildPath(sEntityPath, sUnitOrCurrencyPath);
@@ -1838,7 +1906,7 @@ sap.ui.define([
 	 * predicates for all entities in the result. Collects and reports OData messages via
 	 * {@link sap.ui.model.odata.v4.lib._Requestor#reportStateMessages}.
 	 *
-	 * @param {*} oRoot An OData response, arrays or simple values are wrapped into an object as
+	 * @param {any} oRoot An OData response, arrays or simple values are wrapped into an object as
 	 *   property "value"
 	 * @param {object} mTypeForMetaPath A map from absolute meta path to entity type (as delivered
 	 *   by {@link #fetchTypes})
@@ -1896,7 +1964,7 @@ sap.ui.define([
 		 * Calls visitInstance for all object entries of the given collection and creates the map
 		 * $byPredicate from predicate to entity.
 		 *
-		 * @param {*[]} aInstances The collection
+		 * @param {any[]} aInstances The collection
 		 * @param {string} sMetaPath The meta path of the collection in mTypeForMetaPath
 		 * @param {string} sCollectionPath The path of the collection
 		 * @param {string} sContextUrl The context URL for message longtexts
@@ -2046,11 +2114,14 @@ sap.ui.define([
 				return sDeepResourcePath;
 			}, bSharedRequest);
 
+		this.iActiveElements = 0; // number of active (client-side) created elements
+		this.oBackup = null; // see #reset
 		this.sContext = undefined; // the "@odata.context" from the responses
 		this.aElements = []; // the available elements
 		this.aElements.$byPredicate = {};
 		this.aElements.$count = undefined; // see setCount
-		this.aElements.$created = 0; // number of (client-side) created elements
+		// number of all (client-side) created elements (active or inactive)
+		this.aElements.$created = 0;
 		this.aElements.$tail = undefined; // promise for a read w/o $top
 		// upper limit for @odata.count, maybe sharp; assumes #getQueryString can $filter out all
 		// created elements
@@ -2095,6 +2166,24 @@ sap.ui.define([
 		});
 	};
 
+	/**
+	 * Creates an empty element for the given predicate to the cache, adds it to the cache and
+	 * returns it.
+	 *
+	 * @param {string} sPredicate - The predicate
+	 * @returns {object} The empty element
+	 *
+	 * @public
+	 */
+	_CollectionCache.prototype.createEmptyElement = function (sPredicate) {
+		var oElement = {};
+
+		_Helper.setPrivateAnnotation(oElement, "predicate", sPredicate);
+		this.aElements.$byPredicate[sPredicate] = oElement;
+
+		return oElement;
+	};
+
 	/**
 	 * Replaces the old element at the given index with the given new element.
 	 *
@@ -2197,13 +2286,13 @@ sap.ui.define([
 		for (i = iStart; i < iEnd; i += 1) {
 			this.aElements[i] = oPromise;
 		}
-		this.oSyncPromiseAll = undefined;  // from now on, fetchValue has to wait again
+		this.oSyncPromiseAll = undefined; // from now on, fetchValue has to wait again
 	};
 
 	/**
 	 * Returns a filter that excludes all created entities in this cache's collection.
 	 *
-	 * @returns {string}
+	 * @returns {string|undefined}
 	 *   The filter or <code>undefined</code> if there is no created entity.
 	 *
 	 * @private
@@ -2227,7 +2316,7 @@ sap.ui.define([
 			}
 		}
 
-		return aKeyFilters.length ? "not (" + aKeyFilters.join(" or ") + ")" : undefined;
+		return aKeyFilters.length ? "not (" + aKeyFilters.sort().join(" or ") + ")" : undefined;
 	};
 
 	/**
@@ -2266,7 +2355,8 @@ sap.ui.define([
 	 *   The start index of the range
 	 * @param {number} iEnd
 	 *   The index after the last element
-	 * @returns {string} The resource path including the query string
+	 * @returns {string}
+	 *   The resource path including the query string
 	 * @throws {Error}
 	 *   If there are created elements inside the given range
 	 *
@@ -2319,11 +2409,12 @@ sap.ui.define([
 	 * @private
 	 */
 	_CollectionCache.prototype.handleResponse = function (iStart, iEnd, oResult, mTypeForMetaPath) {
-		var iCount = -1,
-			sCount,
+		var sCount,
 			iCreated = this.aElements.$created,
 			oElement,
 			oKeptElement,
+			iLimit = -1,
+			iOffset = 0,
 			iOld$count = this.aElements.$count,
 			sPredicate,
 			iResultLength = oResult.value.length,
@@ -2337,7 +2428,14 @@ sap.ui.define([
 			if (sPredicate) {
 				oKeptElement = this.aElements.$byPredicate[sPredicate];
 				if (oKeptElement) {
-					if (oElement["@odata.etag"] === oKeptElement["@odata.etag"]) {
+					// we expect the server to always or never send an ETag for this entity
+					if (!oKeptElement["@odata.etag"]
+							|| oElement["@odata.etag"] === oKeptElement["@odata.etag"]) {
+						if (_Helper.hasPrivateAnnotation(oKeptElement, "transientPredicate")) {
+							// client-side filter for newly created persisted
+							iOffset += 1;
+							continue;
+						}
 						_Helper.updateNonExisting(oKeptElement, oElement);
 						oElement = oKeptElement;
 					} else if (this.hasPendingChangesForPath(sPredicate)) {
@@ -2347,11 +2445,15 @@ sap.ui.define([
 				}
 				this.aElements.$byPredicate[sPredicate] = oElement;
 			}
-			this.aElements[iStart + i] = oElement;
+			this.aElements[iStart + i - iOffset] = oElement;
 		}
+		// simulate #getFilterExcludingCreated for newly created persisted
+		iEnd -= iOffset;
+		iResultLength -= iOffset;
+
 		sCount = oResult["@odata.count"];
 		if (sCount) {
-			this.iLimit = iCount = parseInt(sCount);
+			this.iLimit = iLimit = parseInt(sCount);
 		}
 		if (oResult["@odata.nextLink"]) { // server-driven paging
 			this.bServerDrivenPaging = true;
@@ -2363,25 +2465,26 @@ sap.ui.define([
 				this.aElements.length = iStart + iResultLength;
 			}
 		} else if (iResultLength < iEnd - iStart) { // short read
-			if (iCount === -1) {
+			if (iLimit === -1) {
 				// use formerly computed $count
-				iCount = iOld$count && iOld$count - iCreated;
+				iLimit = iOld$count && iOld$count - this.iActiveElements;
 			}
-			iCount = Math.min(
-				iCount !== undefined ? iCount : Infinity,
+			iLimit = Math.min(
+				iLimit !== undefined ? iLimit : Infinity,
+				// length determined from the short read
 				iStart - iCreated + iResultLength);
-			this.aElements.length = iCreated + iCount;
-			this.iLimit = iCount;
+			this.aElements.length = iCreated + iLimit;
+			this.iLimit = iLimit;
 			// If the server did not send a count, the calculated count is greater than 0
 			// and the element before has not been read yet, we do not know the count:
 			// The element might or might not exist.
-			if (!sCount && iCount > 0 && !this.aElements[iCount - 1]) {
-				iCount = undefined;
+			if (!sCount && iLimit > 0 && !this.aElements[iLimit - 1]) {
+				iLimit = undefined;
 			}
 		}
-		if (iCount !== -1) {
+		if (iLimit !== -1) {
 			setCount(this.mChangeListeners, "", this.aElements,
-				iCount !== undefined ? iCount + iCreated : undefined);
+				iLimit !== undefined ? iLimit + this.iActiveElements : undefined);
 		}
 	};
 
@@ -2420,7 +2523,9 @@ sap.ui.define([
 	_CollectionCache.prototype.read = function (iIndex, iLength, iPrefetchLength, oGroupLock,
 			fnDataRequested) {
 		var aElementsRange,
+			iEnd,
 			oPromise = this.oPendingRequestsPromise || this.aElements.$tail,
+			iTransientElements,
 			that = this;
 
 		if (iIndex < 0) {
@@ -2436,6 +2541,15 @@ sap.ui.define([
 			});
 		}
 
+		// prepare for client-side filter for newly created persisted (see #handleResponse)
+		iTransientElements = this.aElements.slice(0, this.aElements.$created)
+			.filter(function (oElement) {
+				return _Helper.getPrivateAnnotation(oElement, "transient")
+					=== oGroupLock.getGroupId();
+			})
+			.length;
+		iPrefetchLength = Math.max(iPrefetchLength, iTransientElements);
+
 		ODataUtils._getReadIntervals(this.aElements, iIndex, iLength,
 				this.bServerDrivenPaging ? 0 : iPrefetchLength,
 				this.aElements.$created + this.iLimit)
@@ -2447,8 +2561,9 @@ sap.ui.define([
 
 		oGroupLock.unlock();
 
-		aElementsRange = this.aElements.slice(iIndex, iIndex + iLength + iPrefetchLength);
-		if (this.aElements.$tail && iIndex + iLength > this.aElements.length) {
+		iEnd = iIndex + iLength + iPrefetchLength;
+		aElementsRange = this.aElements.slice(iIndex, iEnd);
+		if (this.aElements.$tail && iEnd > this.aElements.length) {
 			aElementsRange.push(this.aElements.$tail);
 		}
 		return SyncPromise.all(aElementsRange).then(function () {
@@ -2465,22 +2580,25 @@ sap.ui.define([
 
 	/**
 	 * Refreshes the kept-alive elements. This needs to be called before the cache has filled the
-	 * collection. In that state the $byPredicate contains only the kept-alive elements.
+	 * collection. In that state the $byPredicate contains only the kept-alive and created elements.
 	 *
 	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
 	 *   A lock for the group ID
-	 * @param {function} fnOnRemove
-	 *   A function which is called if a kept-alive element does no longer exist
-	 * @returns {sap.ui.base.SyncPromise}
+	 * @param {function(string,number)} fnOnRemove
+	 *   A function which is called with predicate and index if a kept-alive or created element does
+	 *   no longer exist after refresh; the index is undefined for a non-created element
+	 * @returns {sap.ui.base.SyncPromise|undefined}
 	 *   A promise resolving without a defined result, or rejecting with an error if the refresh
 	 *   fails, or <code>undefined</code> if there are no kept-alive elements.
 	 *
 	 * @public
 	 */
 	_CollectionCache.prototype.refreshKeptElements = function (oGroupLock, fnOnRemove) {
-		var aPredicates = Object.keys(this.aElements.$byPredicate).sort(),
-			mTypes,
-			that = this;
+		var that = this,
+			// Note: at this time only kept-alive and created elements are in the cache, but we
+			// don't care if $byPredicate still contains two entries for the same element
+			aPredicates = Object.keys(this.aElements.$byPredicate).filter(isRefreshNeeded).sort(),
+			mTypes;
 
 		/*
 		 * Calculates a query to request the kept-alive elements.
@@ -2499,7 +2617,6 @@ sap.ui.define([
 			delete mQueryOptions.$orderby;
 			delete mQueryOptions.$search;
 
-			// Note: at this time only kept-alive elements are in the cache
 			aKeyFilters = aPredicates.map(function (sPredicate) {
 				return _Helper.getKeyFilter(that.aElements.$byPredicate[sPredicate], that.sMetaPath,
 					mTypes);
@@ -2514,6 +2631,20 @@ sap.ui.define([
 				+ that.oRequestor.buildQueryString(that.sMetaPath, mQueryOptions, false, true);
 		}
 
+		/*
+		 * Tells whether a refresh is needed for the given predicate. Transient predicates and
+		 * elements with pending changes need no refresh.
+		 *
+		 * @param {string} sPredicate - A key predicate
+		 * @returns {boolean} - Whether a refresh is needed
+		 */
+		function isRefreshNeeded(sPredicate) {
+			var oElement = that.aElements.$byPredicate[sPredicate];
+
+			return _Helper.getPrivateAnnotation(oElement, "predicate") === sPredicate
+				&& !that.hasPendingChangesForPath(sPredicate);
+		}
+
 		if (aPredicates.length === 0) {
 			return undefined;
 		}
@@ -2528,13 +2659,20 @@ sap.ui.define([
 				mStillAliveElements = oResponse.value.$byPredicate || {};
 
 				aPredicates.forEach(function (sPredicate) {
+					var oElement, iIndex;
+
 					if (sPredicate in mStillAliveElements) {
 						_Helper.updateAll(that.mChangeListeners, sPredicate,
 							that.aElements.$byPredicate[sPredicate],
 							mStillAliveElements[sPredicate]);
 					} else {
-						delete that.aElements.$byPredicate[sPredicate];
-						fnOnRemove(sPredicate);
+						oElement = that.aElements.$byPredicate[sPredicate];
+						if (_Helper.getPrivateAnnotation(oElement, "transientPredicate")) {
+							iIndex = that.removeElement(that.aElements, -1, sPredicate, "");
+						} else {
+							delete that.aElements.$byPredicate[sPredicate];
+						}
+						fnOnRemove(sPredicate, iIndex);
 					}
 				});
 			});
@@ -2702,7 +2840,7 @@ sap.ui.define([
 
 		return this.oRequestor.request("GET", sResourcePath, oGroupLock, undefined, undefined,
 				undefined, undefined, this.sMetaPath, undefined, false, mMergeableQueryOptions,
-				function (aOtherPaths) {
+				this, function (aOtherPaths) {
 					if (arguments.length) {
 						aPaths = aPaths.concat(aOtherPaths);
 					} else {
@@ -2743,24 +2881,55 @@ sap.ui.define([
 
 	/**
 	 * Resets this cache to its initial state, but keeps certain elements and their change listeners
-	 * alive.
+	 * alive: all kept-alive elements identified by the given key predicates as well as all
+	 * transient elements on top level.
 	 *
 	 * @param {string[]} aKeptElementPredicates
 	 *   The key predicates for all kept-alive elements
+	 * @param {boolean} [bKeepCreated]
+	 *   Whether created persisted elements that started as inactive shall be kept in place and a
+	 *   backup shall be remembered for a later {@link #restore}
 	 *
 	 * @public
+	 * @see _Cache#hasPendingChangesForPath
 	 */
-	_CollectionCache.prototype.reset = function (aKeptElementPredicates) {
-		var mChangeListeners = this.mChangeListeners,
-			mByPredicate = this.aElements.$byPredicate,
+	_CollectionCache.prototype.reset = function (aKeptElementPredicates, bKeepCreated) {
+		var mByPredicate = this.aElements.$byPredicate,
+			mChangeListeners = this.mChangeListeners,
+			iCreated = 0, // index (and finally number) of created elements that we keep
+			oElement,
+			i,
 			that = this;
 
+		if (bKeepCreated) {
+			this.oBackup = {};
+			this.oBackup.iActiveElements = this.iActiveElements;
+			this.oBackup.mChangeListeners = this.mChangeListeners;
+			this.oBackup.sContext = this.sContext;
+			this.oBackup.aElements = this.aElements.slice();
+			this.oBackup.$byPredicate = mByPredicate;
+			this.oBackup.$count = this.aElements.$count;
+			this.oBackup.$created = this.aElements.$created;
+			this.oBackup.iLimit = this.iLimit;
+		}
+
+		for (i = 0; i < this.aElements.$created; i += 1) {
+			oElement = this.aElements[i];
+			if (_Helper.getPrivateAnnotation(oElement, "transient")
+					|| bKeepCreated && "@$ui5.context.isInactive" in oElement) {
+				aKeptElementPredicates.push(_Helper.getPrivateAnnotation(oElement, "predicate")
+					|| _Helper.getPrivateAnnotation(oElement, "transientPredicate"));
+				this.aElements[iCreated] = oElement;
+				iCreated += 1;
+			} else { // Note: "created persisted" elements must be active
+				this.iActiveElements -= 1;
+			}
+		}
 		this.mChangeListeners = {};
 		this.sContext = undefined;
-		this.aElements = [];
+		this.aElements.length = this.aElements.$created = iCreated;
 		this.aElements.$byPredicate = {};
 		this.aElements.$count = undefined; // needed for setCount()
-		this.aElements.$created = 0;
 		this.iLimit = Infinity;
 
 		Object.keys(mChangeListeners).forEach(function (sPath) {
@@ -2773,6 +2942,32 @@ sap.ui.define([
 		});
 	};
 
+	/**
+	 * Restores the last backup taken by {@link #reset} with <code>bKeepCreated</code>, if told to
+	 * really do so; drops the backup in any case to free memory.
+	 *
+	 * @param {boolean} bReally - Whether to really restore, not just drop the backup
+	 *
+	 * @public
+	 */
+	_CollectionCache.prototype.restore = function (bReally) {
+		if (bReally) {
+			this.iActiveElements = this.oBackup.iActiveElements;
+			this.mChangeListeners = this.oBackup.mChangeListeners;
+			this.sContext = this.oBackup.sContext;
+			// Note: do not change reference to this.aElements! It's kept in closures :-(
+			this.aElements.length = this.oBackup.aElements.length;
+			this.oBackup.aElements.forEach(function (oElement, i) {
+				this[i] = oElement;
+			}, this.aElements);
+			this.aElements.$byPredicate = this.oBackup.$byPredicate;
+			this.aElements.$count = this.oBackup.$count;
+			this.aElements.$created = this.oBackup.$created;
+			this.iLimit = this.oBackup.iLimit;
+		}
+		this.oBackup = null;
+	};
+
 	//*********************************************************************************************
 	// PropertyCache
 	//*********************************************************************************************
@@ -3134,7 +3329,6 @@ sap.ui.define([
 	_SingleCache.prototype.requestSideEffects = function (oGroupLock, aPaths,
 			mNavigationPropertyPaths, sResourcePath) {
 		var mMergeableQueryOptions,
-			oOldValuePromise = this.oPromise,
 			mQueryOptions,
 			oResult,
 			bSkip,
@@ -3142,7 +3336,7 @@ sap.ui.define([
 
 		this.checkSharedRequest();
 
-		mQueryOptions = oOldValuePromise && _Helper.intersectQueryOptions(
+		mQueryOptions = this.oPromise && _Helper.intersectQueryOptions(
 			Object.assign({}, this.mQueryOptions, this.mLateQueryOptions), aPaths,
 			this.oRequestor.getModelInterface().fetchMetadata,
 			this.sMetaPath, mNavigationPropertyPaths);
@@ -3156,7 +3350,7 @@ sap.ui.define([
 		oResult = SyncPromise.all([
 			this.oRequestor.request("GET", sResourcePath, oGroupLock, undefined, undefined,
 				undefined, undefined, this.sMetaPath, undefined, false, mMergeableQueryOptions,
-				function (aOtherPaths) {
+				this, function (aOtherPaths) {
 					if (arguments.length) {
 						aPaths = aPaths.concat(aOtherPaths);
 					} else {
@@ -3395,6 +3589,7 @@ sap.ui.define([
 	_Cache.makeUpdateData = function (aPropertyPath, vValue) {
 		return aPropertyPath.reduceRight(function (vValue0, sSegment) {
 			var oResult = {};
+
 			oResult[sSegment] = vValue0;
 			return oResult;
 		}, vValue);