@openui5/sap.ui.core 1.107.1 → 1.108.1

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

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.39.0
-		 * @version 1.107.1
+		 * @version 1.108.1
 		 */
 		Context = BaseContext.extend("sap.ui.model.odata.v4.Context", {
 				constructor : constructor
@@ -281,18 +281,17 @@ sap.ui.define([
 	 * immediately, even if {@link sap.ui.model.odata.v4.SubmitMode.API} is used, and the request is
 	 * only sent later when {@link sap.ui.model.odata.v4.ODataModel#submitBatch} is called. As long
 	 * as the context is deleted on the client, but not yet on the server, {@link #isDeleted}
-	 * returns <code>true</code>. The context must not be used, e.g. as a binding context, while
-	 * {@link #isDeleted} returns <code>true</code>.
+	 * returns <code>true</code> and the context must not be used anymore (except for checking
+	 * {@link #isDeleted}), especially not as a binding context. The application has to take care
+	 * that the context is no longer used.
 	 *
 	 * Since 1.105 such a pending deletion is a pending change. It causes
 	 * <code>hasPendingChanges</code> to return <code>true</code> for the context, the binding
 	 * containing it, and the model. <code>resetChanges</code> in binding or model cancels the
 	 * deletion and restores the context.
 	 *
-	 * The usage of a group ID with {@link sap.ui.model.odata.v4.SubmitMode.API} is possible since
-	 * 1.105 - this is an experimental API.
-	 *
-	 * The context must not be used anymore after successful deletion.
+	 * If the DELETE request succeeds, the context is destroyed and must not be used anymore. If it
+	 * fails, the context is restored, reinserted into the list, and fully functional again.
 	 *
 	 * @param {string} [sGroupId]
 	 *   The group ID to be used for the DELETE request; if not specified, the update group ID for
@@ -300,7 +299,8 @@ sap.ui.define([
 	 *   is transient (see {@link #isTransient}), no group ID needs to be specified. Since 1.98.0,
 	 *   you can use <code>null</code> to prevent the DELETE request in case of a kept-alive context
 	 *   that is not in the collection and of which you know that it does not exist on the server
-	 *   anymore (for example, a draft after activation).
+	 *   anymore (for example, a draft after activation). Since 1.108.0 the usage of a group ID with
+	 *   {@link sap.ui.model.odata.v4.SubmitMode.API} is possible.
 	 * @param {boolean} [bDoNotRequestCount]
 	 *   Whether not to request the new count from the server; useful in case of
 	 *   {@link #replaceWith} where it is known that the count remains unchanged (since 1.97.0).
@@ -326,10 +326,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 resulting group ID has {@link sap.ui.model.odata.v4.SubmitMode.API}, and the
-	 *       context is {@link #isKeepAlive kept alive}, but not in the current collection,
-	 *     <li> (only before 1.105) the resulting group ID has
-	 *       {@link sap.ui.model.odata.v4.SubmitMode.API}
+	 *     <li> the context's binding is a list binding with data aggregation,
 	 *   </ul>
 	 *
 	 * @function
@@ -351,6 +348,9 @@ sap.ui.define([
 		if (this.isDeleted()) {
 			throw new Error("Must not delete twice: " + this);
 		}
+		if (this.oBinding.mParameters.$$aggregation) {
+			throw new Error("Cannot delete " + this + " when using data aggregation");
+		}
 		this.oBinding.checkSuspended();
 		if (this.isTransient()) {
 			sGroupId = null;
@@ -382,7 +382,7 @@ sap.ui.define([
 			if (oGroupLock) {
 				oGroupLock.unlock(true);
 			}
-			oModel.reportError("Failed to delete " + that, sClassName, oError);
+			oModel.reportError("Failed to delete " + that.getPath(), sClassName, oError);
 			that.bDeleted = false;
 			that.checkUpdate();
 			throw oError;
@@ -1100,10 +1100,15 @@ sap.ui.define([
 	 * @throws {Error} If
 	 *   <ul>
 	 *     <li> this context's root binding is suspended,
-	 *     <li> this context is transient (see {@link #isTransient}),
-	 *     <li> the given other context does not belong to the same list binding as this context, is
-	 *       already in the collection (has an index, see {@link #getIndex}), or is not
-	 *       {@link #isKeepAlive kept alive}.
+	 *     <li> this context is {@link #isTransient transient},
+	 *     <li> this context is {@link #isDeleted deleted},
+	 *     <li> the given other context
+	 *       <ul>
+	 *         <li> does not belong to the same list binding as this context,
+	 *         <li> is already in the collection (has an {@link #getIndex index}),
+	 *         <li> is {@link #delete deleted},
+	 *         <li> or is not {@link #isKeepAlive kept alive}.
+	 *     </ul>
 	 *   </ul>
 	 *
 	 * @public
@@ -1113,11 +1118,11 @@ sap.ui.define([
 		var oElement;
 
 		this.oBinding.checkSuspended();
-		if (this.isTransient()) {
+		if (this.isTransient() || this.isDeleted()) {
 			throw new Error("Cannot replace " + this);
 		}
 		if (oOtherContext.oBinding !== this.oBinding || oOtherContext.iIndex !== undefined
-				|| !oOtherContext.bKeepAlive) {
+			|| oOtherContext.bDeleted || !oOtherContext.bKeepAlive) {
 			throw new Error("Cannot replace with " + oOtherContext);
 		}
 		oElement = oOtherContext.getValue();
@@ -1338,6 +1343,10 @@ sap.ui.define([
 	 *   effects fails. Use it to set fields affected by side effects to read-only before
 	 *   {@link #requestSideEffects} and make them editable again when the promise resolves; in the
 	 *   error handler, you can repeat the loading of side effects.
+	 *   <br>
+	 *   The promise is rejected if the call wants to refresh a whole list binding (via header
+	 *   context or an absolute path), but the deletion of a row context (see {@link #delete}) is
+	 *   pending with a different group ID.
 	 * @throws {Error} If
 	 *   <ul>
 	 *     <li> metadata has not yet been loaded
@@ -1352,6 +1361,7 @@ sap.ui.define([
 	 *       {@link sap.ui.model.odata.v4.ODataPropertyBinding#getRootBinding}, and
 	 *       {@link sap.ui.model.Binding#isSuspended})
 	 *     <li> this context is transient (see {@link #isTransient})
+	 *     <li> this context is deleted (see {@link #isDeleted})
 	 *     <li> the binding of this context is unresolved (see
 	 *       {@link sap.ui.model.Binding#isResolved})
 	 *     <li> the group ID is invalid
@@ -1399,7 +1409,7 @@ sap.ui.define([
 
 		this.oBinding.checkSuspended();
 		_Helper.checkGroupId(sGroupId);
-		if (this.isTransient()) {
+		if (this.isTransient() || this.isDeleted()) {
 			throw new Error("Unsupported context: " + this);
 		}
 		if (!aPathExpressions || !aPathExpressions.length) {
@@ -1595,6 +1605,7 @@ sap.ui.define([
 	 *     <li> this context is not a list binding's context,
 	 *     <li> it is the header context,
 	 *     <li> it is transient,
+	 *     <li> it is deleted and <code>bKeepAlive</code> is <code>true</code>,
 	 *     <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>
@@ -1614,8 +1625,8 @@ sap.ui.define([
 	Context.prototype.setKeepAlive = function (bKeepAlive, fnOnBeforeDestroy, bRequestMessages) {
 		var that = this;
 
-		if (this.isTransient()) {
-			throw new Error("Unsupported transient context " + this);
+		if (this.isTransient() || bKeepAlive && this.isDeleted()) {
+			throw new Error("Unsupported context " + this);
 		}
 		_Helper.getPredicateIndex(this.sPath);
 		this.oBinding.checkKeepAlive(this);
@@ -1776,6 +1787,8 @@ sap.ui.define([
 	 * @returns {sap.ui.base.SyncPromise} A sync promise that is resolved with either the result of
 	 *   the processor or <code>undefined</code> if there is no cache for this binding, or if the
 	 *   cache determination is not yet completed
+	 *
+	 * @private
 	 */
 	Context.prototype.withCache = function (fnProcessor, sPath, bSync, bWithOrWithoutCache) {
 		if (this.iIndex === iVIRTUAL) {

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

@@ -22,7 +22,7 @@ sap.ui.define([
 	 * Tells whether the first given change reason has precedence over the second one.
 	 *
 	 * @param {string} sChangeReason0 - A change reason
-	 * @param {string} sChangeReason1  - A change reason
+	 * @param {string} sChangeReason1 - A change reason
 	 * @returns {boolean} Whether the first given change reason has precedence over the second one
 	 */
 	function hasPrecedenceOver(sChangeReason0, sChangeReason1) {
@@ -281,10 +281,10 @@ sap.ui.define([
 
 		this.mCacheQueryOptions = Object.assign({}, this.oModel.mUriParameters, mQueryOptions);
 		if (this.bRelative) { // quasi-absolute or relative binding
-			// The parent has to be persisted in order to know the key predicates when creating the
+			// The parent has to be persisted in order to know its key predicate when creating the
 			// child's own cache. Context#isTransient cannot be used exclusively here because it
 			// returns true for ODLB#create w/o bSkipRefresh, unless the refresh for the created
-			// entity is resolved too - but the entity's key predicates are already available.
+			// entity is resolved too - but the entity's key predicate is already available.
 			if (oContext.isTransient && oContext.isTransient()
 				&& oContext.getProperty("@$ui5.context.isTransient")) {
 				// Note: sResourcePath is kind of preliminary here, no use to remember it!
@@ -649,7 +649,7 @@ sap.ui.define([
 	};
 
 	/**
-	 * Fires the 'dataReceived' event. It may be bubbled up to the model.
+	 * Fires the 'dataReceived' event. The event is bubbled up to the model, unless it is prevented.
 	 *
 	 * @param {object} oParameters
 	 *   The event parameters
@@ -658,7 +658,7 @@ sap.ui.define([
 	 * @param {Error} [oParameters.error]
 	 *   The error object if a back-end request failed.
 	 * @param {boolean} [bPreventBubbling]
-	 *   Whether the dataRequested and dataReceived events must not be bubbled up to the model
+	 *   Whether to prevent bubbling this event to the model
 	 *
 	 * @private
 	 */
@@ -669,10 +669,11 @@ sap.ui.define([
 	};
 
 	/**
-	 * Fires the 'dataRequested' event. It may be bubbled up to the model.
+	 * Fires the 'dataRequested' event. The event is bubbled up to the model, unless it is
+	 * prevented.
 	 *
 	 * @param {boolean} [bPreventBubbling]
-	 *   Whether the dataRequested and dataReceived events must not be bubbled up to the model
+	 *   Whether to prevent bubbling this event to the model
 	 *
 	 * @private
 	 */
@@ -865,11 +866,10 @@ sap.ui.define([
 	};
 
 	/**
-	 * Returns <code>true</code> if this binding or its dependent bindings have pending property
-	 * changes or created entities which have not been sent successfully to the server. This
-	 * function does not take into account the deletion of entities (see
-	 * {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
-	 * (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}). Since 1.98.0,
+	 * Returns <code>true</code> if this binding or its dependent bindings have property changes,
+	 * created entities, or entity deletions which have not been sent successfully to the server.
+	 * This function does not take the execution of OData operations
+	 * (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}) into account. Since 1.98.0,
 	 * {@link sap.ui.model.odata.v4.Context#isInactive inactive} contexts are ignored.
 	 *
 	 * Note: If this binding is relative, its data is cached separately for each parent context
@@ -884,8 +884,9 @@ sap.ui.define([
 	 *   {@link sap.ui.model.odata.v4.ODataListBinding#refresh refresh} (since 1.100.0),
 	 *   {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or
 	 *   {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a
-	 *   {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} context of this binding
-	 *   (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
+	 *   {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} (since 1.97.0) or
+	 *   {@link sap.ui.model.odata.v4.Context#delete deleted} (since 1.108.0) context of this
+	 *   binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
 	 *   contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag.
 	 *   Since 1.99.0, the same happens for bindings using the <code>$$ownRequest</code> parameter
 	 *   (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
@@ -909,7 +910,7 @@ sap.ui.define([
 	 *   The path (absolute or relative to this binding)
 	 * @param {boolean} [bIgnoreKeptAlive]
 	 *   Whether to ignore changes which will not be lost by APIs like sort or filter because they
-	 *   relate to a context which is kept alive.
+	 *   relate to a deleted context or a context which is kept alive
 	 * @returns {boolean}
 	 *   <code>true</code> if there are pending changes for the path
 	 *
@@ -952,7 +953,7 @@ 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 context which is kept alive.
+	 *   relate to a deleted context or a context which is kept alive
 	 * @returns {boolean}
 	 *   <code>true</code> if this binding has pending changes
 	 *
@@ -1074,15 +1075,20 @@ sap.ui.define([
 	 * @throws {Error} If
 	 *   <ul>
 	 *     <li> the given group ID is invalid,
-	 *     <li> there are pending changes that cannot be ignored,
 	 *     <li> refresh on this binding is not supported,
 	 *     <li> a group ID different from the binding's group ID is specified for a suspended
 	 *       binding,
-	 *     <li> or a value of type boolean is given.
-	 *   </ul> Since 1.100.0, pending changes are ignored if they relate to a
-	 *   {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} context of this binding, and
-	 *   {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts of a
-	 *   {@link #getRootBinding root binding} do not count as pending changes.
+	 *     <li> a value of type <code>boolean</code> is given,
+	 *     <li> or there are pending changes that cannot be ignored.
+	 *   </ul>
+	 *   The following pending changes are ignored:
+	 *   <ul>
+	 *     <li> changes relating to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive}
+	 *       context of this binding (since 1.97.0),
+	 *     <li> {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts of a
+	 *       {@link #getRootBinding root binding} (since 1.98.0),
+	 *     <li> {@link sap.ui.model.odata.v4.Context#delete deleted} contexts (since 1.108.0).
+	 *   </ul>
 	 *
 	 * @public
 	 * @see sap.ui.model.Binding#refresh

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.107.1
+		 * @version 1.108.1
 		 *
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding
@@ -207,7 +207,7 @@ sap.ui.define([
 	 *   A lock for the group ID to be used for the DELETE request; w/o a lock, no DELETE is sent.
 	 *   For a transient entity, the lock is ignored (use NULL)!
 	 * @param {string} sEditUrl
-	 *   The entity's edit URL to be used for the DELETE request;  w/o a lock, this is mostly
+	 *   The entity's edit URL to be used for the DELETE request; w/o a lock, this is mostly
 	 *   ignored.
 	 * @param {sap.ui.model.odata.v4.Context} _oContext - ignored
 	 * @param {object} [_oETagEntity] - ignored
@@ -269,7 +269,7 @@ sap.ui.define([
 				if (oReturnValueContext) {
 					oEmptyPathParentBinding.oReturnValueContext = oReturnValueContext;
 				}
-				that._fireChange({reason : ChangeReason.Insert});
+				that._fireChange({reason : ChangeReason.Add});
 			}
 			throw oError;
 		});
@@ -930,7 +930,7 @@ sap.ui.define([
 	 *   control's property bindings use the return value context as binding context.
 	 * @throws {Error} If
 	 *   <ul>
-	 *     <li>the binding's root binding is suspended,
+	 *     <li> the binding's root binding is suspended,
 	 *     <li> the given group ID is invalid,
 	 *     <li> the binding is not a deferred operation binding (see
 	 *       {@link sap.ui.model.odata.v4.ODataContextBinding}),
@@ -1101,7 +1101,7 @@ sap.ui.define([
 			oEntity = oContext.getValue();
 
 			// avoid problems in fetchCanonicalPath (leading to an ODM#reportError)
-			if (oEntity && _Helper.getPrivateAnnotation(oEntity, "predicate")) {
+			if (oEntity && _Helper.hasPrivateAnnotation(oEntity, "predicate")) {
 				oPromise = oContext.fetchCanonicalPath();
 				oPromise.caught();
 				if (oPromise.getResult() === sCanonicalPath) {
@@ -1182,7 +1182,7 @@ sap.ui.define([
 	 * @returns {string}
 	 *   The resolved path with replaced transient predicates
 	 * @throws {Error}
-	 *   If an entity related to a segment with a transient predicate does not have key predicates
+	 *   If an entity related to a segment with a transient predicate does not have a key predicate
 	 *
 	 * @private
 	 */