@openui5/sap.ui.core 1.96.2 → 1.97.0

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

@@ -30,8 +30,6 @@ sap.ui.define([
 		CountMode, ODataFilter, ODataUtils,  OperationMode) {
 	"use strict";
 
-	/*global Set */
-
 	var aCreateParametersAllowlist = ["changeSetId", "error", "expand", "groupId", "success"];
 
 	/**
@@ -138,16 +136,14 @@ sap.ui.define([
 				this.bThresholdRejected = true;
 			}
 
-			var bUseExpandedList = this.checkExpandedList();
-			if (!bUseExpandedList) {
+			if (!this.checkExpandedList()) {
+				this._removePersistedCreatedContexts();
 				this.resetData();
 			}
 		},
 
 		metadata : {
-			publicMethods : [
-			                 "getLength"
-			                 ]
+			publicMethods : ["getLength"]
 		}
 
 	});
@@ -232,6 +228,12 @@ sap.ui.define([
 
 		if (this.bRefresh) {
 			this.bRefresh = false;
+			// if we do not need to load data after a refresh event (e.g. we have enough created
+			// contexts) we need to fire a change event to fulfill the contract that after a refresh
+			// event a change event is triggered when the data is available.
+			if (!aContexts.dataRequested && aContexts.length > 0) {
+				this._fireChange({reason : ChangeReason.Change});
+			}
 		} else {
 			// Do not create context data and diff in case of refresh, only if real data has been received
 			// The current behaviour is wrong and makes diff detection useless for OData in case of refresh
@@ -262,6 +264,9 @@ sap.ui.define([
 	 * As in OData all entities have a unique ID in the URL, the path of the
 	 * context is suitable here.
 	 *
+	 * @param {sap.ui.model.Context} oContext The context
+	 * @returns {string} The entry key for the given context
+	 *
 	 * @private
 	 */
 	ODataListBinding.prototype.getEntryKey = function(oContext) {
@@ -271,7 +276,14 @@ sap.ui.define([
 	/**
 	 * Returns the entry data as required for change detection/diff.
 	 *
-	 * This is a JSON serialization of the entity, in case select/expand were used with only the selected/expanded parts.
+	 * This is a JSON serialization of the entity, in case select/expand were used with only the
+	 * selected/expanded parts.
+	 *
+	 * @param {sap.ui.model.Context} oContext
+	 *   The context
+	 * @returns {any}
+	 *   The value for the given context or <code>undefined</code> if data or entity type
+	 *   cannot be found or if not all selected properties are available
 	 *
 	 * @private
 	 */
@@ -327,6 +339,10 @@ sap.ui.define([
 	/**
 	 * Setter for context.
 	 *
+	 * Entities that have been created via {@link #create} and saved in the back end are removed
+	 * from the creation rows area and inserted at the right position based on the current filters
+	 * and sorters.
+	 *
 	 * @param {Object} oContext
 	 *   The new context object
 	 * @throws {Error}
@@ -387,6 +403,7 @@ sap.ui.define([
 				this.abortPendingRequest();
 				this._fireChange({reason : ChangeReason.Context});
 			} else {
+				this._removePersistedCreatedContexts();
 				this._refresh();
 			}
 		}
@@ -479,19 +496,78 @@ sap.ui.define([
 	};
 
 	/**
-	 * Load data from model.
+	 * Adds the $filter query option to the given array of URL parameters if needed.
+	 * The application/control filters, as stored in <code>this.sFilterParams</code> are considered
+	 * only if the given <code>bUseFilterParams</code> is set. The exclude filter for created
+	 * persisted entities is always considered to avoid duplicates or a wrong count.
+	 *
+	 * @param {string[]} aURLParams The array of URL parameters
+	 * @param {boolean} bUseFilterParams Whether to consider <code>this.sFilterParams</code>
+	 *
+	 * @private
+	 */
+	ODataListBinding.prototype._addFilterQueryOption = function (aURLParams, bUseFilterParams) {
+		var sExcludeFilter = this._getCreatedPersistedExcludeFilter();
+
+		if (this.sFilterParams && bUseFilterParams) {
+			if (sExcludeFilter) {
+				// this.sFilterParams starts with $filter=, so slice it
+				aURLParams.push("$filter=(" + this.sFilterParams.slice(8) + ")%20and%20"
+					+ sExcludeFilter);
+			} else {
+				aURLParams.push(this.sFilterParams);
+			}
+		} else if (sExcludeFilter) {
+			aURLParams.push("$filter=" + sExcludeFilter);
+		}
+	};
+
+	/**
+	 * Gets the exclude filter for the created and persisted contexts of this list binding.
+	 *
+	 * @returns {string|undefined} The exclude filter or <code>undefined</code> if there are no
+	 *   created and persisted contexts in the cache.
+	 *
+	 * @private
+	 */
+	ODataListBinding.prototype._getCreatedPersistedExcludeFilter = function () {
+		var sExcludeFilter, aExcludeFilters,
+			aCreatedPersistedContexts = this._getCreatedContexts().filter(function (oContext) {
+				return !oContext.isTransient();
+			}),
+			that = this;
+
+		if (aCreatedPersistedContexts.length > 0) {
+			aExcludeFilters = aCreatedPersistedContexts.map(function (oContext) {
+				var sPath = oContext.getPath();
+
+				return that._getFilterForPredicate(sPath.slice(sPath.indexOf("(")));
+			});
+			sExcludeFilter = "not("
+				+ ODataUtils._createFilterParams(aExcludeFilters.length === 1
+						? aExcludeFilters[0]
+						: new Filter({filters : aExcludeFilters}),
+					this.oModel.oMetadata, this.oEntityType)
+				+ ")";
+		}
+
+		return sExcludeFilter;
+	};
+
+	/**
+	 * Load data for the given range from server.
 	 *
 	 * @param {int} iStartIndex The start index
-	 * @param {int} iLength The count of data to be requested
-	 * Load list data from the server
+	 * @param {int} iLength The amount of data to be requested
 	 * @private
 	 */
 	ODataListBinding.prototype.loadData = function(iStartIndex, iLength) {
-
-		var that = this,
-		bInlineCountRequested = false,
-		sGuid = uid(),
-		sGroupId;
+		var sGroupId,
+			sGuid = uid(),
+			bInlineCountRequested = false,
+			aParams = [],
+			sPath = this.sPath,
+			that = this;
 
 		// create range parameters and store start index for sort/filter requests
 		if (iStartIndex || iLength) {
@@ -503,18 +579,13 @@ sap.ui.define([
 
 		// create the request url
 		// $skip/$top and are excluded for OperationMode.Client and Auto if the threshold was sufficient
-		var aParams = [];
 		if (this.sRangeParams && !this.useClientMode()) {
 			aParams.push(this.sRangeParams);
 		}
 		if (this.sSortParams) {
 			aParams.push(this.sSortParams);
 		}
-		// When in OperationMode.Auto, the filters are excluded and applied clientside,
-		// except when the threshold was rejected, and the binding will internally run in Server Mode
-		if (this.sFilterParams && !this.useClientMode()) {
-			aParams.push(this.sFilterParams);
-		}
+		this._addFilterQueryOption(aParams, !this.useClientMode());
 		if (this.sCustomParams) {
 			aParams.push(this.sCustomParams);
 		}
@@ -567,48 +638,46 @@ sap.ui.define([
 				that.bLengthFinal = true;
 				that.applyFilter();
 				that.applySort();
-			} else {
 				// For server mode, update data and or length dependent on the current result
-				if (oData.results.length > 0) {
-					// Collecting contexts, after the $inlinecount was evaluated, so we do not have to clear it again when
-					// the Auto modes initial threshold <> count check failed.
-					each(oData.results, function(i, entry) {
-						that.aKeys[iStartIndex + i] = that.oModel._getKey(entry);
-					});
+			} else if (oData.results.length > 0) {
+				// Collecting contexts, after the <code>$inlinecount</code> was evaluated, so we do
+				// not have to clear it again when Auto modes initial threshold <> count check
+				// failed.
+				each(oData.results, function(i, entry) {
+					that.aKeys[iStartIndex + i] = that.oModel._getKey(entry);
+				});
 
-					// if we got data and the results + startindex is larger than the
-					// length we just apply this value to the length
-					if (that.iLength < iStartIndex + oData.results.length) {
-						that.iLength = iStartIndex + oData.results.length;
-						that.bLengthFinal = false;
-					}
+				// if we got data and the results + startindex is larger than the
+				// length we just apply this value to the length
+				if (that.iLength < iStartIndex + oData.results.length) {
+					that.iLength = iStartIndex + oData.results.length;
+					that.bLengthFinal = false;
+				}
 
-					// if less entries are returned than have been requested
-					// set length accordingly
-					if (!oData.__next && (oData.results.length < iLength || iLength === undefined)) {
-						that.iLength = iStartIndex + oData.results.length;
-						that.bLengthFinal = true;
-					}
-				} else {
-					// In fault tolerance mode, if an empty array and next link is returned,
-					// finalize the length accordingly
-					if (that.bFaultTolerant && oData.__next) {
-						that.iLength = iStartIndex;
-						that.bLengthFinal = true;
-					}
+				// if less entries are returned than have been requested set length accordingly
+				if (!oData.__next && (oData.results.length < iLength || iLength === undefined)) {
+					that.iLength = iStartIndex + oData.results.length;
+					that.bLengthFinal = true;
+				}
+			} else {
+				// In fault tolerance mode, if an empty array and next link is returned,
+				// finalize the length accordingly
+				if (that.bFaultTolerant && oData.__next) {
+					that.iLength = iStartIndex;
+					that.bLengthFinal = true;
+				}
 
-					// check if there are any results at all...
-					if (iStartIndex === 0) {
-						that.iLength = 0;
-						that.aKeys = [];
-						that.bLengthFinal = true;
-					}
+				// check if there are any results at all...
+				if (iStartIndex === 0) {
+					that.iLength = 0;
+					that.aKeys = [];
+					that.bLengthFinal = true;
+				}
 
-					// if next requested page has no results, and startindex = actual length
-					// we could set lengthFinal true as we know the length.
-					if (iStartIndex === that.iLength) {
-						that.bLengthFinal = true;
-					}
+				// if next requested page has no results, and startindex = actual length
+				// we could set lengthFinal true as we know the length.
+				if (iStartIndex === that.iLength) {
+					that.bLengthFinal = true;
 				}
 			}
 
@@ -651,8 +720,6 @@ sap.ui.define([
 
 		}
 
-		var sPath = this.sPath;
-
 		if (this.isRelative()){
 			sPath = this.getResolvedPath();
 		}
@@ -713,21 +780,15 @@ sap.ui.define([
 	 * @private
 	 */
 	ODataListBinding.prototype._getLength = function() {
-		var that = this;
-		var sGroupId;
+		var sGroupId, sPath,
+			aParams = [],
+			that = this;
 
 		if (this.sCountMode !== CountMode.Request && this.sCountMode !== CountMode.Both) {
 			return;
 		}
 
-		// create a request object for the data request
-		// In OperationMode.Auto we explicitly omitt the filters for the count,
-		// filters will be applied afterwards on the client if count comes under the threshold
-		var aParams = [];
-		if (this.sFilterParams && this.sOperationMode != OperationMode.Auto) {
-			aParams.push(this.sFilterParams);
-		}
-
+		this._addFilterQueryOption(aParams, this.sOperationMode !== OperationMode.Auto);
 		// use only custom params for count and not expand,select params
 		if (this.mParameters && this.mParameters.custom) {
 			var oCust = { custom: {}};
@@ -765,7 +826,7 @@ sap.ui.define([
 		}
 
 		// Use context and check for relative binding
-		var sPath = this.getResolvedPath();
+		sPath = this.getResolvedPath();
 
 		// Only send request, if path is defined
 		if (sPath) {
@@ -809,6 +870,10 @@ sap.ui.define([
 	 * To update a control, even if no data has been changed, e.g. to reset a control after failed
 	 * validation, use the parameter <code>bForceUpdate</code>.
 	 *
+	 * Entities that have been created via {@link #create} and saved in the back end are removed
+	 * from the creation rows area and inserted at the right position based on the current filters
+	 * and sorters.
+	 *
 	 * @param {boolean} [bForceUpdate] Update the bound control even if no data has been changed
 	 * @param {string} [sGroupId] The group Id for the refresh
 	 *
@@ -819,12 +884,19 @@ sap.ui.define([
 			sGroupId = bForceUpdate;
 			bForceUpdate = false;
 		}
+		this._removePersistedCreatedContexts();
 		this.sRefreshGroupId = sGroupId;
 		this._refresh(bForceUpdate);
 		this.sRefreshGroupId = undefined;
 	};
 
 	/**
+	 * Refreshes the binding.
+	 *
+	 * @param {boolean} bForceUpdate Whether an update should be forced
+	 * @param {object} [mChangedEntities] A map of changed entities
+	 * @param {object} [mEntityTypes] A map of entity types
+	 *
 	 * @private
 	 */
 	ODataListBinding.prototype._refresh = function(bForceUpdate, mChangedEntities, mEntityTypes) {
@@ -854,6 +926,8 @@ sap.ui.define([
 
 						return false;
 					}
+
+					return true;
 				});
 			}
 			if (!mChangedEntities && !mEntityTypes) { // default
@@ -1047,6 +1121,8 @@ sap.ui.define([
 							bChangeDetected = true;
 							return false;
 						}
+
+						return true;
 					});
 				}
 			}
@@ -1131,17 +1207,22 @@ sap.ui.define([
 
 		sPath = this.getResolvedPath();
 
-		if (sPath) {
-			return this.oModel._createRequestUrl(sPath, null, aParams);
-		}
+		return sPath && this.oModel._createRequestUrl(sPath, null, aParams);
 	};
 
 	/**
 	 * Sorts the list.
 	 *
-	 * @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} aSorters A new sorter or an array of sorters which define the sort order
-	 * @param {boolean} [bReturnSuccess=false] Whether the success indicator should be returned instead of <code>this</code>
-	 * @return {this} Reference to <code>this</code> to facilitate method chaining or the success indicator
+	 * Entities that have been created via {@link #create} and saved in the back end are removed
+	 * from the creation rows area and inserted at the right position based on the current filters
+	 * and sorters.
+	 *
+	 * @param {sap.ui.model.Sorter|sap.ui.model.Sorter[]} aSorters
+	 *   A new sorter or an array of sorters which define the sort order
+	 * @param {boolean} [bReturnSuccess=false]
+	 *   Whether the success indicator should be returned instead of <code>this</code>
+	 * @return {this}
+	 *   Reference to <code>this</code> to facilitate method chaining or the success indicator
 	 * @public
 	 */
 	ODataListBinding.prototype.sort = function(aSorters, bReturnSuccess) {
@@ -1180,13 +1261,17 @@ sap.ui.define([
 					this.sChangeReason = ChangeReason.Sort;
 				}
 			} else {
+				// when removing the persisted created entries from the cache we break the invariant
+				// that the number of entries (read from server) does not change when sorting. So
+				// we need to update the length we received from the server
+				this.iLength += this._removePersistedCreatedContexts().length;
 				// Only reset the keys, length usually doesn't change when sorting
+				// therefore #resetData is not required
 				this.aKeys = [];
 				this.abortPendingRequest(false);
 				this.sChangeReason = ChangeReason.Sort;
 				this._fireRefresh({reason : this.sChangeReason});
 			}
-			// TODO remove this if the sort event gets removed which is now deprecated
 			this._fireSort({sorter: aSorters});
 			bSuccess = true;
 		}
@@ -1199,9 +1284,15 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sets the comparator for each sorter/filter in the array according to the
-	 * Edm type of the sort/filter property.
-	 * @param bSort Whether a comparator usable for sorting should be returned, where comparison with null returns a valid result.
+	 * Sets the comparator for each sorter/filter in the array according to the Edm type of the
+	 * sort/filter property.
+	 *
+	 * @param {object[]} aEntries
+	 *   Array of sorters/filters
+	 * @param {boolean} bSort
+	 *   Whether a comparator usable for sorting should be returned, where comparison with null
+	 *   returns a valid result
+	 *
 	 * @private
 	 */
 	ODataListBinding.prototype.addComparators = function(aEntries, bSort) {
@@ -1235,9 +1326,13 @@ sap.ui.define([
 	/**
 	 * Creates a comparator usable for sorting.
 	 *
-	 * The OData comparators return "NaN" for comparisons containing null values. While this is a valid result when used for filtering,
-	 * for sorting the null values need to be put in order, so the comparator must return either -1 or 1 instead, to have null sorted
-	 * at the top in ascending order and on the bottom in descending order.
+	 * The OData comparators return "NaN" for comparisons containing null values. While this is a
+	 * valid result when used for filtering, for sorting the null values need to be put in order, so
+	 * the comparator must return either -1 or 1 instead, to have null sorted at the top in
+	 * ascending order and on the bottom in descending order.
+	 *
+	 * @param {function} fnCompare Function to compare two values with
+	 * @returns {function} The sort comparator
 	 *
 	 * @private
 	 */
@@ -1257,8 +1352,13 @@ sap.ui.define([
 	}
 
 	/**
-	 * Does normalize the filter values according to the given Edm type. This is necessary for comparators
-	 * to work as expected, even if the wrong JavaScript type is passed to the filter (string vs number)
+	 * Does normalize the filter values according to the given Edm type. This is necessary for
+	 * comparators to work as expected, even if the wrong JavaScript type is passed to the filter
+	 * (string vs number).
+	 *
+	 * @param {string} sType The Edm type
+	 * @param {object} oFilter The filter
+	 *
 	 * @private
 	 */
 	function normalizeFilterValues(sType, oFilter) {
@@ -1323,6 +1423,10 @@ sap.ui.define([
 	 * are combined with OR, while filters on different table columns are combined with AND.
 	 * Please note that a custom filter function is only supported with operation mode <code>sap.ui.model.odata.OperationMode.Client</code>.
 	 *
+	 * Entities that have been created via {@link #create} and saved in the back end are removed
+	 * from the creation rows area and inserted at the right position based on the current filters
+	 * and sorters.
+	 *
 	 * @param {sap.ui.model.Filter|sap.ui.model.Filter[]} aFilters Single filter or array of filter objects
 	 * @param {sap.ui.model.FilterType} [sFilterType=Control] Type of the filter which should be adjusted. If it is not given, type <code>Control</code> is assumed
 	 * @param {boolean} [bReturnSuccess=false] Whether the success indicator should be returned instead of <code>this</code>
@@ -1381,12 +1485,12 @@ sap.ui.define([
 					this.sChangeReason = ChangeReason.Filter;
 				}
 			} else {
+				this._removePersistedCreatedContexts();
 				this.resetData();
 				this.abortPendingRequest(true);
 				this.sChangeReason = ChangeReason.Filter;
 				this._fireRefresh({reason: this.sChangeReason});
 			}
-			// TODO remove this if the filter event gets removed which is now deprecated
 			if (sFilterType === FilterType.Application) {
 				this._fireFilter({filters: this.aApplicationFilters});
 			} else {
@@ -1717,5 +1821,18 @@ sap.ui.define([
 		};
 	};
 
+	/**
+	 * Removes and returns the persisted created entities for this binding.
+	 *
+	 * @returns {sap.ui.model.odata.v2.Context[]}
+	 *   An array of persisted contexts that have been removed from the created contexts cache
+	 *
+	 * @private
+	 */
+	 ODataListBinding.prototype._removePersistedCreatedContexts = function () {
+		return this.oModel._getCreatedContextsCache()
+			.removePersistedContexts(this.getResolvedPath(), this.sCreatedEntitiesKey);
+	};
+
 	return ODataListBinding;
 });