@openui5/sap.ui.core 1.105.1 → 1.107.0

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

@@ -54,11 +54,13 @@ sap.ui.define([
 	 *
 	 * @param {function} fnFunction The function to call when the event occurs
 	 * @param {object} [oListener] Object on which to call the given function
+	 * @returns {this} <code>this</code> to allow method chaining
+	 *
 	 * @public
 	 * @since 1.59.0
 	 */
 	ODataParentBinding.prototype.attachPatchCompleted = function (fnFunction, oListener) {
-		this.attachEvent("patchCompleted", fnFunction, oListener);
+		return this.attachEvent("patchCompleted", fnFunction, oListener);
 	};
 
 	/**
@@ -66,11 +68,13 @@ sap.ui.define([
 	 *
 	 * @param {function} fnFunction The function to call when the event occurs
 	 * @param {object} [oListener] Object on which to call the given function
+	 * @returns {this} <code>this</code> to allow method chaining
+	 *
 	 * @public
 	 * @since 1.59.0
 	 */
 	ODataParentBinding.prototype.detachPatchCompleted = function (fnFunction, oListener) {
-		this.detachEvent("patchCompleted", fnFunction, oListener);
+		return this.detachEvent("patchCompleted", fnFunction, oListener);
 	};
 
 	/**
@@ -138,11 +142,13 @@ sap.ui.define([
 	 *
 	 * @param {function} fnFunction The function to call when the event occurs
 	 * @param {object} [oListener] Object on which to call the given function
+	 * @returns {this} <code>this</code> to allow method chaining
+	 *
 	 * @public
 	 * @since 1.59.0
 	 */
 	ODataParentBinding.prototype.attachPatchSent = function (fnFunction, oListener) {
-		this.attachEvent("patchSent", fnFunction, oListener);
+		return this.attachEvent("patchSent", fnFunction, oListener);
 	};
 
 	/**
@@ -150,11 +156,13 @@ sap.ui.define([
 	 *
 	 * @param {function} fnFunction The function to call when the event occurs
 	 * @param {object} [oListener] Object on which to call the given function
+	 * @returns {this} <code>this</code> to allow method chaining
+	 *
 	 * @public
 	 * @since 1.59.0
 	 */
 	ODataParentBinding.prototype.detachPatchSent = function (fnFunction, oListener) {
-		this.detachEvent("patchSent", fnFunction, oListener);
+		return this.detachEvent("patchSent", fnFunction, oListener);
 	};
 
 	/**
@@ -332,7 +340,7 @@ sap.ui.define([
 	 *   1.93.0, string values for "$expand" and "$select" are ignored if they are unchanged;
 	 *   pending changes are ignored if all parameters are unchanged. Since 1.97.0, pending changes
 	 *   are ignored if they relate to a
-	 *   {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
+	 *   {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} context of this binding.
 	 *   Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts
 	 *   of a {@link #getRootBinding root binding} do not count as pending changes.
 	 *
@@ -416,7 +424,7 @@ sap.ui.define([
 	 *
 	 * @abstract
 	 * @function
-	 * @name sap.ui.model.odata.v4.ODataListBinding#checkKeepAlive
+	 * @name sap.ui.model.odata.v4.ODataParentBinding#checkKeepAlive
 	 * @private
 	 * @see sap.ui.model.odata.v4.Context#setKeepAlive
 	 */
@@ -564,17 +572,22 @@ sap.ui.define([
 	/**
 	 * Creates a promise for the refresh to be resolved by the binding's GET request.
 	 *
-	 * @returns {Promise} the created promise
+	 * @param {boolean} bPreventBubbling
+	 *   Whether the dataRequested and dataReceived events related to the refresh must not be
+	 *   bubbled up to the model
+	 * @returns {Promise} The created promise
 	 *
+	 * @see #isRefreshWithoutBubbling
 	 * @see #resolveRefreshPromise
 	 * @private
 	 */
-	ODataParentBinding.prototype.createRefreshPromise = function () {
+	ODataParentBinding.prototype.createRefreshPromise = function (bPreventBubbling) {
 		var oPromise, fnResolve;
 
 		oPromise = new Promise(function (resolve) {
 			fnResolve = resolve;
 		});
+		oPromise.$preventBubbling = bPreventBubbling;
 		oPromise.$resolve = fnResolve;
 		this.oRefreshPromise = oPromise;
 		return oPromise;
@@ -1080,6 +1093,19 @@ sap.ui.define([
 		return false;
 	};
 
+	/**
+	 * Whether the dataRequested and dataReceived events related to the refresh must not be bubbled
+	 * up to the model.
+	 *
+	 * @returns {boolean}  Whether to prevent bubbling
+	 *
+	 * @private
+	 * @see #createRefreshPromise
+	 */
+	ODataParentBinding.prototype.isRefreshWithoutBubbling = function () {
+		return this.oRefreshPromise && this.oRefreshPromise.$preventBubbling;
+	};
+
 	/**
 	 * @override
 	 * @see sap.ui.model.odata.v4.ODataBinding#onDelete
@@ -1332,7 +1358,7 @@ sap.ui.define([
 	 * Suspends this binding. A suspended binding does not fire change events nor does it trigger
 	 * data service requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method
 	 * was not supported and threw an error. Since 1.97.0, pending changes are ignored if they
-	 * relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this
+	 * relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} context of this
 	 * binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts
 	 * of a {@link #getRootBinding root binding} do not count as pending changes.
 	 *

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.105.1
+		 * @version 1.107.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
@@ -228,6 +228,9 @@ sap.ui.define([
 	 *   The change reason for the change event
 	 * @param {string} [sGroupId=getGroupId()]
 	 *   The group ID to be used for the read.
+	 * @param {boolean} [bPreventBubbling]
+	 *   Whether the dataRequested and dataReceived events related to the refresh must not be
+	 *   bubbled up to the model
 	 * @param {any} [vValue]
 	 *   The new value obtained from the cache, see {@link #onChange}
 	 * @returns {sap.ui.base.SyncPromise}
@@ -241,7 +244,7 @@ sap.ui.define([
 	 */
 	// @override sap.ui.model.odata.v4.ODataBinding#checkUpdateInternal
 	ODataPropertyBinding.prototype.checkUpdateInternal = function (bForceUpdate, sChangeReason,
-			sGroupId, vValue) {
+			sGroupId, bPreventBubbling, vValue) {
 		var bDataRequested = false,
 			iHashHash = this.sPath.indexOf("##"),
 			bIsMeta = iHashHash >= 0,
@@ -278,7 +281,7 @@ sap.ui.define([
 					return oCache.fetchValue(that.lockGroup(sGroupId || that.getGroupId()),
 							/*sPath*/undefined, function () {
 								bDataRequested = true;
-								that.fireDataRequested();
+								that.fireDataRequested(bPreventBubbling);
 							}, that)
 						.then(function (vResult) {
 							that.assertSameCache(oCache);
@@ -352,7 +355,7 @@ sap.ui.define([
 				that.checkDataState();
 			}
 			if (bDataRequested) {
-				that.fireDataReceived(mParametersForDataReceived);
+				that.fireDataReceived(mParametersForDataReceived, bPreventBubbling);
 			}
 			if (mParametersForDataReceived.error) {
 				throw mParametersForDataReceived.error;
@@ -493,11 +496,13 @@ sap.ui.define([
 	 *
 	 * @param {any} vValue
 	 *   The new value
+	 * @param {boolean} [bForceUpdate]
+	 *   Update the bound control even if no data have been changed.
 	 *
 	 * @private
 	 */
-	ODataPropertyBinding.prototype.onChange = function (vValue) {
-		this.checkUpdateInternal(undefined, undefined, undefined, vValue)
+	ODataPropertyBinding.prototype.onChange = function (vValue, bForceUpdate) {
+		this.checkUpdateInternal(bForceUpdate, undefined, undefined, false, vValue)
 			.catch(this.oModel.getReporter());
 	};
 
@@ -529,7 +534,8 @@ sap.ui.define([
 			}
 
 			if (bCheckUpdate) {
-				return that.checkUpdateInternal(undefined, ChangeReason.Refresh, sGroupId);
+				return that.checkUpdateInternal(undefined, ChangeReason.Refresh, sGroupId,
+					/*bPreventBubbling*/bKeepCacheOnError);
 			}
 		});
 	};
@@ -537,7 +543,7 @@ sap.ui.define([
 	/**
 	 * Requests the value of the property binding.
 	 *
-	 * @returns {Promise}
+	 * @returns {Promise<any|undefined>}
 	 *   A promise resolving with the resulting value or <code>undefined</code> if it could not be
 	 *   determined, or rejecting in case of an error
 	 *
@@ -754,7 +760,7 @@ sap.ui.define([
 			throw reportError(new Error("Must not specify a group ID (" + sGroupId
 				+ ") with $$noPatch"));
 		}
-		this.oModel.checkGroupId(sGroupId);
+		_Helper.checkGroupId(sGroupId);
 		if (typeof vValue === "function" || (vValue && typeof vValue === "object")) {
 			throw reportError(new Error("Not a primitive value"));
 		}

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

@@ -76,7 +76,7 @@ sap.ui.define([
 			 *   corresponding number of milliseconds since 1 January, 1970 UTC.
 			 *   Otherwise the values are compared with the JavaScript operators <code>===</code>
 			 *   and <code>></code>.
-			 * @return {number}
+			 * @returns {number}
 			 *   The result of the comparison: <code>0</code> if the values are equal,
 			 *   <code>1</code> if the first value is larger, <code>-1</code> if the second value
 			 *   is larger, <code>NaN</code> if they cannot be compared
@@ -139,13 +139,16 @@ sap.ui.define([
 			 * and URLs.
 			 *
 			 * @param {any} vValue
-			 *   The value according to "OData JSON Format Version 4.0" section
-			 *   "7.1 Primitive Value"
+			 *   The value according to <a href=
+			 *   "https://docs.oasis-open.org/odata/odata-json-format/v4.0/os/odata-json-format-v4.0-os.html#_Primitive_Value"
+			 *   >"OData JSON Format Version 4.0" section "7.1 Primitive Value"</a>
 			 * @param {string} sType
 			 *   The OData primitive type, for example "Edm.String"
 			 * @returns {string}
-			 *   The literal according to "OData Version 4.0 Part 2: URL Conventions" section
-			 *   "5.1.1.6.1 Primitive Literals"
+			 *   The literal according to <a href=
+			 *   "https://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html"
+			 *   >"OData Version 4.0 Part 2: URL Conventions"</a> section
+			 *   "5.1.1.11.1 Primitive Literals"
 			 * @throws {Error}
 			 *   If the value is undefined or the type is not supported
 			 *

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

@@ -32,9 +32,8 @@ sap.ui.define([
 	 * @param {string} sResourcePath
 	 *   A resource path relative to the service URL
 	 * @param {object} oAggregation
-	 *   An object holding the information needed for data aggregation; see also
-	 *   <a href="http://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/">OData
-	 *   Extension for Data Aggregation Version 4.0</a>; must already be normalized by
+	 *   An object holding the information needed for data aggregation; see also "OData Extension
+	 *   for Data Aggregation Version 4.0"; must already be normalized by
 	 *   {@link _AggregationHelper.buildApply}
 	 * @param {object} mQueryOptions
 	 *   A map of key-value pairs representing the query string
@@ -869,9 +868,8 @@ sap.ui.define([
 	 * @param {string} sDeepResourcePath
 	 *   The deep resource path to be used to build the target path for bound messages
 	 * @param {object} [oAggregation]
-	 *   An object holding the information needed for data aggregation; see also
-	 *   <a href="http://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/">OData
-	 *   Extension for Data Aggregation Version 4.0</a>; must already be normalized by
+	 *   An object holding the information needed for data aggregation; see also "OData Extension
+	 *   for Data Aggregation Version 4.0"; must already be normalized by
 	 *   {@link _AggregationHelper.buildApply}
 	 * @param {object} mQueryOptions
 	 *   A map of key-value pairs representing the query string, the value in this pair has to
@@ -887,57 +885,71 @@ sap.ui.define([
 	 *   If this parameter is set, multiple requests for a cache using the same resource path will
 	 *   always return the same, shared cache. This cache is read-only, modifying calls lead to an
 	 *   error.
+	 * @param {boolean} [bIsGrouped]
+	 *   Whether the list binding is grouped via its first sorter
 	 * @returns {sap.ui.model.odata.v4.lib._Cache}
 	 *   The cache
 	 * @throws {Error}
 	 *   If the system query option "$filter" is combined with group levels or with grand totals
-	 *   (unless "grandTotal like 1.84"), or if grand totals or group levels are combined with
-	 *   min/max, or if the system query options "$expand" or "$select" are combined with pure data
-	 *   aggregation (no recursive hierarchy)
+	 *   (unless "grandTotal like 1.84"), or if grand totals or group levels or recursive hierarchy
+	 *   are combined with min/max or with grouping via sorter, or if the system query options
+	 *   "$expand" or "$select" are combined with pure data aggregation (no recursive hierarchy), or
+	 *   if the system query option "$search" is combined with grand totals or group levels or a
+	 *   recursive hierarchy
 	 *
 	 * @public
 	 */
 	_AggregationCache.create = function (oRequestor, sResourcePath, sDeepResourcePath, oAggregation,
-			mQueryOptions, bSortExpandSelect, bSharedRequest) {
-		var bHasGrandTotal, bHasGroupLevels, bHasMinOrMax;
+			mQueryOptions, bSortExpandSelect, bSharedRequest, bIsGrouped) {
+		var bHasGrandTotal, bHasGroupLevels;
+
+		function checkExpandSelect() {
+			if ("$expand" in mQueryOptions) {
+				throw new Error("Unsupported system query option: $expand");
+			}
+			if ("$select" in mQueryOptions) {
+				throw new Error("Unsupported system query option: $select");
+			}
+		}
 
 		if (oAggregation) {
 			bHasGrandTotal = _AggregationHelper.hasGrandTotal(oAggregation.aggregate);
 			bHasGroupLevels = oAggregation.groupLevels && !!oAggregation.groupLevels.length;
-			bHasMinOrMax = _AggregationHelper.hasMinOrMax(oAggregation.aggregate);
 
-			if (mQueryOptions.$filter
-				&& (bHasGrandTotal && !oAggregation["grandTotal like 1.84"]
-					|| bHasGroupLevels)) {
-				throw new Error("Unsupported system query option: $filter");
-			}
-			if (mQueryOptions.$search && (bHasGrandTotal || bHasGroupLevels)) {
-				throw new Error("Unsupported system query option: $search");
-			}
-			if (bHasMinOrMax) {
+			if (_AggregationHelper.hasMinOrMax(oAggregation.aggregate)) {
 				if (bHasGrandTotal) {
 					throw new Error("Unsupported grand totals together with min/max");
 				}
 				if (bHasGroupLevels) {
 					throw new Error("Unsupported group levels together with min/max");
 				}
+				if (oAggregation.hierarchyQualifier) {
+					throw new Error("Unsupported recursive hierarchy together with min/max");
+				}
+				checkExpandSelect();
+
+				return _MinMaxHelper.createCache(oRequestor, sResourcePath, oAggregation,
+					mQueryOptions);
 			}
 
-			if (bHasGrandTotal || bHasGroupLevels || bHasMinOrMax
-					|| oAggregation.hierarchyQualifier) {
+			if (mQueryOptions.$filter
+				&& (bHasGrandTotal && !oAggregation["grandTotal like 1.84"]
+					|| bHasGroupLevels)) {
+				throw new Error("Unsupported system query option: $filter");
+			}
+
+			if (bHasGrandTotal || bHasGroupLevels || oAggregation.hierarchyQualifier) {
+				if (mQueryOptions.$search) {
+					throw new Error("Unsupported system query option: $search");
+				}
 				if (!oAggregation.hierarchyQualifier) {
-					if ("$expand" in mQueryOptions) {
-						throw new Error("Unsupported system query option: $expand");
-					}
-					if ("$select" in mQueryOptions) {
-						throw new Error("Unsupported system query option: $select");
-					}
+					checkExpandSelect();
+				}
+				if (bIsGrouped) {
+					throw new Error("Unsupported grouping via sorter");
 				}
 
-				return bHasMinOrMax
-					? _MinMaxHelper.createCache(oRequestor, sResourcePath, oAggregation,
-						mQueryOptions)
-					: new _AggregationCache(oRequestor, sResourcePath, oAggregation, mQueryOptions,
+				return new _AggregationCache(oRequestor, sResourcePath, oAggregation, mQueryOptions,
 						bHasGrandTotal);
 			}
 		}

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

@@ -43,7 +43,8 @@ sap.ui.define([
 			+ ")(?:" + _Parser.sWhitespace + "+(?:asc|desc))?$"),
 		mRecursiveHierarchyType = {
 			expandTo : /^[1-9]\d*$/, // a positive integer
-			hierarchyQualifier : "string"
+			hierarchyQualifier : "string",
+			search : "string"
 		},
 		/**
 		 * Collection of helper methods for data aggregation.
@@ -348,9 +349,18 @@ sap.ui.define([
 		 * @param {object} oAggregation
 		 *   An object holding the information needed for a recursive hierarchy; see
 		 *   {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}.
+		 * @param {string} [oAggregation.search]
+		 *   Like the value for a "$search" system query option (remember ODATA-1452); it is turned
+		 *   into the search expression parameter of an "ancestors()" transformation
 		 * @param {object} [mQueryOptions={}]
 		 *   A map of key-value pairs representing the query string; it is not modified
-		 * @param {number} [mQueryOptions.$select]
+		 * @param {string} [mQueryOptions.$filter]
+		 *   The value for a "$filter" system query option; it is removed from the returned map and
+		 *   turned into the filter expression parameter of an "ancestors()" transformation
+		 * @param {string} [mQueryOptions.$orderby]
+		 *   The value for a "$orderby" system query option; it is removed from the returned map and
+		 *   turned into an "orderby()" transformation
+		 * @param {string[]} [mQueryOptions.$select]
 		 *   The value for a "$select" system query option; additional technical properties are
 		 *   added to the returned copy
 		 * @returns {object}
@@ -361,7 +371,7 @@ sap.ui.define([
 		 * @public
 		 */
 		buildApply4Hierarchy : function (oAggregation, mQueryOptions) {
-			var sApply,
+			var sApply = "",
 				sHierarchyQualifier = oAggregation.hierarchyQualifier,
 				sPath = oAggregation.$path,
 				sNodeProperty = mQueryOptions
@@ -369,7 +379,8 @@ sap.ui.define([
 						+ "/@Org.OData.Aggregation.V1.RecursiveHierarchy#" + sHierarchyQualifier
 						+ "/NodeProperty/$PropertyPath").getResult()
 					: "???",
-				mRecursiveHierarchy;
+				mRecursiveHierarchy,
+				sSeparator = "";
 
 			function select(sProperty) {
 				if (mQueryOptions.$select) {
@@ -388,13 +399,36 @@ sap.ui.define([
 				mQueryOptions.$select = mQueryOptions.$select.slice();
 			}
 
+			if (mQueryOptions.$filter || oAggregation.search) {
+				if (mQueryOptions.$filter) {
+					sApply = "filter(" + mQueryOptions.$filter;
+					sSeparator = ")/";
+					delete mQueryOptions.$filter;
+				}
+				if (oAggregation.search) {
+					sApply += sSeparator + "search(" + oAggregation.search;
+				}
+				sApply = "ancestors($root" + sPath
+					+ "," + sHierarchyQualifier
+					+ "," + sNodeProperty
+					+ "," + sApply
+					+ "),keep start)/";
+			}
 			if (mQueryOptions.$$filterBeforeAggregate) { // children of a given parent
-				sApply = "descendants($root" + sPath + "," + sHierarchyQualifier
+				sApply += "descendants($root" + sPath + "," + sHierarchyQualifier
 					+ "," + sNodeProperty
 					+ ",filter(" + mQueryOptions.$$filterBeforeAggregate + "),1)";
 				delete mQueryOptions.$$filterBeforeAggregate;
+				if (mQueryOptions.$orderby) {
+					sApply += "/orderby(" + mQueryOptions.$orderby + ")";
+					delete mQueryOptions.$orderby;
+				}
 			} else { // top levels of nodes
-				sApply = "com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root" + sPath
+				if (mQueryOptions.$orderby) {
+					sApply += "orderby(" + mQueryOptions.$orderby + ")/";
+					delete mQueryOptions.$orderby;
+				}
+				sApply += "com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root" + sPath
 					+ ",HierarchyQualifier='" + sHierarchyQualifier
 					+ "',NodeProperty='" + sNodeProperty
 					+ "',Levels=" + (oAggregation.expandTo || 1)