@openui5/sap.ui.core 1.112.2 → 1.114.0

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

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.39.0
-		 * @version 1.112.2
+		 * @version 1.114.0
 		 */
 		Context = BaseContext.extend("sap.ui.model.odata.v4.Context", {
 				constructor : constructor
@@ -267,7 +267,7 @@ sap.ui.define([
 	 *     <li> a <code>null</code> group ID is used with a context which is not
 	 *       {@link #isKeepAlive kept alive},
 	 *     <li> the context is already being deleted,
-	 *     <li> the context's binding is a list binding with data aggregation,
+	 *     <li> the context's binding is a list binding with data aggregation.
 	 *   </ul>
 	 *
 	 * @function
@@ -978,13 +978,15 @@ sap.ui.define([
 	 * @since 1.53.0
 	 */
 	Context.prototype.hasPendingChanges = function () {
+		var that = this;
+
 		return this.isTransient() && this.isInactive() !== true
 			|| this.oDeletePromise && this.oDeletePromise.isPending()
 			|| this.oBinding.hasPendingChangesForPath(this.sPath)
 			|| this.oModel.getDependentBindings(this).some(function (oDependentBinding) {
 				return oDependentBinding.oCache
-					? oDependentBinding._hasPendingChanges(false, true)
-					: oDependentBinding.hasPendingChangesInDependents(false, true);
+					? oDependentBinding._hasPendingChanges(false, that.sPath)
+					: oDependentBinding.hasPendingChangesInDependents(false, that.sPath);
 			})
 			|| this.oModel.withUnresolvedBindings("hasPendingChangesInCaches", this.sPath.slice(1));
 	};
@@ -1663,9 +1665,6 @@ sap.ui.define([
 	 * context which is currently {@link #delete deleted} on the client, but not yet on the server,
 	 * this method cancels the deletion and restores the context.
 	 *
-	 * Note: This is an experimental API. Currently only row contexts of an
-	 * {@link sap.ui.model.odata.v4.ODataListBinding} are supported.
-	 *
 	 * @returns {Promise}
 	 *   A promise which is resolved without a defined result as soon as all changes in the context
 	 *   and its current dependent bindings are canceled
@@ -1676,19 +1675,26 @@ sap.ui.define([
 	 *     yet,
 	 *   <li> this context is transient, but not inactive and therefore should rather be reset via
 	 *     {@link #delete}.
+	 *   <li> this context is a
+	 *     {@link sap.ui.model.odata.v4.ODataListBinding#getHeaderContext header context}.
+	 *   <li> this context is a
+	 *     {@link sap.ui.model.odata.v4.ODataContextBinding#getParameterContext parameter context}.
 	 * </ul>
 	 *
-	 * @experimental As of version 1.109.0
 	 * @public
 	 * @see #hasPendingChanges
+	 * @since 1.113.0
 	 */
 	Context.prototype.resetChanges = function () {
 		var aPromises = this.oDeletePromise
 				? [this.oDeletePromise.catch(function () { /*already handled in #delete*/ })]
-				: [];
+				: [],
+			that = this;
 
-		if (this.isTransient() && !this.isInactive()) {
-			throw new Error("Cannot reset a transient context: " + this);
+		if (this.iIndex === iVIRTUAL || this.isTransient() && !this.isInactive()
+			|| this.oBinding.getHeaderContext && this === this.oBinding.getHeaderContext()
+			|| this.oBinding.getParameterContext && this === this.oBinding.getParameterContext()) {
+			throw new Error("Cannot reset: " + this);
 		}
 
 		this.oBinding.checkSuspended();
@@ -1698,9 +1704,9 @@ sap.ui.define([
 		}
 		this.oModel.getDependentBindings(this).forEach(function (oDependentBinding) {
 			if (oDependentBinding.oCache) {
-				aPromises.push(oDependentBinding._resetChanges(true));
+				aPromises.push(oDependentBinding._resetChanges(that.sPath));
 			} else {
-				oDependentBinding.resetChangesInDependents(aPromises, true);
+				oDependentBinding.resetChangesInDependents(aPromises, that.sPath);
 				oDependentBinding.resetInvalidDataState();
 			}
 		});
@@ -1765,13 +1771,15 @@ sap.ui.define([
 	 *     <li> it is the header context,
 	 *     <li> it is transient,
 	 *     <li> it is deleted and <code>bKeepAlive</code> is <code>true</code>,
+	 *     <li> it is not part of the list binding's collection, has
+	 *       {@link #hasPendingChanges pending changes}, and shall not be kept alive anymore,
 	 *     <li> it does not point to an entity,
 	 *     <li> a key property of the entity has not been requested,
 	 *     <li> the list binding is relative and does not use the <code>$$ownRequest</code>
 	 *       parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}),
 	 *     <li> the list binding uses or inherits the <code>$$sharedRequest</code> parameter
 	 *       (see {@link sap.ui.model.odata.v4.ODataModel#bindList}),
-	 *     <li> the list binding uses data aggregation
+	 *     <li> the list binding uses data aggregation, but no recursive hierarchy
 	 *       (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}),
 	 *     <li> messages are requested, but the model does not use the <code>autoExpandSelect</code>
 	 *       parameter.
@@ -1788,7 +1796,7 @@ sap.ui.define([
 			throw new Error("Unsupported context " + this);
 		}
 		_Helper.getPredicateIndex(this.sPath);
-		this.oBinding.checkKeepAlive(this);
+		this.oBinding.checkKeepAlive(this, bKeepAlive);
 
 		if (bKeepAlive && bRequestMessages) {
 			if (!this.oModel.bAutoExpandSelect) {
@@ -1974,16 +1982,23 @@ sap.ui.define([
 	};
 
 	/**
-	 * Recursively updates all dependent bindings after a create. Does not wait, but reports an
-	 * error if something went wrong.
+	 * Recursively updates all dependent bindings of a created context immediately after it has been
+	 * persisted. Reports an error if the update fails.
+	 *
+	 * @param {boolean} bSkipRefresh
+	 *   Whether the application wants to skip the automatic refresh
+	 * @param {string} sGroupId
+	 *   The group ID for missing properties requests
 	 *
 	 * @private
 	 * @see sap.ui.model.odata.v4.ODataListBinding#create
 	 */
-	Context.prototype.updateAfterCreate = function () {
-		SyncPromise.all(this.oModel.getDependentBindings(this).map(function (oDependentBinding) {
-			return oDependentBinding.updateAfterCreate();
-		})).catch(this.oModel.getReporter());
+	Context.prototype.updateAfterCreate = function (bSkipRefresh, sGroupId) {
+		SyncPromise.all(
+			this.oModel.getDependentBindings(this).map(function (oDependentBinding) {
+				return oDependentBinding.updateAfterCreate(bSkipRefresh, sGroupId);
+			})
+		).catch(this.oModel.getReporter());
 	};
 
 	/**

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

@@ -60,22 +60,23 @@ sap.ui.define([
 	 * Returns <code>true</code> if this binding or its dependent bindings have changes.
 	 *
 	 * Note: This private function is needed in order to hide the additional parameter
-	 * <code>bIgnoreInactiveCaches</code> from the public API {@link #hasPendingChanges}.
+	 * <code>sPathPrefix</code> from the public API {@link #hasPendingChanges}.
 	 *
 	 * @param {boolean} [bIgnoreKeptAlive]
 	 *   Whether to ignore changes which will not be lost by certain APIs, see
 	 *   {@link #hasPendingChanges}
-	 * @param {boolean} [bIgnoreInactiveCaches]
-	 *   Whether to ignore changes in inactive caches
+	 * @param {boolean} [sPathPrefix]
+	 *   If supplied, only caches having a resource path starting with <code>sPathPrefix</code> are
+	 *   checked
 	 * @returns {boolean}
 	 *   <code>true</code> if the binding is resolved and has pending changes
 	 *
 	 * @private
 	 */
-	ODataBinding.prototype._hasPendingChanges = function (bIgnoreKeptAlive, bIgnoreInactiveCaches) {
+	ODataBinding.prototype._hasPendingChanges = function (bIgnoreKeptAlive, sPathPrefix) {
 		return this.isResolved()
 			&& (this.hasPendingChangesForPath("", bIgnoreKeptAlive)
-				|| this.hasPendingChangesInDependents(bIgnoreKeptAlive, bIgnoreInactiveCaches));
+				|| this.hasPendingChangesInDependents(bIgnoreKeptAlive, sPathPrefix));
 	};
 
 	/**
@@ -83,10 +84,11 @@ sap.ui.define([
 	 * invalid user input.
 	 *
 	 * Note: This private function is needed in order to hide the additional parameter
-	 * <code>bIgnoreInactiveCaches</code> from the public API {@link #resetChanges}.
+	 * <code>sPathPrefix</code> from the public API {@link #resetChanges}.
 	 *
-	 * @param {boolean} [bIgnoreInactiveCaches]
-	 *   Whether to ignore changes in inactive caches
+	 * @param {boolean} [sPathPrefix]
+	 *   If supplied, only caches having a resource path starting with <code>sPathPrefix</code> are
+	 *   reset
 	 * @returns {Promise}
 	 *   A promise which is resolved without a defined result as soon as all changes in the binding
 	 *   itself and all dependent bindings are canceled
@@ -96,12 +98,12 @@ sap.ui.define([
 	 *
 	 * @private
 	 */
-	ODataBinding.prototype._resetChanges = function (bIgnoreInactiveCaches) {
+	ODataBinding.prototype._resetChanges = function (sPathPrefix) {
 		var aPromises = [];
 
 		this.checkSuspended();
 		this.resetChangesForPath("", aPromises);
-		this.resetChangesInDependents(aPromises, bIgnoreInactiveCaches);
+		this.resetChangesInDependents(aPromises, sPathPrefix);
 		this.resetInvalidDataState();
 
 		return Promise.all(aPromises).then(function () {});
@@ -222,8 +224,9 @@ sap.ui.define([
 							"$$getKeepAliveContext requires $$ownRequest in a relative binding");
 					}
 					["$$aggregation", "$$canonicalPath", "$$sharedRequest"]
-						.forEach(function (sForbidden) {
-							if (sForbidden in mParameters) {
+						.forEach(function (sForbidden, i) {
+							if (sForbidden in mParameters
+									&& (i > 0 || _Helper.isDataAggregation(mParameters))) {
 								throw new Error("Cannot combine $$getKeepAliveContext and "
 									+ sForbidden);
 							}
@@ -265,6 +268,20 @@ sap.ui.define([
 		}
 	};
 
+	/**
+	 * Throws an Error if the binding is {@link #isTransient transient}.
+	 *
+	 * @throws {Error} If the binding is transient
+	 *
+	 * @private
+	 */
+	ODataBinding.prototype.checkTransient = function () {
+		if (this.isTransient()) {
+			throw new Error("Must not call method when the binding is part of a deep create: "
+				+ this);
+		}
+	};
+
 	/**
 	 * Calls {@link #checkUpdateInternal}.
 	 *
@@ -1015,8 +1032,9 @@ sap.ui.define([
 	 * @param {boolean} [bIgnoreKeptAlive]
 	 *   Whether to ignore changes which will not be lost by APIs like sort or filter because they
 	 *   relate to a deleted context or a context which is kept alive
-	 * @param {boolean} [bIgnoreInactiveCaches]
-	 *   Whether to ignore changes in inactive caches
+	 * @param {boolean} [sPathPrefix]
+	 *   If supplied, only caches having a resource path starting with <code>sPathPrefix</code> are
+	 *   checked
 	 * @returns {boolean}
 	 *   <code>true</code> if this binding has pending changes
 	 *
@@ -1348,14 +1366,20 @@ sap.ui.define([
 	 * @returns {Promise}
 	 *   A promise which is resolved without a defined result as soon as all changes in the binding
 	 *   itself and all dependent bindings are canceled (since 1.72.0)
-	 * @throws {Error}
-	 *   If the binding's root binding is suspended or if there is a change of this binding which
-	 *   has been sent to the server and for which there is no response yet
+	 * @throws {Error} If
+	 *   <ul>
+	 *     <li> the binding's root binding is suspended,
+	 *     <li> there is a change of this binding which has been sent to the server and for which
+	 *       there is no response yet,
+	 *     <li> the binding is {@link #isTransient transient} (part of a
+	 *       {@link sap.ui.model.odata.v4.ODataListBinding#create deep create}).
+	 *   </ul>
 	 *
 	 * @public
 	 * @since 1.40.1
 	 */
 	ODataBinding.prototype.resetChanges = function () {
+		this.checkTransient();
 		return this._resetChanges();
 	};
 
@@ -1384,8 +1408,9 @@ sap.ui.define([
 	 *
 	 * @param {sap.ui.base.SyncPromise[]} aPromises
 	 *   List of promises which is extended for each call to {@link #resetChangesInDependents}.
-	 * @param {boolean} [bIgnoreInactiveCaches]
-	 *   Whether to ignore changes in inactive caches
+	 * @param {boolean} [sPathPrefix]
+	 *   If supplied, only caches having a resource path starting with <code>sPathPrefix</code> are
+	 *   reset
 	 * @throws {Error}
 	 *   If there is a change of this binding which has been sent to the server and for which there
 	 *   is no response yet.
@@ -1435,9 +1460,13 @@ sap.ui.define([
 	/**
 	 * Recursively updates all dependent bindings after a create.
 	 *
-	 * @returns {sap.ui.base.SyncPromise}
+	 * @param {boolean} bSkipRefresh
+	 *   Whether the application wants to skip the automatic refresh
+	 * @param {string} sGroupId
+	 *   The group ID for missing properties requests
+	 * @returns {sap.ui.base.SyncPromise|undefined}
 	 *   A promise that resolves when the update is finished and rejects with an error if something
-	 *   went wrong.
+	 *   went wrong; or <code>undefined</code> if there is no need to wait
 	 *
 	 * @abstract
 	 * @function

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.112.2
+		 * @version 1.114.0
 		 *
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding
@@ -99,25 +99,6 @@ sap.ui.define([
 				constructor : constructor
 			});
 
-	/**
-	 * Returns the path for the return value context. Supports bound operations on an entity or a
-	 * collection.
-	 *
-	 * @param {string} sPath
-	 *   The bindings's path; either a resolved model path or a resource path; for example:
-	 *   "Artists(ArtistID='42',IsActiveEntity=true)/special.cases.EditAction(...)" or
-	 *   "/Artists(ArtistID='42',IsActiveEntity=true)/special.cases.EditAction(...)" or
-	 *   "Artists/special.cases.Create(...)" or "/Artists/special.cases.Create(...)"
-	 * @param {string} sResponsePredicate The key predicate of the response entity
-	 * @returns {string} The path for the return value context.
-	 */
-	function getReturnValueContextPath(sPath, sResponsePredicate) {
-		var sBoundParameterPath = sPath.slice(0, sPath.lastIndexOf("/")),
-			i = sBoundParameterPath.indexOf("(");
-
-		return (i < 0 ? sBoundParameterPath : sPath.slice(0, i)) + sResponsePredicate;
-	}
-
 	//*********************************************************************************************
 	// ODataContextBinding
 	//*********************************************************************************************
@@ -269,7 +250,7 @@ sap.ui.define([
 					mParameters, fnGetEntity, bIgnoreETag, fnOnStrictHandlingFailed);
 			}).then(function (oResponseEntity) {
 				return fireChangeAndRefreshDependentBindings().then(function () {
-					var sContextPredicate, oOldValue, sResponsePredicate, oResult;
+					var sContextPredicate, oOldValue, sResponsePredicate, sNewPath, oResult;
 
 					if (that.isReturnValueLikeBindingParameter(oOperationMetadata)) {
 						oOldValue = that.oContext.getValue();
@@ -297,9 +278,10 @@ sap.ui.define([
 									return oResult;
 								}
 
+								sNewPath = _Helper.getReturnValueContextPath(sResolvedPath,
+									sResponsePredicate);
 								that.oReturnValueContext = Context.createNewContext(that.oModel,
-									that,
-									getReturnValueContextPath(sResolvedPath, sResponsePredicate));
+									that, sNewPath);
 								// set the resource path for late property requests
 								that.oCache.setResourcePath(
 									that.oReturnValueContext.getPath().slice(1));
@@ -594,7 +576,7 @@ sap.ui.define([
 		function getOriginalResourcePath(oResponseEntity) {
 			if (that.isReturnValueLikeBindingParameter(oOperationMetadata)) {
 				if (that.hasReturnValueContext()) {
-					return getReturnValueContextPath(sOriginalResourcePath,
+					return _Helper.getReturnValueContextPath(sOriginalResourcePath,
 						_Helper.getPrivateAnnotation(oResponseEntity, "predicate"));
 				}
 				if (_Helper.getPrivateAnnotation(vEntity, "predicate")
@@ -971,7 +953,7 @@ sap.ui.define([
 				if (!this.oContext.getBinding) {
 					throw new Error("Cannot replace this parent context: " + this.oContext);
 				} // Note: parent context need not have a key predicate!
-				this.oContext.getBinding().checkKeepAlive(this.oContext);
+				this.oContext.getBinding().checkKeepAlive(this.oContext, true);
 			}
 		} else if (bReplaceWithRVC) {
 			throw new Error("Cannot replace when operation is not relative");