@openui5/sap.ui.core 1.93.3 → 1.96.2

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

@@ -68,8 +68,8 @@ sap.ui.define([
 	 * @author SAP SE
 	 * @class Context binding for an OData V4 model.
 	 *   An event handler can only be attached to this binding for the following events:
-	 *   'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', and
-	 *   'DataStateChange'. For other events, an error is thrown.
+	 *   'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', 'DataStateChange',
+	 *   'patchCompleted', and 'patchSent'. For other events, an error is thrown.
 	 *
 	 *   A context binding can also be used as an <i>operation binding</i> to support bound actions,
 	 *   action imports, bound functions and function imports. If you want to control the execution
@@ -106,7 +106,7 @@ sap.ui.define([
 	 * @mixes sap.ui.model.odata.v4.ODataParentBinding
 	 * @public
 	 * @since 1.37.0
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 *
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding
@@ -114,7 +114,9 @@ sap.ui.define([
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#hasPendingChanges as #hasPendingChanges
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#isInitial as #isInitial
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#refresh as #refresh
+	 * @borrows sap.ui.model.odata.v4.ODataBinding#requestRefresh as #requestRefresh
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#resetChanges as #resetChanges
+	 * @borrows sap.ui.model.odata.v4.ODataBinding#toString as #toString
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#attachPatchCompleted as
 	 *   #attachPatchCompleted
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#attachPatchSent as #attachPatchSent
@@ -122,13 +124,13 @@ sap.ui.define([
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#detachPatchCompleted as
 	 *   #detachPatchCompleted
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#detachPatchSent as #detachPatchSent
-	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#initialize as #initialize
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#resume as #resume
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#suspend as #suspend
 	 */
 	var ODataContextBinding = ContextBinding.extend("sap.ui.model.odata.v4.ODataContextBinding", {
 			constructor : function (oModel, sPath, oContext, mParameters) {
-				var iPos = sPath.indexOf("(...)");
+				var iPos = sPath.indexOf("(...)"),
+					that = this;
 
 				ContextBinding.call(this, oModel, sPath);
 				// initialize mixin members
@@ -178,6 +180,13 @@ sap.ui.define([
 				}
 				this.setContext(oContext);
 				oModel.bindingCreated(this);
+
+				Promise.resolve().then(function () {
+					// bInitial must be true initially, but false later. Then suspend on a just
+					// created binding causes a change event on resume; otherwise further changes
+					// on the suspended binding are required (see doSuspend)
+					that.bInitial = false;
+				});
 			},
 			metadata : {
 				publicMethods : []
@@ -287,7 +296,7 @@ sap.ui.define([
 			return that.refreshDependentBindings("", oGroupLock.getGroupId(), true);
 		}
 
-		oPromise = oMetaModel.fetchObject(oMetaModel.getMetaPath(sResolvedPath) + "/@$ui5.overload")
+		oPromise = oMetaModel.fetchObject(_Helper.getMetaPath(sResolvedPath) + "/@$ui5.overload")
 			.then(function (aOperationMetadata) {
 				var fnGetEntity, iIndex, sPath;
 
@@ -394,7 +403,9 @@ sap.ui.define([
 		this.mParameters = mParameters; // store mParameters at binding after validation
 
 		if (this.isRootBindingSuspended()) {
-			this.sResumeChangeReason = ChangeReason.Change;
+			if (!this.oOperation) {
+				this.sResumeChangeReason = ChangeReason.Change;
+			}
 		} else if (!this.oOperation) {
 			this.fetchCache(this.oContext);
 			if (sChangeReason) {
@@ -592,7 +603,7 @@ sap.ui.define([
 			oCache,
 			vEntity = fnGetEntity,
 			oModel = this.oModel,
-			sMetaPath = oModel.getMetaModel().getMetaPath(sPath) + "/@$ui5.overload/0/$ReturnType",
+			sMetaPath = _Helper.getMetaPath(sPath) + "/@$ui5.overload/0/$ReturnType",
 			sOriginalResourcePath = sPath.slice(1),
 			oRequestor = oModel.oRequestor,
 			that = this;
@@ -625,18 +636,18 @@ sap.ui.define([
 		 * @throws {Error} If <code>fnOnStrictHandlingFailed</code> does not return a promise
 		 */
 		function onStrictHandling(oError) {
-			var oRawMessages, oResult;
+			var oResult;
 
 			_Helper.adjustTargetsInError(oError, oOperationMetadata,
 				that.oParameterContext.getPath(),
 				that.bRelative ? that.oContext.getPath() : undefined);
 			oError.error.$ignoreTopLevel = true;
-			oRawMessages = _Helper.extractMessages(oError);
 
 			oResult = fnOnStrictHandlingFailed(
-				oRawMessages.bound.concat(oRawMessages.unbound).map(function (oRawMessage) {
+				_Helper.extractMessages(oError).map(function (oRawMessage) {
 					return that.oModel.createUI5Message(oRawMessage);
-			}));
+				})
+			);
 
 			if (!(oResult instanceof Promise)) {
 				throw new Error("Not a promise: " + oResult);
@@ -705,7 +716,6 @@ sap.ui.define([
 			this.oReturnValueContext = undefined;
 		}
 		this.oModel.bindingDestroyed(this);
-		this.mCacheByResourcePath = undefined;
 		this.oOperation = undefined;
 		this.mParameters = undefined;
 		this.mQueryOptions = undefined;
@@ -764,6 +774,17 @@ sap.ui.define([
 		}
 	};
 
+	/**
+	 * @override
+	 * @see sap.ui.model.odata.v4.ODataParentBinding#doSuspend
+	 */
+	ODataContextBinding.prototype.doSuspend = function () {
+		if (this.bInitial && !this.oOperation) {
+			// if the binding is still initial, it must fire an event in resume
+			this.sResumeChangeReason = ChangeReason.Change;
+		}
+	};
+
 	/**
 	 * Calls the OData operation that corresponds to this operation binding.
 	 *
@@ -894,6 +915,7 @@ sap.ui.define([
 		return oCachePromise.then(function (oCache) {
 			var bDataRequested = false,
 				oGroupLock,
+				sResolvedPath = that.getResolvedPath(),
 				sRelativePath = oCache || that.oOperation
 					? that.getRelativePath(sPath)
 					: undefined,
@@ -944,7 +966,7 @@ sap.ui.define([
 				}, function (oError) {
 					oGroupLock.unlock(true);
 					if (bDataRequested) {
-						that.oModel.reportError("Failed to read path " + that.sPath, sClassName,
+						that.oModel.reportError("Failed to read path " + sResolvedPath, sClassName,
 							oError);
 						that.fireDataReceived(oError.canceled ? {data : {}} : {error : oError});
 					}
@@ -1010,7 +1032,9 @@ sap.ui.define([
 			mQueryOptions = Object.assign({}, mQueryOptions);
 			// keep $select before $expand
 			if ("$select" in mInheritableQueryOptions) {
-				mQueryOptions.$select = mInheritableQueryOptions.$select;
+				// avoid that this.mQueryOptions.$select is modified
+				mQueryOptions.$select = mQueryOptions.$select && mQueryOptions.$select.slice();
+				_Helper.addToSelect(mQueryOptions, mInheritableQueryOptions.$select);
 			}
 			if ("$expand" in mInheritableQueryOptions) {
 				mQueryOptions.$expand = mInheritableQueryOptions.$expand;
@@ -1078,17 +1102,17 @@ sap.ui.define([
 	 * @private
 	 */
 	ODataContextBinding.prototype.hasReturnValueContext = function (oMetadata) {
-		var oMetaModel = this.oModel.getMetaModel(),
-			aMetaSegments;
+		var aMetaSegments;
 
 		if (!this.isReturnValueLikeBindingParameter(oMetadata)) {
 			return false;
 		}
 
-		aMetaSegments = oMetaModel.getMetaPath(this.getResolvedPath()).split("/");
+		aMetaSegments = _Helper.getMetaPath(this.getResolvedPath()).split("/");
 
+		// case 4b
 		return aMetaSegments.length === 3
-			&& oMetaModel.getObject("/" + aMetaSegments[1]).$kind === "EntitySet"; // case 4b
+			&& this.oModel.getMetaModel().getObject("/" + aMetaSegments[1]).$kind === "EntitySet";
 	};
 
 	/**
@@ -1101,12 +1125,11 @@ sap.ui.define([
 	 */
 	// @override sap.ui.model.Binding#initialize
 	ODataContextBinding.prototype.initialize = function () {
-		if (this.isResolved()) {
-			if (this.getRootBinding().isSuspended()) {
-				this.sResumeChangeReason = ChangeReason.Change;
-			} else {
-				this._fireChange({reason : ChangeReason.Change});
-			}
+		this.bInitial = false;
+		// Here no other code but the event for the ManagedObject is expected. The binding should be
+		// useable for controller code without calling initialize.
+		if (this.isResolved() && !this.getRootBinding().isSuspended()) {
+			this._fireChange({reason : ChangeReason.Change});
 		}
 	};
 
@@ -1137,6 +1160,52 @@ sap.ui.define([
 			&& !oMetadata.$EntitySetPath.includes("/"); // case 3
 	};
 
+	/**
+	 * Moves the bound entity into the given list binding. This binding loses its data. The method
+	 * may only be called when this binding has finished loading. You can verify this by calling
+	 * <code>oBinding.getBoundContext().requestObject()</code>. If that promise resolves, the
+	 * binding has finished loading.
+	 *
+	 * @param {sap.ui.model.odata.v4.ODataListBinding} oListBinding
+	 *   The list binding to take the entity
+	 * @throws {Error}
+	 *   If
+	 *   <ul>
+	 *     <li> this binding is not a root binding,
+	 *     <li> this binding has not finished loading yet,
+	 *     <li> not all key properties of the bound entity have been selected (so that it is
+	 *       impossible to determine its key predicate),
+	 *     <li> the bound entity is not an entity of the list binding's collection,
+	 *     <li> this binding is an operation binding,
+	 *     <li> this binding has pending changes (see {@link #hasPendingChanges}),
+	 *     <li> this binding has a <code>$expand</code> to a collection or a dependent list binding
+	 *       without <code>$$ownRequest</code>,
+	 *     <li> the list binding is not suspended,
+	 *     <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 data aggregation
+	 *       (@see sap.ui.model.odata.v4.ODataListBinding#setAggregation)
+	 *   </ul>
+	 *
+	 * @experimental
+	 * @public
+	 * @since 1.95.0
+	 */
+	ODataContextBinding.prototype.moveEntityTo = function (oListBinding) {
+		if (!this.isRoot()) {
+			throw new Error(this + ": must be a root binding");
+		}
+		if (this.oOperation) {
+			throw new Error(this + ": must not be an operation binding");
+		}
+		if (this.hasPendingChanges()) {
+			throw new Error(this + ": has pending changes");
+		}
+
+		oListBinding.moveEntityHere(this.oElementContext);
+		this.oElementContext = null;
+	};
+
 	/**
 	 * @override
 	 * @see sap.ui.model.odata.v4.ODataBinding#refreshInternal
@@ -1183,7 +1252,7 @@ sap.ui.define([
 				if (bKeepCacheOnError && oPromise) {
 					oPromise = oPromise.catch(function (oError) {
 						return that.fetchResourcePath(that.oContext).then(function (sResourcePath) {
-							if (!that.bRelative || oCache.$resourcePath === sResourcePath) {
+							if (!that.bRelative || oCache.getResourcePath() === sResourcePath) {
 								that.oCache = oCache;
 								that.oCachePromise = SyncPromise.resolve(oCache);
 								oCache.setActive(true);
@@ -1328,23 +1397,31 @@ sap.ui.define([
 	 * @see sap.ui.model.odata.v4.ODataParentBinding#resumeInternal
 	 */
 	ODataContextBinding.prototype.resumeInternal = function (bCheckUpdate, bParentHasChanges) {
-		var sResumeChangeReason = this.sResumeChangeReason;
-
-		this.sResumeChangeReason = undefined;
+		var sResumeChangeReason = this.sResumeChangeReason,
+			that = this;
 
-		if (!this.oOperation) {
-			if (bParentHasChanges || sResumeChangeReason) {
-				this.mAggregatedQueryOptions = {};
-				this.bAggregatedQueryOptionsInitial = true;
-				this.removeCachesAndMessages("");
-				this.fetchCache(this.oContext);
-			}
-			this.getDependentBindings().forEach(function (oDependentBinding) {
+		function resumeDependents() {
+			that.getDependentBindings().forEach(function (oDependentBinding) {
 				oDependentBinding.resumeInternal(bCheckUpdate, !!sResumeChangeReason);
 			});
-			if (sResumeChangeReason) {
-				this._fireChange({reason : sResumeChangeReason});
-			}
+		}
+
+		this.sResumeChangeReason = undefined;
+
+		if (this.oOperation) {
+			resumeDependents();
+			return;
+		}
+
+		if (bParentHasChanges || sResumeChangeReason) {
+			this.mAggregatedQueryOptions = {};
+			this.bAggregatedQueryOptionsInitial = true;
+			this.removeCachesAndMessages("");
+			this.fetchCache(this.oContext);
+		}
+		resumeDependents();
+		if (sResumeChangeReason) {
+			this._fireChange({reason : sResumeChangeReason});
 		}
 	};
 

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

@@ -68,21 +68,24 @@ sap.ui.define([
 	 * @author SAP SE
 	 * @class List binding for an OData V4 model.
 	 *   An event handler can only be attached to this binding for the following events:
-	 *   'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', 'DataStateChange'
-	 *   and 'refresh'. For other events, an error is thrown.
+	 *   'AggregatedDataStateChange', 'change', 'createCompleted', 'createSent', 'dataReceived',
+	 *   'dataRequested', 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For
+	 *   other events, an error is thrown.
 	 * @extends sap.ui.model.ListBinding
 	 * @hideconstructor
 	 * @mixes sap.ui.model.odata.v4.ODataParentBinding
 	 * @public
 	 * @since 1.37.0
-	 * @version 1.93.3
+	 * @version 1.96.2
 	 * @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
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#hasPendingChanges as #hasPendingChanges
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#isInitial as #isInitial
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#refresh as #refresh
+	 * @borrows sap.ui.model.odata.v4.ODataBinding#requestRefresh as #requestRefresh
 	 * @borrows sap.ui.model.odata.v4.ODataBinding#resetChanges as #resetChanges
+	 * @borrows sap.ui.model.odata.v4.ODataBinding#toString as #toString
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#attachPatchCompleted as
 	 *   #attachPatchCompleted
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#attachPatchSent as #attachPatchSent
@@ -90,7 +93,6 @@ sap.ui.define([
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#detachPatchCompleted as
 	 *   #detachPatchCompleted
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#detachPatchSent as #detachPatchSent
-	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#initialize as #initialize
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#resume as #resume
 	 * @borrows sap.ui.model.odata.v4.ODataParentBinding#suspend as #suspend
 	 */
@@ -1509,6 +1511,22 @@ sap.ui.define([
 	 * <code>false</code>. This property has to be set on each filter, it is not inherited from a
 	 * multi-filter.
 	 *
+	 * <h4>Application and Control Filters</h4>
+	 * Each list binding maintains two separate lists of filters, one for filters defined by the
+	 * control that owns the binding, and another list for filters that an application can define in
+	 * addition. When executing the filter operation, both sets of filters are combined.
+	 *
+	 * By using the <code>sFilterType</code> parameter of the <code>filter</code> method, the
+	 * caller can control which set of filters is modified.
+	 *
+	 * <h4>Auto-Grouping of Filters</h4>
+	 * Filters are first grouped according to their binding path. All filters belonging to the same
+	 * path are ORed, and after that the results of all paths are ANDed. Usually this means that all
+	 * filters applied to the same property are ORed, while filters on different properties are
+	 * ANDed.
+	 * Please use either the automatic grouping of filters (where applicable) or explicit
+	 * AND/OR filters, as a mixture of both is not supported.
+	 *
 	 * @param {sap.ui.model.Filter|sap.ui.model.Filter[]} [vFilters]
 	 *   The dynamic filters to be used; replaces the dynamic filters given in
 	 *   {@link sap.ui.model.odata.v4.ODataModel#bindList}.
@@ -2239,6 +2257,63 @@ sap.ui.define([
 		return this.bLengthFinal;
 	};
 
+	/**
+	 * Makes the given context a row context of this binding. Adds the entity data to the cache.
+	 * Makes the context kept-alive.
+	 *
+	 * @param {sap.ui.model.odata.v4.Context} oEntityContext
+	 *   A context pointing to an entity
+	 * @throws {Error}
+	 *   If the binding is not suspended, setKeepAlive is not possible, the resource paths do not
+	 *   match, the entity's key predicate is unknown, the context binding's $expand contains
+	 *   collections, or the context binding is still reading
+	 *
+	 * @private
+	 */
+	ODataListBinding.prototype.moveEntityHere = function (oEntityContext) {
+		var oEntity,
+			oEntityFetchValuePromise,
+			sEntityPath = oEntityContext.getPath(),
+			mEntityQueryOptions = oEntityContext.getBinding().getInheritableQueryOptions(),
+			sRelativePath = _Helper.getRelativePath(sEntityPath, this.oHeaderContext.getPath());
+
+		if (!sRelativePath || sRelativePath.includes("/")) {
+			throw new Error(this + ": " + sEntityPath + " is not an entity of the collection");
+		}
+		if (!this.getRootBinding().isSuspended()) {
+			throw new Error(this + ": must be suspended");
+		}
+		this.checkKeepAlive(oEntityContext);
+
+		// take the value from the context binding's cache
+		oEntityFetchValuePromise = oEntityContext.fetchValue(null, null, /*bCached*/true);
+		if (oEntityFetchValuePromise.isPending()) {
+			throw new Error("Cannot move the entity; the context binding has not finished loading: "
+				+ oEntityContext.getBinding());
+		}
+		oEntity = oEntityFetchValuePromise.getResult();
+
+		if (!_Helper.getPrivateAnnotation(oEntity, "predicate")) {
+			throw new Error("No key predicate known at " + sEntityPath);
+		}
+
+		// add the context binding's query options as late query options
+		if (!this.aggregateQueryOptions(mEntityQueryOptions, "", /*bImmutable*/true)) {
+			throw new Error(oEntityContext + ": could not move the entity. Probably a list binding"
+				+ " w/o $$ownRequest depends on it");
+		}
+
+		this.getRootBinding().resume();
+		oEntityContext.oBinding = this;
+		this.mPreviousContextsByPath[sEntityPath] = oEntityContext;
+		this.oCachePromise.then(function (oCache) {
+			oCache.addKeptElement(oEntity);
+			// setKeepAlive looks into the cache, so this had to wait
+			oEntityContext.setKeepAlive(true);
+			oEntityContext.checkUpdate();  // create listeners in this binding's cache
+		});
+	};
+
 	/**
 	 * @override
 	 * @see sap.ui.model.odata.v4.ODataBinding#refreshInternal
@@ -2255,6 +2330,9 @@ sap.ui.define([
 		// calls refreshInternal on all given bindings and returns an array of promises
 		function refreshAll(aBindings) {
 			return aBindings.map(function (oBinding) {
+				if (oBinding.bIsBeingDestroyed) {
+					return;
+				}
 				// Call refreshInternal with bCheckUpdate = false because property bindings
 				// should not check for updates yet, otherwise they will cause a "Failed to
 				// drill down..." when the row is no longer part of the collection. They get
@@ -2289,7 +2367,7 @@ sap.ui.define([
 							throw oError;
 						}
 						return that.fetchResourcePath(that.oContext).then(function (sResourcePath) {
-							if (!that.bRelative || oCache.$resourcePath === sResourcePath) {
+							if (!that.bRelative || oCache.getResourcePath() === sResourcePath) {
 								that.oCache = oCache;
 								that.oCachePromise = SyncPromise.resolve(oCache);
 								that.iCreatedContexts = iCreatedContexts;
@@ -2564,7 +2642,7 @@ sap.ui.define([
 			return Promise.resolve(null);
 		}
 
-		sMetaPath = oMetaModel.getMetaPath(sResolvedPath);
+		sMetaPath = _Helper.getMetaPath(sResolvedPath);
 		return oMetaModel.requestObject(sMetaPath + "/").then(function (oEntityType) {
 			var aFilters,
 				mPredicates = {};
@@ -2599,8 +2677,7 @@ sap.ui.define([
 	 * @see sap.ui.model.odata.v4.ODataParentBinding#requestSideEffects
 	 */
 	ODataListBinding.prototype.requestSideEffects = function (sGroupId, aPaths, oContext) {
-		var bAllContextsTransient,
-			aContexts,
+		var aContexts,
 			bMissingPredicate,
 			oModel = this.oModel,
 			// Hash set of collection-valued navigation property meta paths (relative to the cache's
@@ -2681,13 +2758,8 @@ sap.ui.define([
 		if (bSingle) {
 			return this.refreshSingle(oContext, this.lockGroup(sGroupId), false);
 		}
-		if (this.aContexts.length) {
-			bAllContextsTransient = this.aContexts.every(function (oContext) {
-				return oContext.isTransient();
-			});
-			if (bAllContextsTransient) {
-				return SyncPromise.resolve();
-			}
+		if (this.iCurrentEnd === 0) {
+			return SyncPromise.resolve();
 		}
 		return this.refreshInternal("", sGroupId, false, true);
 	};
@@ -2954,6 +3026,14 @@ sap.ui.define([
 							&& !this.mParameters.$$aggregation) {
 						this.sChangeReason = "AddVirtualContext"; // JIRA: CPOUI5ODATAV4-848
 					}
+					if (oContext.getBinding
+							&& oContext.getBinding().getRootBinding().isSuspended()) {
+						// when becoming suspended, remain silent until resume
+						this.oContext = oContext;
+						this.setResumeChangeReason(ChangeReason.Context);
+
+						return;
+					}
 				}
 				// call Binding#setContext because of data state etc.; fires "change"
 				Binding.prototype.setContext.call(this, oContext,