@openui5/sap.ui.core 1.103.1 → 1.104.0

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

@@ -203,7 +203,7 @@ sap.ui.define([
 	 * This model is not prepared to be inherited from.
 	 *
 	 * @author SAP SE
-	 * @version 1.103.1
+	 * @version 1.104.0
 	 *
 	 * @public
 	 * @alias sap.ui.model.odata.v2.ODataModel
@@ -1464,6 +1464,7 @@ sap.ui.define([
 	 * @param {object} oData Data that should be imported
 	 * @param {map} mChangedEntities Map of changed entities
 	 * @param {object} oResponse Response where the data came from
+	 * @param {object} oRequest The request object
 	 * @param {string} [sPath] The path to the data
 	 * @param {string} [sDeepPath] The deep path to the data
 	 * @param {string} [sKey] The cache key to the data if known
@@ -1478,7 +1479,7 @@ sap.ui.define([
 	 * @return {string|string[]} Key of imported data or array of keys in case of nested entries
 	 * @private
 	 */
-	ODataModel.prototype._importData = function(oData, mChangedEntities, oResponse, sPath,
+	ODataModel.prototype._importData = function(oData, mChangedEntities, oResponse, oRequest, sPath,
 			sDeepPath, sKey, bFunctionImport, sPathFromCanonicalParent, bSideEffects) {
 		var that = this,
 			aList, oResult, oEntry, oCurrentEntry;
@@ -1489,7 +1490,7 @@ sap.ui.define([
 			aList = [];
 			each(oData.results, function(i, entry) {
 				var sKey = that._getKey(entry);
-				sKey = that._importData(entry, mChangedEntities, oResponse,
+				sKey = that._importData(entry, mChangedEntities, oResponse, /*oRequest*/undefined,
 					sPath.substr(0, sPath.lastIndexOf("/")), sDeepPath, sKey,
 					/*bFunctionImport*/undefined, /*sPathFromCanonicalParent*/undefined,
 					bSideEffects);
@@ -1545,8 +1546,9 @@ sap.ui.define([
 					var sNewPath = sPath + "/" + sName;
 					var sNewDeepPath = sDeepPath + "/" + sName;
 
-					oResult = that._importData(oProperty, mChangedEntities, oResponse, sNewPath,
-						sNewDeepPath, undefined, false, "/" + sKey + "/" + sName, bSideEffects);
+					oResult = that._importData(oProperty, mChangedEntities, oResponse,
+						/*oRequest*/undefined, sNewPath, sNewDeepPath, undefined, false,
+						"/" + sKey + "/" + sName, bSideEffects);
 					if (Array.isArray(oResult)) {
 						oEntry[sName] = {__list: oResult};
 						if (bSideEffects) {
@@ -1559,7 +1561,6 @@ sap.ui.define([
 									// ODataModel#requestSideEffects; see BLI CPOUI5MODELS-656
 									delete oEntry[sName];
 								});
-
 						}
 					} else {
 						if (oCurrentEntry[sName] && oCurrentEntry[sName].__ref) {
@@ -1577,18 +1578,19 @@ sap.ui.define([
 					oEntry[sName] = oProperty;
 				}
 			});
-			// if we got new data we have to update changed entities
-			var oMap = {};
-			oMap[sKey] = oEntry;
-
 			//if we detect a preliminary context we need to set preliminary false and flag for update
 			if (this.hasContext("/" + sKey) && this.getContext("/" + sKey).isPreliminary()) {
 				var oExistingContext = this.getContext("/" + sKey);
 				oExistingContext.setUpdated(true);
+				this.callAfterUpdate(function() {
+					oExistingContext.setUpdated(false);
+				});
 				oExistingContext.setPreliminary(false);
 			}
-
-			this._updateChangedEntities(oMap);
+			if (oRequest && oRequest.created && oRequest.key) {
+				this._cleanupAfterCreate(oRequest, sKey);
+			}
+			this._updateChangedEntity(sKey, oEntry);
 			mChangedEntities[sKey] = true;
 
 			// if no path information available use the key. This should be the case for create/callFunction
@@ -4268,10 +4270,10 @@ sap.ui.define([
 				if (oRequest.key || oRequest.created) {
 					// no need to pass sideEffects because side-effects requests don't have a key or
 					// a created property attached to the request
-					that._importData(oImportData, mLocalGetEntities, oResponse, /*sPath*/undefined,
-						/*sDeepPath*/undefined, /*sKey*/undefined, bIsFunction);
+					that._importData(oImportData, mLocalGetEntities, oResponse, oRequest,
+						/*sPath*/undefined, /*sDeepPath*/undefined, /*sKey*/undefined, bIsFunction);
 				} else {
-					that._importData(oImportData, mLocalGetEntities, oResponse, sPath,
+					that._importData(oImportData, mLocalGetEntities, oResponse, oRequest, sPath,
 						oRequest.deepPath, /*sKey*/undefined, bIsFunction,
 						/*sPathFromCanonicalParent*/undefined, oRequest.sideEffects);
 				}
@@ -4279,7 +4281,8 @@ sap.ui.define([
 			}
 
 			oEntity = this._getEntity(oRequest.key);
-			if (mLocalGetEntities && oEntity && oEntity.__metadata.created && oEntity.__metadata.created.functionImport) {
+			if (oEntity && oEntity.__metadata.created
+					&& oEntity.__metadata.created.functionImport) {
 				var aResults = [];
 				var oResult = oEntity["$result"];
 				if (oResult && oResult.__list) {
@@ -4301,9 +4304,7 @@ sap.ui.define([
 				if (aParts[1]) {
 					mLocalChangeEntities[aParts[1]] = oRequest;
 					//cleanup of this.mChangedEntities; use only the actual response key
-					var oMap = {};
-					oMap[aParts[1]] = oRequest.data;
-					this._updateChangedEntities(oMap);
+					this._updateChangedEntity(aParts[1], oRequest.data);
 				}
 				//for delete requests delete data in model (exclude $links)
 				if (oRequest.method === "DELETE" && aParts[2] !== "$links") {
@@ -4316,29 +4317,7 @@ sap.ui.define([
 					mEntityTypes[oEntityType.entityType] = true;
 				}
 				if (oRequest.key) {
-					// for createEntry entities change context path to new one
 					if (oRequest.created) {
-						var sKey = this._getKey(oResultData);
-						// rewrite context for new path
-						var oContext = this.getContext("/" + oRequest.key);
-						sDeepPath = oRequest.deepPath;
-						if (oContext.isTransient() && sDeepPath.endsWith(")")) {
-							oRequest.deepPath = sDeepPath.slice(0, sDeepPath.lastIndexOf("("))
-								+ sKey.slice(sKey.indexOf("("));
-						}
-						this._updateContext(oContext, '/' + sKey, oRequest.deepPath);
-						oContext.setUpdated(true);
-						// register function to reset updated flag call as callAfterUpdate
-						this.callAfterUpdate(function() {
-							oContext.setUpdated(false);
-						});
-						//delete created flag after successful creation
-						oEntity = this._getEntity(sKey);
-						if (oEntity) {
-							delete oEntity.__metadata.created;
-							// before deleting the old entity copy and update the changes
-							this._keepChangesAfterCreate(oRequest, oEntity, sKey);
-						}
 						this._removeEntity(oRequest.key);
 					} else {
 						// do not call _removeEntity after successful function import call as
@@ -4381,17 +4360,29 @@ sap.ui.define([
 	 *
 	 * @param {object} oRequest
 	 *   The request object for a created entity
-	 * @param {object} oEntity
-	 *   The persisted and retrieved entity object
 	 * @param {string} sKey
 	 *   The key of the created entity
 	 *
 	 * @private
 	 */
-	ODataModel.prototype._keepChangesAfterCreate = function (oRequest, oEntity, sKey) {
-		var oKey2Entity, aNavProps, sProperty,
-			oChangedEntity = this.mChangedEntities[oRequest.key];
+	ODataModel.prototype._cleanupAfterCreate = function (oRequest, sKey) {
+		var oChangedEntity, aNavProps, sProperty,
+			oContext = this.getContext("/" + oRequest.key),
+			sDeepPath = oRequest.deepPath,
+			oEntity = this._getEntity(sKey);
 
+		if (oContext.isTransient() && sDeepPath.endsWith(")")) {
+			oRequest.deepPath = sDeepPath.slice(0, sDeepPath.lastIndexOf("("))
+				+ sKey.slice(sKey.indexOf("("));
+		}
+		this._updateContext(oContext, '/' + sKey, oRequest.deepPath);
+		oContext.setUpdated(true);
+		this.callAfterUpdate(function() {
+			oContext.setUpdated(false);
+		});
+		delete oEntity.__metadata.created;
+		// before deleting the old entity copy and update the changes
+		oChangedEntity = this.mChangedEntities[oRequest.key];
 		if (oChangedEntity) {
 			aNavProps = this.oMetadata._getNavigationPropertyNames(
 				this.oMetadata._getEntityTypeByPath(sKey));
@@ -4405,13 +4396,10 @@ sap.ui.define([
 				}
 			}
 			this.mChangedEntities[sKey] = oChangedEntity;
-			oKey2Entity = {};
-			oKey2Entity[sKey] = oEntity;
-			this._updateChangedEntities(oKey2Entity);
 			// cleanup also further POST request for the just created entity
 			this.abortInternalRequest(this._resolveGroup(oRequest.key).groupId,
 				{requestKey: oRequest.key});
-		}
+		} // else case may happen if ODataModel#create is called which does not use the cache
 	};
 
 	/**
@@ -4641,25 +4629,29 @@ sap.ui.define([
 	};
 
 	/**
-	 * Resolves batch group settings for an entity.
+	 * Resolves batch group settings based on a given entity key or a given resolved path to an
+	 * entity.
+	 *
+	 * @param {string} sKeyOrPath
+	 *   The entity key or the resolved path to an entity
+	 * @returns {object}
+	 *   Batch group info containing <code>groupId</code> and <code>changeSetId</code>
 	 *
-	 * @param {string} sKey Key of the entity
-	 * @returns {object} Batch group info
 	 * @private
 	 */
-	ODataModel.prototype._resolveGroup = function(sKey) {
-		var oChangeGroup, oEntityType, mParams, sGroupId, sChangeSetId, oData;
+	ODataModel.prototype._resolveGroup = function(sKeyOrPath) {
+		var oChangeGroup, sChangeSetId, mCreated, oData, oEntityType, sGroupId,
+			sPath = sKeyOrPath.startsWith("/") ? sKeyOrPath : ("/" + sKeyOrPath);
 
-		oEntityType = this.oMetadata._getEntityTypeByPath(sKey);
-		oData = this._getObject('/' + sKey);
-		if (oData) {
-			mParams = oData.__metadata.created;
-			//for created entries the group information is retrieved from the params
-			if (mParams) {
-				return {groupId: mParams.groupId, changeSetId: mParams.changeSetId};
-			}
+		oData = this._getObject(sPath);
+		mCreated = oData && oData.__metadata && oData.__metadata.created;
+		//for created entries the group information is retrieved from the params
+		if (mCreated) {
+			return {groupId: mCreated.groupId, changeSetId: mCreated.changeSetId};
 		}
+
 		//resolve groupId/changeSetId
+		oEntityType = this.oMetadata._getEntityTypeByPath(sPath);
 		if (this.mChangeGroups[oEntityType.name]) {
 			oChangeGroup = this.mChangeGroups[oEntityType.name];
 			sGroupId = oChangeGroup.groupId;
@@ -6065,16 +6057,30 @@ sap.ui.define([
 			bRefreshAfterChange = this.bRefreshAfterChange,
 			that = this;
 
-		if (mParameters) {
-			sGroupId = mParameters.groupId || mParameters.batchGroupId;
-			fnSuccess =	mParameters.success;
-			fnError = mParameters.error;
-			// ensure merge parameter backwards compatibility
-			if (mParameters.merge !== undefined) {
-				sMethod =  mParameters.merge ? "MERGE" : "PUT";
-			}
+		mParameters = mParameters || {};
+		sGroupId = mParameters.groupId || mParameters.batchGroupId;
+		fnSuccess = mParameters.success;
+		fnError = mParameters.error;
+		// ensure merge parameter backwards compatibility
+		if (mParameters.merge !== undefined) {
+			sMethod =  mParameters.merge ? "MERGE" : "PUT";
 		}
 
+		this.getBindings().forEach(function (oBinding) {
+			if (oBinding._submitChanges) {
+				var fnOldSuccess = fnSuccess || function () {},
+					mParameters0 = {groupId : sGroupId};
+
+				oBinding._submitChanges(mParameters0);
+				if (mParameters0.success) {
+					fnSuccess = function () {
+						fnOldSuccess.apply(null, arguments);
+						mParameters0.success.apply(null, arguments);
+					};
+				}
+			}
+		});
+
 		if (sGroupId && !this.mDeferredGroups[sGroupId]) {
 			Log.fatal(this + " submitChanges: \"" + sGroupId + "\" is not a deferred group!");
 		}
@@ -6155,13 +6161,19 @@ sap.ui.define([
 		return oRequestHandle;
 	};
 
-	/*
-	 * updateChangedEntities
+	/**
+	 * Updates the object in the shadow cache containing the pending user input and the object in
+	 * the model cache with the given data for the entity with the given key. If all changes for
+	 * that entity are processed the object is removed from the shadow cache.
+	 *
+	 * @param {string} [sEntityKey] The key for the entity to be updated
+	 * @param {object} [oData] The new data for the entity
+	 *
 	 * @private
-	 * @param {map} mChangedEntities Map of changedEntities
 	 */
-	ODataModel.prototype._updateChangedEntities = function(mChangedEntities) {
-		var that = this, sRootPath, oEntityType, oNavPropRefInfo;
+	ODataModel.prototype._updateChangedEntity = function(sEntityKey, oData) {
+		var oChangedEntry, sDeepPath, oEntityType, oEntry, oNavPropRefInfo, sRootPath,
+			that = this;
 
 		function updateChangedEntities(oOriginalObject, oChangedObject, sCurPath) {
 			each(oChangedObject,function(sKey) {
@@ -6175,44 +6187,40 @@ sap.ui.define([
 						|| deepEqual(oChangedObject[sKey], oOriginalObject[sKey])
 							&& !that.isLaundering(sActPath)) {
 					delete oChangedObject[sKey];
-					// When current object is the entity itself check for matching navigation property in changed
-					// entity data and take care of it as well
+					// When current object is the entity itself check for matching navigation
+					// property in changed entity data and take care of it as well
 					if (sCurPath === sRootPath) {
 						oEntityType = that.oMetadata._getEntityTypeByPath(sRootPath);
-						oNavPropRefInfo = oEntityType && that.oMetadata._getNavPropertyRefInfo(oEntityType, sKey);
+						oNavPropRefInfo = oEntityType &&
+							that.oMetadata._getNavPropertyRefInfo(oEntityType, sKey);
 						if (oNavPropRefInfo && oChangedObject[oNavPropRefInfo.name]) {
-							// if the nav prop related to the matching property is also set, set it on original
-							// entry and remove from changed entity
-							oOriginalObject[oNavPropRefInfo.name] = oChangedObject[oNavPropRefInfo.name];
+							// if the nav prop related to the matching property is also set, set it
+							// on original entry and remove it from changed entity
+							oOriginalObject[oNavPropRefInfo.name] =
+								oChangedObject[oNavPropRefInfo.name];
 							delete oChangedObject[oNavPropRefInfo.name];
 						}
 					}
 				}
 			});
 		}
-
-		each(mChangedEntities, function(sKey, oData) {
-			if (sKey in that.mChangedEntities) {
-				var oEntry = that._getObject('/' + sKey, null, true);
-				var oChangedEntry = that._getObject('/' + sKey);
-
-				merge(oEntry, oData);
-
-				sRootPath = '/' + sKey;
-
-				var sDeepPath = that.removeInternalMetadata(oChangedEntry).deepPath;
-				updateChangedEntities(oEntry, oChangedEntry, sRootPath);
-
-				if (isEmptyObject(oChangedEntry)) {
-					delete that.mChangedEntities[sKey];
-					that.abortInternalRequest(that._resolveGroup(sKey).groupId, {requestKey: sKey});
-				} else {
-					that.mChangedEntities[sKey] = oChangedEntry;
-					oChangedEntry.__metadata = {deepPath: sDeepPath};
-					extend(oChangedEntry.__metadata, oEntry.__metadata);
-				}
+		if (sEntityKey in that.mChangedEntities) {
+			oEntry = that._getObject('/' + sEntityKey, null, true);
+			oChangedEntry = that._getObject('/' + sEntityKey);
+			merge(oEntry, oData);
+			sRootPath = '/' + sEntityKey;
+			sDeepPath = that.removeInternalMetadata(oChangedEntry).deepPath;
+			updateChangedEntities(oEntry, oChangedEntry, sRootPath);
+			if (isEmptyObject(oChangedEntry)) {
+				delete that.mChangedEntities[sEntityKey];
+				that.abortInternalRequest(that._resolveGroup(sEntityKey).groupId,
+					{requestKey: sEntityKey});
+			} else {
+				that.mChangedEntities[sEntityKey] = oChangedEntry;
+				oChangedEntry.__metadata = {deepPath: sDeepPath};
+				extend(oChangedEntry.__metadata, oEntry.__metadata);
 			}
-		});
+		}
 	};
 
 	/**

package/src/sap/ui/model/odata/v2/ODataTreeBinding.js

@@ -94,7 +94,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.TreeBinding
 	 * @hideconstructor
 	 * @public
-	 * @version 1.103.1
+	 * @version 1.104.0
 	 */
 	var ODataTreeBinding = TreeBinding.extend("sap.ui.model.odata.v2.ODataTreeBinding", /** @lends sap.ui.model.odata.v2.ODataTreeBinding.prototype */ {
 
@@ -1511,7 +1511,8 @@ sap.ui.define([
 				}
 			}
 			if (mChangedEntities && !bChangeDetected) {
-				bChangeDetected = this._hasChangedEntity(mChangedEntities);
+				bChangeDetected = this._isRefreshAfterChangeAllowed()
+					&& this._hasChangedEntity(mChangedEntities);
 			}
 			if (!mChangedEntities && !mEntityTypes) { // default
 				bChangeDetected = true;
@@ -1525,6 +1526,18 @@ sap.ui.define([
 		}
 	};
 
+	/**
+	 * Checks whether this binding with its configuration is allowed to perform a refresh triggered
+	 * by refreshAfterChange.
+	 *
+	 * @returns {boolean} Whether a refresh caused by refreshAfterChange is allowed
+	 *
+	 * @private
+	 */
+	ODataTreeBinding.prototype._isRefreshAfterChangeAllowed = function () {
+		return true;
+	};
+
 	/**
 	 * Checks whether an entry of <code>this.oKeys</code> matches an entry of
 	 * <code>mChangedEntities</code>.

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

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.39.0
-		 * @version 1.103.1
+		 * @version 1.104.0
 		 */
 		Context = BaseContext.extend("sap.ui.model.odata.v4.Context", {
 				constructor : constructor
@@ -1512,6 +1512,8 @@ sap.ui.define([
 	 * not explicitly kept alive. Once a context is not kept alive anymore, the implicit lifecycle
 	 * management again takes control and destroys the context if it is no longer needed.
 	 *
+	 * Note: This is only supported if the model uses the <code>autoExpandSelect</code> parameter.
+	 *
 	 * @param {boolean} bKeepAlive
 	 *   Whether to keep the context alive
 	 * @param {function} [fnOnBeforeDestroy]

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

@@ -74,7 +74,7 @@ sap.ui.define([
 		 * @mixes sap.ui.model.odata.v4.ODataParentBinding
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.103.1
+		 * @version 1.104.0
 		 *
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding

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

@@ -58,7 +58,7 @@ sap.ui.define([
 		 * @mixes sap.ui.model.odata.v4.ODataParentBinding
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.103.1
+		 * @version 1.104.0
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getUpdateGroupId as #getUpdateGroupId
@@ -2014,6 +2014,7 @@ sap.ui.define([
 				}
 				if (!that.isRootBindingSuspended()) {
 					// request data (before removing virtual context), but avoid E.C.D.
+					// (see BCP: 2270085692 for some interesting discussions)
 					that.bUseExtendedChangeDetection = false;
 					that.getContexts(iStart, iLength, iMaximumPrefetchSize);
 					that.bUseExtendedChangeDetection = bOld;

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

@@ -157,7 +157,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.103.1
+		 * @version 1.104.0
 		 */
 		ODataMetaModel = MetaModel.extend("sap.ui.model.odata.v4.ODataMetaModel", {
 				constructor : constructor

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

@@ -214,7 +214,7 @@ sap.ui.define([
 		 * @extends sap.ui.model.Model
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.103.1
+		 * @version 1.104.0
 		 */
 		ODataModel = Model.extend("sap.ui.model.odata.v4.ODataModel",
 			/** @lends sap.ui.model.odata.v4.ODataModel.prototype */{

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

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @mixes sap.ui.model.odata.v4.ODataBinding
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.103.1
+		 * @version 1.104.0
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getUpdateGroupId as #getUpdateGroupId