@openui5/sap.ui.core 1.100.0 → 1.102.1

package/src/sap/ui/model/ListBinding.js

@@ -89,20 +89,13 @@ sap.ui.define(['./Binding', './Filter', './FilterType', './Sorter', 'sap/base/ut
 	/**
 	 * Returns an array of binding contexts for the bound target list.
 	 *
-	 * <h4>Extended Change Detection</h4>
-	 * If extended change detection is enabled using
-	 * {@link sap.ui.model.ListBinding.prototype.enableExtendedChangeDetection}, the context array
-	 * may carry an additional property named <code>diff</code>, which contains an array of actual
-	 * changes on the context array compared to the last call of <code>getContexts()</code>. In case
-	 * no <code>diff</code> property is available on the context array, the list is completely
-	 * different and needs to be recreated. In case the <code>diff</code> property contains an empty
-	 * array, there have been no changes on the list.
-	 *
-	 * Sample diff array:
-	 * <code>[{index: 1, type: "delete"}, {index: 4, type: "insert}]</code>
+	 * In case of extended change detection, the context array may have an additional
+	 * <code>diff</code> property, see
+	 * {@link topic:7cdff73f308b4b10bdf7d83b7aba72e7 documentation on extended change detection} for
+	 * details.
 	 *
 	 * <strong>Note:</strong>The public usage of this method is deprecated, as calls from outside of
-	 * controls will lead to unexpected side effects. To avoid these side effect, use
+	 * controls will lead to unexpected side effects. To avoid this, use
 	 * {@link sap.ui.model.ListBinding.prototype.getCurrentContexts} instead.
 	 *
 	 * @function
@@ -110,7 +103,8 @@ sap.ui.define(['./Binding', './Filter', './FilterType', './Sorter', 'sap/base/ut
 	 * @param {int} [iStartIndex=0]
 	 *   The startIndex where to start the retrieval of contexts
 	 * @param {int} [iLength=length of the list]
-	 *   Determines how many contexts to retrieve beginning from the start index.
+	 *   Determines how many contexts to retrieve beginning from the start index; default is the
+	 *   whole list length up to the model's size limit; see {@link sap.ui.model.Model#setSizeLimit}
 	 * @param {int} [iMaximumPrefetchSize]
 	 *   The maximum number of contexts to read before and after the given range; with this,
 	 *   controls can prefetch data that is likely to be needed soon, e.g. when scrolling down in a
@@ -120,6 +114,9 @@ sap.ui.define(['./Binding', './Filter', './FilterType', './Sorter', 'sap/base/ut
 	 *   This parameter is model-specific and not implemented by all models
 	 * @return {sap.ui.model.Context[]}
 	 *   The array of contexts for each row of the bound list
+	 * @throws {Error}
+	 *   If <code>bKeepCurrent</code> is set and extended change detection is enabled or
+	 *   <code>iMaximumPrefetchSize</code> is set
 	 *
 	 * @protected
 	 */
@@ -183,6 +180,28 @@ sap.ui.define(['./Binding', './Filter', './FilterType', './Sorter', 'sap/base/ut
 	 * @public
 	 */
 
+	/**
+	 * Checks whether keeping current contexts untouched is supported.
+	 *
+	 * @param {int} [iMaximumPrefetchSize]
+	 *   The maximum number of contexts to read before and after the given range
+	 * @throws {Error}
+	 *   If extended change detection is enabled, or if <code>iMaximumPrefetchSize</code> is set
+	 *
+	 * @private
+	 */
+	ListBinding.prototype._checkKeepCurrentSupported = function (iMaximumPrefetchSize) {
+		if (this.bUseExtendedChangeDetection) {
+			throw new Error("Unsupported operation: " + this.getMetadata().getName()
+				+ "#getContexts, must not use bKeepCurrent if extended change detection is"
+				+ " enabled");
+		}
+		if (iMaximumPrefetchSize) {
+			throw new Error("Unsupported operation: " + this.getMetadata().getName()
+				+ "#getContexts, must not use both iMaximumPrefetchSize and bKeepCurrent");
+		}
+	};
+
 	/**
 	 * Returns the contexts of this list binding as last requested by the control and in the same
 	 * order the control has received them.

package/src/sap/ui/model/MetaModel.js

@@ -16,7 +16,7 @@ sap.ui.define(['./Model'],
 	 * @extends sap.ui.model.Model
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @public
 	 * @alias sap.ui.model.MetaModel

package/src/sap/ui/model/Model.js

@@ -49,7 +49,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.message.MessageProcessor
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @public
 	 * @alias sap.ui.model.Model
@@ -766,14 +766,17 @@ sap.ui.define([
 	/**
 	 * Resolve the path relative to the given context.
 	 *
-	 * If a relative path is given (not starting with a '/') but no context,
-	 * then the path can't be resolved and undefined is returned.
+	 * If a relative path is given (not starting with a '/') but no context, then the path can't be
+	 * resolved and undefined is returned.
 	 *
-	 * For backward compatibility, the behavior of this method can be changed by
-	 * setting the 'legacySyntax' property. Then an unresolvable, relative path
-	 * is automatically converted into an absolute path.
+	 * If a context is given but no path, the resolved path is the context's path, see
+	 * {@link sap.ui.model.Context#getPath}.
 	 *
-	 * @param {string} sPath Path to resolve
+	 * For backward compatibility, the behavior of this method can be changed by setting the
+	 * 'legacySyntax' property. Then an unresolvable, relative path is automatically converted into
+	 * an absolute path.
+	 *
+	 * @param {string} [sPath] Path to resolve
 	 * @param {sap.ui.model.Context} [oContext] Context to resolve a relative path against
 	 *
 	 * @return {string} Resolved path or undefined

package/src/sap/ui/model/SelectionModel.js

@@ -20,7 +20,7 @@ sap.ui.define(['sap/ui/base/EventProvider', "sap/base/assert"],
 	 * @extends sap.ui.base.EventProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @param {int} iSelectionMode <code>sap.ui.model.SelectionModel.SINGLE_SELECTION</code> or <code>sap.ui.model.SelectionModel.MULTI_SELECTION</code>
 	 *

package/src/sap/ui/model/SimpleType.js

@@ -46,7 +46,7 @@ sap.ui.define([
 	 *
 	 * @extends sap.ui.model.Type
 	 * @public
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 */
 	var SimpleType = Type.extend("sap.ui.model.SimpleType", /** @lends sap.ui.model.SimpleType.prototype */ {
 

package/src/sap/ui/model/TreeAutoExpandMode.js

@@ -12,7 +12,7 @@ sap.ui.define([],
 	/**
 	 * Different modes for setting the auto expand mode on tree or analytical bindings.
 	 *
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 * @enum {string}
 	 * @alias sap.ui.model.TreeAutoExpandMode
 	 * @protected

package/src/sap/ui/model/Type.js

@@ -19,7 +19,7 @@ sap.ui.define(['sap/ui/base/Object'],
 	 *
 	 * @extends sap.ui.base.Object
 	 * @public
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 */
 	var Type = BaseObject.extend("sap.ui.model.Type", /** @lends sap.ui.model.Type.prototype */ {
 

package/src/sap/ui/model/_Helper.js

@@ -4,8 +4,10 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
-	"sap/base/util/extend"
-], function (extend) {
+	"sap/base/util/deepEqual",
+	"sap/base/util/extend",
+	"sap/base/util/merge"
+], function (deepEqual, extend, merge) {
 	"use strict";
 
 	/**
@@ -13,9 +15,11 @@ sap.ui.define([
 	 * @private
 	 */
 	var _Helper = {
-		// Trampoline property to allow for mocking in unit tests.
-		// @see sap.base.util.extend
-		extend : extend
+		// Trampoline properties to allow for mocking in unit tests.
+		// @see sap.base.util.*
+		deepEqual : deepEqual,
+		extend : extend,
+		merge : merge
 	};
 
 	return _Helper;

package/src/sap/ui/model/analytics/AnalyticalBinding.js

@@ -149,7 +149,7 @@ sap.ui.define([
 	 */
 	function logUnsupportedPropertyInSelect(sPath, sSelectedProperty, oDimensionOrMeasure) {
 		var sDimensionOrMeasure = oDimensionOrMeasure
-				instanceof sap.ui.model.analytics.odata4analytics.Dimension
+				instanceof odata4analytics.Dimension
 					? "dimension" : "measure";
 
 		if (oDimensionOrMeasure.getName() === sSelectedProperty) {

package/src/sap/ui/model/analytics/ODataModelAdapter.js

@@ -125,7 +125,8 @@ sap.ui.define(['./AnalyticalBinding', "./AnalyticalTreeBindingAdapter", './odata
 			this.oOData4SAPAnalyticsModel = new odata4analytics.Model(
 				new odata4analytics.Model.ReferenceByModel(this));
 		} catch (exception) {
-			throw "Failed to instantiate analytical extensions for given OData model: " + exception.message;
+			throw "Failed to instantiate analytical extensions for given OData model: "
+				+ (exception.message || exception);
 		}
 		return this.oOData4SAPAnalyticsModel;
 	};

package/src/sap/ui/model/json/JSONListBinding.js

@@ -39,62 +39,6 @@ sap.ui.define([
 	 */
 	var JSONListBinding = ClientListBinding.extend("sap.ui.model.json.JSONListBinding");
 
-	/**
-	 * Return contexts for the list or a specified subset of contexts
-	 * @param {int} [iStartIndex=0] the startIndex where to start the retrieval of contexts
-	 * @param {int} [iLength=length of the list] determines how many contexts to retrieve beginning from the start index.
-	 * Default is the whole list length.
-	 *
-	 * @return {Array} the contexts array
-	 * @protected
-	 */
-	JSONListBinding.prototype.getContexts = function(iStartIndex, iLength) {
-		this.iLastStartIndex = iStartIndex;
-		this.iLastLength = iLength;
-
-		if (!iStartIndex) {
-			iStartIndex = 0;
-		}
-		if (!iLength) {
-			iLength = Math.min(this.iLength, this.oModel.iSizeLimit);
-		}
-
-		var aContexts = this._getContexts(iStartIndex, iLength),
-			aContextData = [];
-
-		if (this.bUseExtendedChangeDetection) {
-			// Use try/catch to detect issues with cyclic references in JS objects,
-			// in this case diff will be disabled.
-			try {
-				for (var i = 0; i < aContexts.length; i++) {
-					aContextData.push(this.getContextData(aContexts[i]));
-				}
-
-				//Check diff
-				if (this.aLastContextData && iStartIndex < this.iLastEndIndex) {
-					aContexts.diff = this.diffData(this.aLastContextData, aContextData);
-				}
-
-				this.iLastEndIndex = iStartIndex + iLength;
-				this.aLastContexts = aContexts.slice(0);
-				this.aLastContextData = aContextData.slice(0);
-			} catch (oError) {
-				this.bUseExtendedChangeDetection = false;
-				Log.warning("JSONListBinding: Extended change detection has been disabled as JSON data could not be serialized.");
-			}
-		}
-
-		return aContexts;
-	};
-
-	JSONListBinding.prototype.getCurrentContexts = function() {
-		if (this.bUseExtendedChangeDetection) {
-			return this.aLastContexts || [];
-		} else {
-			return this.getContexts(this.iLastStartIndex, this.iLastLength);
-		}
-	};
-
 	/**
 	 * Get indices of the list
 	 */
@@ -199,7 +143,5 @@ sap.ui.define([
 		}
 	};
 
-
 	return JSONListBinding;
-
 });

package/src/sap/ui/model/json/JSONModel.js

@@ -44,7 +44,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.ClientModel
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 * @public
 	 * @alias sap.ui.model.json.JSONModel
 	 */

package/src/sap/ui/model/message/MessageListBinding.js

@@ -46,46 +46,6 @@ sap.ui.define([
 		}.bind(this);
 	};
 
-	/**
-	 * Return contexts for the list or a specified subset of contexts.
-	 * @param {int} [iStartIndex=0] the startIndex where to start the retrieval of contexts.
-	 * @param {int} [iLength=length of the list] determines how many contexts to retrieve beginning from the start index.
-	 * Default is the whole list length.
-	 *
-	 * @return {Array} the contexts array
-	 * @protected
-	 */
-	MessageListBinding.prototype.getContexts = function(iStartIndex, iLength) {
-		this.iLastStartIndex = iStartIndex;
-		this.iLastLength = iLength;
-
-		if (!iStartIndex) {
-			iStartIndex = 0;
-		}
-		if (!iLength) {
-			iLength = Math.min(this.iLength, this.oModel.iSizeLimit);
-		}
-
-		var aContexts = this._getContexts(iStartIndex, iLength), aContextData = [];
-
-		if (this.bUseExtendedChangeDetection) {
-
-			for (var i = 0; i < aContexts.length; i++) {
-				aContextData.push(this.getContextData(aContexts[i]));
-			}
-
-			//Check diff
-			if (this.aLastContexts && iStartIndex < this.iLastEndIndex) {
-				aContexts.diff = this.diffData(this.aLastContextData, aContexts);
-			}
-			this.iLastEndIndex = iStartIndex + iLength;
-			this.aLastContexts = aContexts.slice(0);
-			this.aLastContextData = aContextData.slice(0);
-		}
-
-		return aContexts;
-	};
-
 	/**
 	 * Treats the context's object as sap/ui/core/message/Message.
 	 * Its processor is removed, it is serialized and then the processor is re-added.
@@ -184,7 +144,5 @@ sap.ui.define([
 		}
 	};
 
-
 	return MessageListBinding;
-
 });

package/src/sap/ui/model/message/MessageModel.js

@@ -29,7 +29,7 @@ sap.ui.define(['sap/ui/model/BindingMode', 'sap/ui/model/ClientModel', 'sap/ui/m
 	 * @extends sap.ui.model.ClientModel
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @param {sap.ui.core.message.MessageManager} oMessageManager The MessageManager instance
 	 * @public

package/src/sap/ui/model/odata/ODataAnnotations.js

@@ -25,7 +25,7 @@ sap.ui.define([
 	 *
 	 * @author SAP SE
 	 * @version
-	 * 1.100.0
+	 * 1.102.1
 	 *
 	 * @public
 	 * @deprecated As of version 1.66, please use {@link sap.ui.model.odata.v2.ODataAnnotations} instead.

package/src/sap/ui/model/odata/ODataMessageParser.js

@@ -84,7 +84,7 @@ var sClassName = "sap.ui.model.odata.ODataMessageParser",
  * @extends sap.ui.core.message.MessageParser
  *
  * @author SAP SE
- * @version 1.100.0
+ * @version 1.102.1
  * @public
  * @alias sap.ui.model.odata.ODataMessageParser
  */

package/src/sap/ui/model/odata/ODataMetaModel.js

@@ -207,7 +207,7 @@ sap.ui.define([
 	 * {@link #loaded loaded} has been resolved!
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 * @alias sap.ui.model.odata.ODataMetaModel
 	 * @extends sap.ui.model.MetaModel
 	 * @public

package/src/sap/ui/model/odata/ODataMetadata.js

@@ -44,7 +44,7 @@ sap.ui.define([
 	 * Implementation to access OData metadata
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @public
 	 * @alias sap.ui.model.odata.ODataMetadata

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

@@ -76,7 +76,7 @@ sap.ui.define([
 	 *
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @public
 	 * @deprecated As of version 1.48, please use {@link sap.ui.model.odata.v2.ODataModel} instead.

package/src/sap/ui/model/odata/ODataTreeBindingFlat.js

@@ -12,11 +12,12 @@ sap.ui.define([
 	"sap/base/util/isEmptyObject",
 	"sap/base/util/uid",
 	"sap/ui/model/ChangeReason",
+	"sap/ui/model/Context",
 	"sap/ui/model/Filter",
 	"sap/ui/model/TreeBinding",
 	"sap/ui/model/TreeBindingUtils",
 	"sap/ui/model/odata/v2/ODataTreeBinding"
-], function(assert, Log, extend, isEmptyObject, uid, ChangeReason, Filter, TreeBinding,
+], function(assert, Log, extend, isEmptyObject, uid, ChangeReason, Context, Filter, TreeBinding,
 		TreeBindingUtils, ODataTreeBinding) {
 	"use strict";
 
@@ -3933,7 +3934,7 @@ sap.ui.define([
 
 			// check if we have a single context or an array of contexts
 			if (!Array.isArray(vContextHandles)) {
-				if (vContextHandles instanceof sap.ui.model.Context) {
+				if (vContextHandles instanceof Context) {
 					vContextHandles = [vContextHandles];
 				} else {
 					Log.warning("ODataTreeBinding.addContexts(): The child node argument is not of type sap.ui.model.Context.");
@@ -3961,7 +3962,7 @@ sap.ui.define([
 			for (var j = 0; j < vContextHandles.length; j++) {
 				oContext = vContextHandles[j];
 
-				if (!oContext || !(oContext instanceof sap.ui.model.Context)) {
+				if (!(oContext instanceof Context)) {
 					Log.warning("ODataTreeBindingFlat.addContexts(): no valid child context given!");
 					return;
 				}

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

@@ -29,6 +29,8 @@ sap.ui.define([
 		oDateTimeFormatMs,
 		oDateTimeOffsetFormat,
 		rDecimal = /^([-+]?)0*(\d+)(\.\d+|)$/,
+		// URL might be encoded, "(" becomes %28
+		rSegmentAfterCatalogService = /\/(Annotations|ServiceNames|ServiceCollection)(\(|%28)/,
 		oTimeFormat,
 		rTrailingDecimal = /\.$/,
 		rTrailingZeroes = /0+$/;
@@ -354,21 +356,17 @@ sap.ui.define([
 	ODataUtils.setAnnotationOrigin = function(sAnnotationURL, vParameters){
 
 		var sFinalAnnotationURL;
-		var iAnnotationIndex = sAnnotationURL.indexOf("/Annotations(");
+		var iSegmentAfterCatalogServiceIndex = sAnnotationURL.search(rSegmentAfterCatalogService);
 		var iHanaXsSegmentIndex = vParameters && vParameters.preOriginBaseUri ? vParameters.preOriginBaseUri.indexOf(".xsodata") : -1;
 
-		if (iAnnotationIndex === -1){ // URL might be encoded, "(" becomes %28
-			iAnnotationIndex = sAnnotationURL.indexOf("/Annotations%28");
-		}
-
-		if (iAnnotationIndex >= 0) { // annotation path is there
-			if (sAnnotationURL.indexOf("/$value", iAnnotationIndex) === -1) { // $value missing
+		if (iSegmentAfterCatalogServiceIndex >= 0) {
+			if (sAnnotationURL.indexOf("/$value", iSegmentAfterCatalogServiceIndex) === -1) { // $value missing
 				Log.warning("ODataUtils.setAnnotationOrigin: Annotation url is missing $value segment.");
 				sFinalAnnotationURL = sAnnotationURL;
 			} else {
 				// if the annotation URL is an SAP specific annotation url, we add the origin path segment...
-				var sAnnotationUrlBase =  sAnnotationURL.substring(0, iAnnotationIndex);
-				var sAnnotationUrlRest =  sAnnotationURL.substring(iAnnotationIndex, sAnnotationURL.length);
+				var sAnnotationUrlBase =  sAnnotationURL.substring(0, iSegmentAfterCatalogServiceIndex);
+				var sAnnotationUrlRest =  sAnnotationURL.substring(iSegmentAfterCatalogServiceIndex, sAnnotationURL.length);
 				var sAnnotationWithOrigin = ODataUtils.setOrigin(sAnnotationUrlBase, vParameters);
 				sFinalAnnotationURL = sAnnotationWithOrigin + sAnnotationUrlRest;
 			}

package/src/sap/ui/model/odata/OperationMode.js

@@ -75,6 +75,12 @@ sap.ui.define(function() {
 		 * <li>Count mode <code>None</code> is not supported together with operation mode <code>Auto</code></li>
 		 * </ol>
 		 *
+		 * @deprecated As of 1.102.0, because filtering and sorting may lead to different results
+		 *   when executed on the client and on the server, and thus to inconsistent behavior. If it
+		 *   is certain that the collection is completely loaded on the client, use
+		 *   {@link sap.ui.model.odata.OperationMode.Client}; otherwise, use
+		 *   {@link sap.ui.model.odata.OperationMode.Default} or
+		 *   {@link sap.ui.model.odata.OperationMode.Server}.
 		 * @public
 		 */
 		Auto: "Auto"

package/src/sap/ui/model/odata/type/Boolean.js

@@ -87,7 +87,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.ODataType
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @alias sap.ui.model.odata.type.Boolean
 	 * @param {object} [oFormatOptions]

package/src/sap/ui/model/odata/type/Byte.js

@@ -24,7 +24,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.Int
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @alias sap.ui.model.odata.type.Byte
 	 * @param {object} [oFormatOptions]

package/src/sap/ui/model/odata/type/Currency.js

@@ -61,7 +61,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.type.Currency
 	 * @public
 	 * @since 1.63.0
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 */
 	var Currency = BaseCurrency.extend("sap.ui.model.odata.type.Currency", {
 		constructor : function (oFormatOptions, oConstraints) {

package/src/sap/ui/model/odata/type/Date.js

@@ -106,7 +106,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.ODataType
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @alias sap.ui.model.odata.type.Date
 	 * @param {object} [oFormatOptions]

package/src/sap/ui/model/odata/type/DateTime.js

@@ -59,7 +59,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.DateTimeBase
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @alias sap.ui.model.odata.type.DateTime
 	 * @param {object} [oFormatOptions]

package/src/sap/ui/model/odata/type/DateTimeBase.js

@@ -132,7 +132,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.ODataType
 	 * @public
 	 * @since 1.27.0
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 */
 	var DateTimeBase = ODataType.extend("sap.ui.model.odata.type.DateTimeBase", {
 			constructor : function (oFormatOptions, oConstraints) {

package/src/sap/ui/model/odata/type/DateTimeOffset.js

@@ -28,7 +28,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.DateTimeBase
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.102.1
 	 *
 	 * @alias sap.ui.model.odata.type.DateTimeOffset
 	 * @param {object} [oFormatOptions]