@openui5/sap.ui.core 1.119.1 → 1.120.1

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

@@ -38,6 +38,7 @@ sap.ui.define([
 	"sap/ui/core/Messaging",
 	"sap/ui/core/message/Message",
 	"sap/ui/core/message/MessageParser",
+	"sap/ui/core/Supportability",
 	"sap/ui/model/_Helper",
 	"sap/ui/model/BindingMode",
 	"sap/ui/model/Context",
@@ -58,9 +59,10 @@ sap.ui.define([
 ], function(_CreatedContextsCache, Context, ODataAnnotations, ODataContextBinding, ODataListBinding,
 		ODataTreeBinding, assert, Log, encodeURL, deepEqual, deepExtend, each, extend,
 		isEmptyObject, isPlainObject, merge, uid, UriParameters, SyncPromise, Configuration,
-		coreLibrary, Messaging, Message, MessageParser, _Helper, BindingMode, BaseContext, FilterProcessor,
-		Model, CountMode, MessageScope, ODataMetadata, ODataMetaModel, ODataMessageParser,
-		ODataPropertyBinding, ODataUtils, OperationMode, UpdateMethod, OData, URI, isCrossOriginURL
+		coreLibrary, Messaging, Message, MessageParser, Supportability,  _Helper, BindingMode,
+		BaseContext, FilterProcessor, Model, CountMode, MessageScope, ODataMetadata, ODataMetaModel,
+		ODataMessageParser,	ODataPropertyBinding, ODataUtils, OperationMode, UpdateMethod, OData,
+		URI, isCrossOriginURL
 ) {
 
 	"use strict";
@@ -216,7 +218,7 @@ sap.ui.define([
 	 * This model is not prepared to be inherited from.
 	 *
 	 * @author SAP SE
-	 * @version 1.119.1
+	 * @version 1.120.1
 	 *
 	 * @public
 	 * @alias sap.ui.model.odata.v2.ODataModel
@@ -405,7 +407,7 @@ sap.ui.define([
 			this.sUser = sUser;
 			this.sPassword = sPassword;
 
-			if (Configuration.getStatisticsEnabled()) {
+			if (Supportability.isStatisticsEnabled()) {
 				// add statistics parameter to every request (supported only on Gateway servers)
 				this.aUrlParams.push("sap-statistics=true");
 			}
@@ -2068,6 +2070,9 @@ sap.ui.define([
 	 *   Deprecated since 1.102.0, as {@link sap.ui.model.odata.OperationMode.Auto} is deprecated;
 	 *   the threshold that defines how many entries should be fetched at least by the binding if
 	 *   <code>operationMode</code> is set to <code>Auto</code>.
+	 * @throws {Error} If one of the filters uses an operator that is not supported by the underlying model
+	 *   implementation or if the {@link sap.ui.model.Filter.NONE} filter instance is contained in
+	 *   <code>aFilters</code> together with other filters
 	 * @returns {sap.ui.model.odata.v2.ODataListBinding} The new list binding
 	 * @see sap.ui.model.Model.prototype.bindList
 	 * @public
@@ -2130,6 +2135,12 @@ sap.ui.define([
 	 *   restrictions for using filters, see above
 	 * @param {object} [mParameters]
 	 *   Map of binding parameters
+	 * @param {boolean} [mParameters.transitionMessagesOnly=false]
+	 *   Whether the tree binding only requests transition messages from the back end. If messages
+	 *   for entities of this collection need to be updated, use
+	 *   {@link sap.ui.model.odata.v2.ODataModel#read} on the parent entity corresponding to the
+	 *   tree binding's context, with the parameter <code>updateAggregatedMessages</code> set to
+	 *   <code>true</code>.
 	 * @param {object} [mParameters.treeAnnotationProperties]
 	 *   The mapping between data properties and the hierarchy used to visualize the tree, if not
 	 *   provided by the service's metadata. For the correct metadata annotations, check the
@@ -2212,6 +2223,9 @@ sap.ui.define([
 	 *   instead.
 	 * @param {sap.ui.model.Sorter | sap.ui.model.Sorter[]} [vSorters]
 	 *   The dynamic sorters to be used initially
+	 * @throws {Error} If one of the filters uses an operator that is not supported by the underlying model
+	 *   implementation or if the {@link sap.ui.model.Filter.NONE} filter instance is contained in
+	 *   <code>vFilters</code> together with other filters
 	 *
 	 * @returns {sap.ui.model.odata.v2.ODataTreeBinding}
 	 *   The new tree binding
@@ -4286,7 +4300,7 @@ sap.ui.define([
 			that = this;
 
 		if (!bBatch) {
-			bContent = !(oResponse.statusCode === 204 || oResponse.statusCode === '204');
+			bContent = !["204", "205"].includes(String(oResponse.statusCode));
 
 			sUri = oRequest.requestUri;
 			sPath = sUri.replace(this.sServiceUrl,"");
@@ -5557,12 +5571,12 @@ sap.ui.define([
 			}
 			if (oFunctionMetadata.parameter != null) {
 				oFunctionMetadata.parameter.forEach(function (oParam) {
-					oData[oParam.name] = that._createPropertyValue(oParam.type);
 					if (mUrlParams[oParam.name] !== undefined) {
 						oData[oParam.name] = mUrlParams[oParam.name];
 						mUrlParams[oParam.name] = ODataUtils.formatValue(mUrlParams[oParam.name],
 							oParam.type);
 					} else {
+						oData[oParam.name] = undefined;
 						Log.warning("No value given for parameter '" + oParam.name
 							+ "' of function import '" + sFunctionName + "'", that, sClassName);
 					}
@@ -6432,8 +6446,7 @@ sap.ui.define([
 		} else {
 			delete this.mChangedEntities[sKey];
 		}
-		Messaging.removeMessages(this.getMessagesByEntity(sKey,
-			/*bExcludePersistent*/!bDeleteEntity));
+		Messaging.removeMessages(this.getMessagesByEntity(sKey, /*bExcludePersistent*/true));
 
 		return pMetaDataLoaded;
 	};
@@ -7091,8 +7104,10 @@ sap.ui.define([
 	 *   Whether the created context is inactive. An inactive context will only be sent to the
 	 *   server after the first property update. From then on it behaves like any other created
 	 *   context. Supported since 1.98.0
-	 * @param {array|object} [mParameters.properties]
-	 *   An array that specifies a set of properties or the entry
+	 * @param {object|string[]} [mParameters.properties]
+	 *   The initial values of the entry, or an array that specifies a list of property names to be
+	 *   initialized with <code>undefined</code>; <b>Note:</b> Passing a list of property names is
+	 *   deprecated since 1.120; pass the initial values as an object instead
 	 * @param {boolean} [mParameters.refreshAfterChange]
 	 *   Whether to update all bindings after submitting this change operation, see
 	 *   {@link #setRefreshAfterChange}; if given, this overrules the model-wide
@@ -7180,21 +7195,6 @@ sap.ui.define([
 			}
 			if (typeof vProperties === "object" && !Array.isArray(vProperties)) {
 				oEntity = merge({}, vProperties);
-			} else {
-				for (var i = 0; i < oEntityMetadata.property.length; i++) {
-					var oPropertyMetadata = oEntityMetadata.property[i];
-
-					var bPropertyInArray = (vProperties ? vProperties.indexOf(oPropertyMetadata.name) : -1) > -1;
-					if (!vProperties || bPropertyInArray)  {
-						oEntity[oPropertyMetadata.name] = that._createPropertyValue(oPropertyMetadata.type);
-						if (bPropertyInArray) {
-							vProperties.splice(vProperties.indexOf(oPropertyMetadata.name),1);
-						}
-					}
-				}
-				if (vProperties) {
-					assert(vProperties.length === 0, "No metadata for the following properties found: " + vProperties.join(","));
-				}
 			}
 			sEntityType = "" + oEntityMetadata.entityType;
 			oEntitySetMetadata = that.oMetadata._getEntitySetByType(oEntityMetadata);
@@ -7432,42 +7432,6 @@ sap.ui.define([
 		return !!(oEntity && oEntity.__metadata && oEntity.__metadata.created);
 	};
 
-	/**
-	 * Return value for a property. This can also be a ComplexType property.
-	 *
-	 * @param {string} sType Fully qualified name of a type
-	 * @returns {any} The property value
-	 * @private
-	 */
-	ODataModel.prototype._createPropertyValue = function(sType) {
-		var oTypeInfo = this.oMetadata._splitName(sType); // name, namespace
-		var sNamespace = oTypeInfo.namespace;
-		var sTypeName = oTypeInfo.name;
-		if (sNamespace.toUpperCase() !== 'EDM') {
-			var oComplexType = {};
-			var oComplexTypeMetadata = this.oMetadata._getObjectMetadata("complexType",sTypeName,sNamespace);
-			assert(oComplexTypeMetadata, "Complex type " + sType + " not found in the metadata !");
-			for (var i = 0; i < oComplexTypeMetadata.property.length; i++) {
-				var oPropertyMetadata = oComplexTypeMetadata.property[i];
-				oComplexType[oPropertyMetadata.name] = this._createPropertyValue(oPropertyMetadata.type);
-			}
-			return oComplexType;
-		} else {
-			return this._getDefaultPropertyValue(sTypeName,sNamespace);
-		}
-	};
-
-	/**
-	 * Returns the default value for a property.
-	 * @param {string} sType The property type
-	 * @param {string} sNamespace The property namespace
-	 * @returns {string} Returns <code>undefined</code>
-	 * @private
-	 */
-	ODataModel.prototype._getDefaultPropertyValue = function(sType, sNamespace) {
-		return undefined;
-	};
-
 	/**
 	 * Remove URL params from path and make path absolute if not already
 	 *

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

@@ -42,6 +42,12 @@ sap.ui.define([
 	 *   The application filters to be used initially
 	 * @param {object} [mParameters]
 	 *   Map of binding parameters
+	 * @param {boolean} [mParameters.transitionMessagesOnly=false]
+	 *   Whether the tree binding only requests transition messages from the back end. If messages
+	 *   for entities of this collection need to be updated, use
+	 *   {@link sap.ui.model.odata.v2.ODataModel#read} on the parent entity corresponding to the
+	 *   tree binding's context, with the parameter <code>updateAggregatedMessages</code> set to
+	 *   <code>true</code>.
 	 * @param {object} [mParameters.treeAnnotationProperties]
 	 *   The mapping between data properties and the hierarchy used to visualize the tree, if not
 	 *   provided by the service's metadata
@@ -85,6 +91,9 @@ sap.ui.define([
 	 *   sets, which is used for constructing and paging the tree
 	 * @param {sap.ui.model.Sorter | sap.ui.model.Sorter[]} [vSorters]
 	 *   The dynamic sorters to be used initially
+	 * @throws {Error} If one of the filters uses an operator that is not supported by the underlying model
+	 *   implementation or if the {@link sap.ui.model.Filter.NONE} filter instance is contained in
+	 *   <code>vFilters</code> together with other filters
 	 *
 	 * @alias sap.ui.model.odata.v2.ODataTreeBinding
 	 * @author SAP SE
@@ -93,7 +102,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.TreeBinding
 	 * @hideconstructor
 	 * @public
-	 * @version 1.119.1
+	 * @version 1.120.1
 	 */
 	var ODataTreeBinding = TreeBinding.extend("sap.ui.model.odata.v2.ODataTreeBinding", /** @lends sap.ui.model.odata.v2.ODataTreeBinding.prototype */ {
 
@@ -132,7 +141,7 @@ sap.ui.define([
 			this.aApplicationFilters = vFilters;
 
 			// check filter integrity
-			this.oModel.checkFilterOperation(this.aApplicationFilters);
+			this.oModel.checkFilter(this.aApplicationFilters);
 
 			// a queue containing all parallel running requests
 			// a request is identified by (node id, startindex, length)
@@ -184,6 +193,7 @@ sap.ui.define([
 			this.oAllKeys = null;
 			this.oAllLengths = null;
 			this.oAllFinalLengths = null;
+			this.bTransitionMessagesOnly = !!this.mParameters.transitionMessagesOnly;
 
 			// Whether a refresh has been performed
 			this.bRefresh = false;
@@ -206,6 +216,18 @@ sap.ui.define([
 		Leaf: "leaf"
 	};
 
+	/**
+	 * Gets the request headers for a read request.
+	 *
+	 * @returns {Object<string, string>|undefined}
+	 *   The request headers for a read request, or <code>undefined</code> if no headers are required
+	 *
+	 * @private
+	 */
+	ODataTreeBinding.prototype._getHeaders = function () {
+		return this.bTransitionMessagesOnly ? {"sap-messages": "transientOnly"} : undefined;
+	};
+
 	/**
 	 * Builds a node filter string.
 	 * mParams.id holds the ID value for filtering on the hierarchy node.
@@ -258,6 +280,7 @@ sap.ui.define([
 		if (sAbsolutePath) {
 			this.mRequestHandles[sRequestKey] = this.oModel.read(sAbsolutePath, {
 				groupId: sGroupId,
+				headers: this._getHeaders(),
 				success: function (oData) {
 					var sNavPath = that._getNavPath(that.getPath());
 
@@ -823,16 +846,20 @@ sap.ui.define([
 
 		// figure out how to request the count
 		var sCountType = "";
+		let oHeaders;
 		if (this.sCountMode == CountMode.Request || this.sCountMode == CountMode.Both) {
 			sCountType = "/$count";
+			// this.bTransitionMessagesOnly is not relevant for $count requests -> no sap-messages header
 		} else if (this.sCountMode == CountMode.Inline || this.sCountMode == CountMode.InlineRepeat) {
 			aParams.push("$top=0");
 			aParams.push("$inlinecount=allpages");
+			oHeaders = this._getHeaders();
 		}
 
 		// send the counting request
 		if (sAbsolutePath) {
 			this.oModel.read(sAbsolutePath + sCountType, {
+				headers: oHeaders,
 				urlParameters: aParams,
 				success: _handleSuccess.bind(this),
 				error: _handleError.bind(this),
@@ -910,6 +937,7 @@ sap.ui.define([
 		if (sAbsolutePath) {
 			sGroupId = this.sRefreshGroupId ? this.sRefreshGroupId : this.sGroupId;
 			this.oModel.read(sAbsolutePath + "/$count", {
+				// this.bTransitionMessagesOnly is not relevant for $count requests -> no sap-messages header
 				urlParameters: aParams,
 				success: _handleSuccess,
 				error: _handleError,
@@ -1058,7 +1086,7 @@ sap.ui.define([
 				if (oData.results.length > 0) {
 					var sParentKey = this.oModel.getKey(oData.results[0]);
 					this._updateNodeKey(oNode, sParentKey);
-					var mKeys = this._createKeyMap(oData.results);
+					var mKeys = this._createKeyMap(oData.results, true);
 					this._importCompleteKeysHierarchy(mKeys);
 				}
 
@@ -1096,6 +1124,7 @@ sap.ui.define([
 			if (sAbsolutePath) {
 				sGroupId = this.sRefreshGroupId ? this.sRefreshGroupId : this.sGroupId;
 				this.mRequestHandles[sRequestKey] = this.oModel.read(sAbsolutePath, {
+					headers: this._getHeaders(),
 					urlParameters: aParams,
 					success: fnSuccess,
 					error: fnError,
@@ -1266,6 +1295,7 @@ sap.ui.define([
 			if (sAbsolutePath) {
 				sGroupId = this.sRefreshGroupId ? this.sRefreshGroupId : this.sGroupId;
 				this.mRequestHandles[sRequestKey] = this.oModel.read(sAbsolutePath, {
+					headers: this._getHeaders(),
 					urlParameters: aParams,
 					success: fnSuccess,
 					error: fnError,
@@ -1401,6 +1431,7 @@ sap.ui.define([
 				aURLParams.push("$top=" + this.iTotalCollectionCount);
 			}
 			this.mRequestHandles[sRequestKey] = this.oModel.read(sAbsolutePath, {
+				headers: this._getHeaders(),
 				urlParameters: aURLParams,
 				success: fnSuccess,
 				error: fnError,
@@ -1602,6 +1633,9 @@ sap.ui.define([
 	 *   depending on whether the filtering has been done
 	 * @return {this}
 	 *   Returns <code>this</code> to facilitate method chaining
+	 * @throws {Error} If one of the filters uses an operator that is not supported by the underlying model
+	 *   implementation or if the {@link sap.ui.model.Filter.NONE} filter instance is contained in
+	 *   <code>aFilters</code> together with other filters
 	 *
 	 * @see sap.ui.model.TreeBinding.prototype.filter
 	 * @public
@@ -1611,7 +1645,7 @@ sap.ui.define([
 		sFilterType = sFilterType || FilterType.Control;
 
 		// check filter integrity
-		this.oModel.checkFilterOperation(aFilters);
+		this.oModel.checkFilter(aFilters);
 
 		// check if filtering is supported for the current binding configuration
 		if (sFilterType == FilterType.Control && (!this.bClientOperation || this.sOperationMode == OperationMode.Server)) {

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

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.39.0
-		 * @version 1.119.1
+		 * @version 1.120.1
 		 */
 		Context = BaseContext.extend("sap.ui.model.odata.v4.Context", {
 				constructor : constructor
@@ -244,10 +244,12 @@ sap.ui.define([
 	 * model itself ensures that all bindings depending on this context become unresolved, but no
 	 * attempt is made to restore these bindings in case of reset or failure.
 	 *
-	 * Deleting a child node is supported (@experimental as of version 1.118.0) in a recursive
-	 * hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}). As a
-	 * precondition, <code>oAggregation.expandTo</code> must be equal to one, and the context must
-	 * not be {@link #setKeepAlive kept-alive} and hidden (for example due to a filter).
+	 * Deleting a node in a recursive hierarchy
+	 * (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}) is supported
+	 * (@experimental as of version 1.118.0). As a precondition, the context must not be
+	 * {@link #setKeepAlive kept-alive} and hidden (for example due to a filter), and the group ID
+	 * must not have {@link sap.ui.model.odata.v4.SubmitMode.API}. Such a deletion is not a pending
+	 * change.
 	 *
 	 * @param {string} [sGroupId]
 	 *   The group ID to be used for the DELETE request; if not specified, the update group ID for
@@ -867,6 +869,30 @@ sap.ui.define([
 		return _Helper.publicClone(this.getValue(sPath));
 	};
 
+	/**
+	 * Returns the parent node (in case of a recursive hierarchy, see {@link #setAggregation}, where
+	 * <code>oAggregation.expandTo</code> must be equal to one).
+	 *
+	 * @returns {sap.ui.model.odata.v4.Context|null}
+	 *   The parent node, or <code>null</code> if this node is a root node and thus has no parent
+	 * @throws {Error} If
+	 *   <ul>
+	 *     <li> this context is not a list binding's context,
+	 *     <li> this context is not part of a recursive hierarchy,
+	 *     <li> <code>oAggregation.expandTo</code> is greater than one.
+	 *    </ul>
+	 *
+	 * @experimental As of version 1.120.0
+	 * @public
+	 * @see #requestParent
+	 */
+	Context.prototype.getParent = function () {
+		if (!this.oBinding.getParent) {
+			throw new Error("Not a list binding's context: " + this);
+		}
+		return this.oBinding.getParent(this);
+	};
+
 	/**
 	 * Returns the property value for the given path relative to this context. The path is expected
 	 * to point to a structural property with primitive type. Returns <code>undefined</code>
@@ -1008,6 +1034,25 @@ sap.ui.define([
 			|| this.oModel.withUnresolvedBindings("hasPendingChangesInCaches", this.sPath.slice(1));
 	};
 
+	/**
+	 * Tells whether this node is an ancestor of (or the same as) the given node (in case of a
+	 * recursive hierarchy, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
+	 *
+	 * @param {sap.ui.model.odata.v4.Context} oNode - Some node which may be a descendant
+	 * @returns {boolean} Whether the assumed ancestor relation holds
+	 * @throws {Error} If either context does not represent a node in a recursive hierarchy
+	 *   according to the hierarchy's current {@link #isExpanded expanded state}
+	 *
+	 * @public
+	 * @since 1.120.0
+	 */
+	Context.prototype.isAncestorOf = function (oNode) {
+		if (!this.oBinding.isAncestorOf) {
+			throw new Error("Missing recursive hierarchy");
+		}
+		return this.oBinding.isAncestorOf(this, oNode);
+	};
+
 	/**
 	 * Returns whether this context is deleted. It becomes <code>true</code> immediately after
 	 * calling {@link #delete}, even while the request is waiting for
@@ -1141,7 +1186,8 @@ sap.ui.define([
 
 	/**
 	 * Moves this node to the given parent (in case of a recursive hierarchy, see
-	 * {@link #setAggregation}, where <code>oAggregation.expandTo</code> must be one). No other
+	 * {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}, where
+	 * <code>oAggregation.expandTo</code> must be one). No other
 	 * {@link sap.ui.model.odata.v4.ODataListBinding#create creation}, {@link #delete deletion}, or
 	 * move must be pending, and no other modification (including collapse of some ancestor node)
 	 * must happen while this move is pending!
@@ -1346,6 +1392,34 @@ sap.ui.define([
 		return Promise.resolve(this.fetchValue(sPath)).then(_Helper.publicClone);
 	};
 
+	/**
+	 * Requests the parent node (in case of a recursive hierarchy, see {@link #setAggregation},
+	 * where <code>oAggregation.expandTo</code> must be equal to one).
+	 *
+	 * @returns {Promise<sap.ui.model.odata.v4.Context|null>} A promise which:
+	 *   <ul>
+	 *     <li> Resolves if successful with either the parent node or <code>null</code> for a root
+	 *       node that has no parent</li>
+	 *     <li> Rejects with an <code>Error</code> instance otherwise</li>
+	 *   </ul>
+	 * @throws {Error} If
+	 *   <ul>
+	 *     <li> this context is not a list binding's context,
+	 *     <li> this context is not part of a recursive hierarchy,
+	 *     <li> <code>oAggregation.expandTo</code> is greater than one.
+	 *    </ul>
+	 *
+	 * @experimental As of version 1.120.0
+	 * @public
+	 * @see #getParent
+	 */
+	Context.prototype.requestParent = function () {
+		if (!this.oBinding.requestParent) {
+			throw new Error("Not a list binding's context: " + this);
+		}
+		return this.oBinding.requestParent(this);
+	};
+
 	/**
 	 * Returns a promise on the property value for the given path relative to this context. The path
 	 * is expected to point to a structural property with primitive type.
@@ -1883,7 +1957,7 @@ sap.ui.define([
 		var that = this;
 
 		if (this.isTransient() || bKeepAlive && this.isDeleted()) {
-			throw new Error("Unsupported context " + this);
+			throw new Error("Unsupported context: " + this);
 		}
 		_Helper.getPredicateIndex(this.sPath);
 		this.oBinding.checkKeepAlive(this, bKeepAlive);

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

@@ -695,6 +695,9 @@ sap.ui.define([
 				.then(function (sReducedPath) {
 					if (sReducedPath) {
 						vQueryOptions = undefined;
+					} else if (!vQueryOptions) {
+						// fetchCache only creates a cache if there are query options
+						vQueryOptions = {};
 					}
 					return wrapQueryOptions(false, sReducedPath);
 				});

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.119.1
+		 * @version 1.120.1
 		 *
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding