@openui5/sap.ui.core 1.97.1 → 1.100.0

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

@@ -49,7 +49,6 @@ sap.ui.define([
 		EdmDate, DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Raw, SByte, Single,
 		Stream, String, TimeOfDay, URI) {
 	"use strict";
-	/*global Map */
 	/*eslint max-nested-callbacks: 0 */
 
 	var Any = ManagedObject.extend("sap.ui.model.odata.v4._any", {
@@ -64,10 +63,7 @@ sap.ui.define([
 		DEBUG = Log.Level.DEBUG,
 		rLeftBraces = /\$\(/g,
 		rNumber = /^-?\d+$/,
-		ODataMetaContextBinding,
-		ODataMetaListBinding,
 		sODataMetaModel = "sap.ui.model.odata.v4.ODataMetaModel",
-		ODataMetaPropertyBinding,
 		rPredicate = /\(.*\)$/,
 		oRawType = new Raw(),
 		rRightBraces = /\$\)/g,
@@ -81,7 +77,7 @@ sap.ui.define([
 			"Edm.Date" : {Type : EdmDate},
 			"Edm.DateTimeOffset" : {
 				constraints : {
-					"$Precision" : "precision"
+					$Precision : "precision"
 				},
 				Type : DateTimeOffset
 			},
@@ -93,8 +89,8 @@ sap.ui.define([
 					"@Org.OData.Validation.V1.Maximum/$Decimal" : "maximum",
 					"@Org.OData.Validation.V1.Maximum@Org.OData.Validation.V1.Exclusive" :
 						"maximumExclusive",
-					"$Precision" : "precision",
-					"$Scale" : "scale"
+					$Precision : "precision",
+					$Scale : "scale"
 				},
 				Type : Decimal
 			},
@@ -109,13 +105,13 @@ sap.ui.define([
 			"Edm.String" : {
 				constraints : {
 					"@com.sap.vocabularies.Common.v1.IsDigitSequence" : "isDigitSequence",
-					"$MaxLength" : "maxLength"
+					$MaxLength : "maxLength"
 				},
 				Type : String
 			},
 			"Edm.TimeOfDay" : {
 				constraints : {
-					"$Precision" : "precision"
+					$Precision : "precision"
 				},
 				Type : TimeOfDay
 			}
@@ -127,7 +123,47 @@ sap.ui.define([
 		sValueListRelevantQualifiers
 			= "@com.sap.vocabularies.Common.v1.ValueListRelevantQualifiers",
 		sValueListWithFixedValues = "@com.sap.vocabularies.Common.v1.ValueListWithFixedValues",
-		WARNING = Log.Level.WARNING;
+		WARNING = Log.Level.WARNING,
+		ODataMetaContextBinding,
+		/**
+		 * Do <strong>NOT</strong> call this private constructor, but rather use
+		 * {@link sap.ui.model.odata.v4.ODataModel#getMetaModel} instead.
+		 *
+		 * @param {object} oRequestor
+		 *   The metadata requestor
+		 * @param {string} sUrl
+		 *   The URL to the $metadata document of the service
+		 * @param {string|string[]} [vAnnotationUri]
+		 *   The URL (or an array of URLs) from which the annotation metadata are loaded
+		 *   Supported since 1.41.0
+		 * @param {sap.ui.model.odata.v4.ODataModel} oModel
+		 *   The model this meta model is related to
+		 * @param {boolean} [bSupportReferences=true]
+		 *   Whether <code>&lt;edmx:Reference></code> and <code>&lt;edmx:Include></code> directives
+		 *   are supported in order to load schemas on demand from other $metadata documents and
+		 *   include them into the current service ("cross-service references").
+		 *
+		 * @alias sap.ui.model.odata.v4.ODataMetaModel
+		 * @author SAP SE
+		 * @class Implementation of an OData metadata model which offers access to OData V4
+		 *   metadata. The meta model does not support any public events; attaching an event handler
+		 *   leads to an error.
+		 *
+		 *   This model is read-only.
+		 *
+		 *   This model is not prepared to be inherited from.
+		 *
+		 * @extends sap.ui.model.MetaModel
+		 * @hideconstructor
+		 * @public
+		 * @since 1.37.0
+		 * @version 1.100.0
+		 */
+		ODataMetaModel = MetaModel.extend("sap.ui.model.odata.v4.ODataMetaModel", {
+				constructor : constructor
+			}),
+		ODataMetaListBinding,
+		ODataMetaPropertyBinding;
 
 	/**
 	 * Adds the given reference URI to the map of reference URIs for schemas.
@@ -250,8 +286,8 @@ sap.ui.define([
 	 *   The term
 	 * @param {string} sExpectedTerm
 	 *   The expected term
-	 * @returns {string}
-	 *   The qualifier or undefined, if the term is not the expected term
+	 * @returns {string|undefined}
+	 *   The qualifier or <code>undefined</code>, if the term is not the expected term
 	 */
 	function getQualifier(sTerm, sExpectedTerm) {
 		if (sTerm === sExpectedTerm) {
@@ -268,8 +304,8 @@ sap.ui.define([
 	 *
 	 * @param {string} sTerm
 	 *   The term
-	 * @returns {string}
-	 *   The qualifier or undefined, if the term is not as expected
+	 * @returns {string|undefined}
+	 *   The qualifier or <code>undefined</code>, if the term is not as expected
 	 */
 	function getValueListQualifier(sTerm) {
 		var sQualifier = getQualifier(sTerm, sValueListMapping);
@@ -370,6 +406,10 @@ sap.ui.define([
 		return sQualifiedName.slice(0, sQualifiedName.lastIndexOf(".") + 1);
 	}
 
+	//*********************************************************************************************
+	// ODataMetaContextBinding
+	//*********************************************************************************************
+
 	/**
 	 * @class Context binding implementation for the OData metadata model.
 	 *
@@ -387,6 +427,7 @@ sap.ui.define([
 			// @see sap.ui.model.Binding#initialize
 			initialize : function () {
 				var oElementContext = this.oModel.createBindingContext(this.sPath, this.oContext);
+
 				this.bInitial = false; // initialize() has been called
 				if (oElementContext !== this.oElementContext) {
 					this.oElementContext = oElementContext;
@@ -407,6 +448,10 @@ sap.ui.define([
 			}
 		});
 
+	//*********************************************************************************************
+	// ODataMetaListBinding
+	//*********************************************************************************************
+
 	/**
 	 * @class List binding implementation for the OData metadata model which supports filtering on
 	 * the virtual property "@sapui.name" (which refers back to the name of the object in
@@ -481,7 +526,7 @@ sap.ui.define([
 				return Object.keys(oResult).filter(function (sKey) {
 					// always filter technical properties;
 					// filter annotations iff not iterating them
-					return sKey[0] !== "$" &&  bIterateAnnotations !== (sKey[0] !== "@");
+					return sKey[0] !== "$" && bIterateAnnotations !== (sKey[0] !== "@");
 				}).map(function (sKey) {
 					return new BaseContext(that.oModel, sResolvedPath + sKey);
 				});
@@ -551,6 +596,10 @@ sap.ui.define([
 		}
 	});
 
+	//*********************************************************************************************
+	// ODataMetaPropertyBinding
+	//*********************************************************************************************
+
 	/**
 	 * @class Property binding implementation for the OData metadata model.
 	 *
@@ -626,11 +675,15 @@ sap.ui.define([
 			}
 		});
 
+	//*********************************************************************************************
+	// ODataMetaModel
+	//*********************************************************************************************
+
 	/**
 	 * Do <strong>NOT</strong> call this private constructor, but rather use
 	 * {@link sap.ui.model.odata.v4.ODataModel#getMetaModel} instead.
 	 *
-	 * @param {object} oRequestor
+	 * @param {sap.ui.model.odata.v4.lib._MetadataRequestor} oRequestor
 	 *   The metadata requestor
 	 * @param {string} sUrl
 	 *   The URL to the $metadata document of the service
@@ -643,57 +696,36 @@ sap.ui.define([
 	 *   Whether <code>&lt;edmx:Reference></code> and <code>&lt;edmx:Include></code> directives are
 	 *   supported in order to load schemas on demand from other $metadata documents and include
 	 *   them into the current service ("cross-service references").
-	 *
-	 * @alias sap.ui.model.odata.v4.ODataMetaModel
-	 * @author SAP SE
-	 * @class Implementation of an OData metadata model which offers access to OData V4 metadata.
-	 *   The meta model does not support any public events; attaching an event handler leads to an
-	 *   error.
-	 *
-	 *   This model is read-only.
-	 *
-	 *   This model is not prepared to be inherited from.
-	 *
-	 * @extends sap.ui.model.MetaModel
-	 * @hideconstructor
-	 * @public
-	 * @since 1.37.0
-	 * @version 1.97.1
 	 */
-	var ODataMetaModel = MetaModel.extend("sap.ui.model.odata.v4.ODataMetaModel", {
-		/*
-		 * @param {sap.ui.model.odata.v4.lib._MetadataRequestor} oRequestor
-		 */
-		constructor : function (oRequestor, sUrl, vAnnotationUri, oModel, bSupportReferences) {
-			MetaModel.call(this);
-			this.aAnnotationUris = vAnnotationUri && !Array.isArray(vAnnotationUri)
-				? [vAnnotationUri] : vAnnotationUri;
-			this.sDefaultBindingMode = BindingMode.OneTime;
-			this.mETags = {};
-			this.oLastModified = new Date(0);
-			this.oMetadataPromise = null;
-			this.oModel = oModel;
-			this.mMetadataUrl2Promise = {};
-			this.oRequestor = oRequestor;
-			// maps the schema name to a map containing the URL references for the schema as key
-			// and a boolean value whether the schema has been read already as value; the URL
-			// reference is used by _MetadataRequestor#read()
-			// Example:
-			// mSchema2MetadataUrl = {
-			//   "A." : {"/A/$metadata" : false}, // namespace not yet read
-			//   // multiple references are ok as long as they are not read
-			//   "A.A." : {"/A/$metadata" : false, "/A/V2/$metadata" : false},
-			//   "B." : {"/B/$metadata" : true} // namespace already read
-			// }
-			this.mSchema2MetadataUrl = {};
-			this.mSupportedBindingModes = {"OneTime" : true, "OneWay" : true};
-			this.bSupportReferences = bSupportReferences !== false; // default is true
-			// ClientListBinding#filter calls checkFilterOperation on the model; ClientModel does
-			// not support "All" and "Any" filters
-			this.mUnsupportedFilterOperators = {"All" : true, "Any" : true};
-			this.sUrl = sUrl;
-		}
-	});
+	function constructor(oRequestor, sUrl, vAnnotationUri, oModel, bSupportReferences) {
+		MetaModel.call(this);
+		this.aAnnotationUris = vAnnotationUri && !Array.isArray(vAnnotationUri)
+			? [vAnnotationUri] : vAnnotationUri;
+		this.sDefaultBindingMode = BindingMode.OneTime;
+		this.mETags = {};
+		this.oLastModified = new Date(0);
+		this.oMetadataPromise = null;
+		this.oModel = oModel;
+		this.mMetadataUrl2Promise = {};
+		this.oRequestor = oRequestor;
+		// maps the schema name to a map containing the URL references for the schema as key
+		// and a boolean value whether the schema has been read already as value; the URL
+		// reference is used by _MetadataRequestor#read()
+		// Example:
+		// mSchema2MetadataUrl = {
+		//   "A." : {"/A/$metadata" : false}, // namespace not yet read
+		//   // multiple references are ok as long as they are not read
+		//   "A.A." : {"/A/$metadata" : false, "/A/V2/$metadata" : false},
+		//   "B." : {"/B/$metadata" : true} // namespace already read
+		// }
+		this.mSchema2MetadataUrl = {};
+		this.mSupportedBindingModes = {OneTime : true, OneWay : true};
+		this.bSupportReferences = bSupportReferences !== false; // default is true
+		// ClientListBinding#filter calls checkFilterOperation on the model; ClientModel does
+		// not support "All" and "Any" filters
+		this.mUnsupportedFilterOperators = {All : true, Any : true};
+		this.sUrl = sUrl;
+	}
 
 	/**
 	 * Indicates that the property bindings of this model support the binding parameter
@@ -1661,30 +1693,32 @@ sap.ui.define([
 			throw oError;
 		}
 
-		// First fetch the complete metapath to ensure that everything is in mScope
+		// First fetch the complete meta path to ensure that everything is in mScope
 		// This also ensures that the metadata is valid
 		return this.fetchObject(_Helper.getMetaPath(sResolvedPath)).then(function () {
 			// Then fetch mScope
 			return that.fetchEntityContainer();
 		}).then(function (mScope) {
-			var aEditUrl,        // The edit URL as array of segments (encoded)
+			var aEditUrl, // The edit URL as array of segments (encoded)
 				oEntityContainer = mScope[mScope.$EntityContainer],
-				sEntityPath,     // The absolute path to the entity for the PATCH (encoded)
-				oEntitySet,      // The entity set that starts the edit URL
-				sEntitySetName,  // The name of this entity set (decoded)
+				sEntityPath, // The absolute path to the entity for the PATCH (encoded)
+				oEntitySet, // The entity set that starts the edit URL
+				sEntitySetName, // The name of this entity set (decoded)
 				sFirstSegment,
 				bInsideAnnotation = false,
-				sInstancePath,   // The absolute path to the instance currently in evaluation
-								// (encoded; re-builds sResolvedPath)
+				// The absolute path to the instance currently in evaluation (encoded; re-builds
+				// sResolvedPath)
+				sInstancePath,
 				sNavigationPath, // The relative meta path starting from oEntitySet (decoded)
-				//sPropertyPath, // The relative path following sEntityPath (parameter re-used -
-								// encoded)
-				aSegments,       // The resource path split in segments (encoded)
-				oType;           // The type of the data at sInstancePath
+				// The relative path following sEntityPath (parameter re-used - encoded)
+				//sPropertyPath,
+				aSegments, // The resource path split in segments (encoded)
+				oType; // The type of the data at sInstancePath
 
 			// Determines the predicate from a segment (empty string if there is none)
 			function predicate(sSegment) {
 				var i = sSegment.indexOf("(");
+
 				return i >= 0 ? sSegment.slice(i) : "";
 			}
 
@@ -1697,6 +1731,7 @@ sap.ui.define([
 			// Strips off the predicate from a segment
 			function stripPredicate(sSegment) {
 				var i = sSegment.indexOf("(");
+
 				return i >= 0 ? sSegment.slice(0, i) : sSegment;
 			}
 
@@ -1850,7 +1885,7 @@ sap.ui.define([
 		 *
 		 * @returns {string} The annotation target
 		 */
-		function getOverloadTarget () {
+		function getOverloadTarget() {
 			var oOverload = aOverloads[0],
 				sSignature = "";
 
@@ -1909,8 +1944,8 @@ sap.ui.define([
 			});
 
 			if (!aTargets.length) {
-				throw new Error("No annotation '" + sValueList.slice(1) + "' in " +
-					oValueListModel.sServiceUrl);
+				throw new Error("No annotation '" + sValueList.slice(1) + "' in "
+					+ oValueListModel.sServiceUrl);
 			}
 
 			if (aTargets.length === 1) {
@@ -1934,8 +1969,8 @@ sap.ui.define([
 						}
 					});
 				} else if (!bValueListOnValueList) {
-					throw new Error("Unexpected annotation '" + sTerm.slice(1) +
-						"' for target '" + aTargets[0] + "' with namespace of data service in "
+					throw new Error("Unexpected annotation '" + sTerm.slice(1)
+						+ "' for target '" + aTargets[0] + "' with namespace of data service in "
 						+ oValueListModel.sServiceUrl);
 				}
 			});
@@ -2119,7 +2154,7 @@ sap.ui.define([
 	 *   The property
 	 * @param {string} sMetaPath
 	 *   The OData metadata model path corresponding to the given property
-	 * @returns {object}
+	 * @returns {object|undefined}
 	 *   The type constraints for the property or <code>undefined</code> if the property's type is
 	 *   not supported
 	 *
@@ -2165,7 +2200,7 @@ sap.ui.define([
 	 * Returns a snapshot of each $metadata or annotation file loaded so far, combined into a
 	 * single "JSON" object according to the streamlined OData V4 Metadata JSON Format.
 	 *
-	 * @returns {object}
+	 * @returns {object|undefined}
 	 *   The OData metadata as a "JSON" object, if it is already available, or
 	 *   <code>undefined</code>.
 	 *
@@ -2399,7 +2434,7 @@ sap.ui.define([
 	 *
 	 * @param {string} sPropertyPath
 	 *   An absolute path to an OData property within the OData data model
-	 * @returns {string}
+	 * @returns {string|undefined}
 	 *   The path of the property's unit or currency relative to the property's entity, or
 	 *   <code>undefined</code> in case the property has no associated unit or currency
 	 *
@@ -2871,9 +2906,9 @@ sap.ui.define([
 	 *     This way, "/EMPLOYEES" addresses the same object as "/$EntityContainer/EMPLOYEES", namely
 	 *     the "EMPLOYEES" child of the entity container.
 	 *   <li> Afterwards, if the current object is an array, it represents overloads for an
-	 *     operation. Annotations of an operation (since 1.71.0) or a parameter (since 1.66.0) can be
-	 *     immediately addressed, no matter if they apply for a single overload or for all overloads
-	 *     at the same time, for example "/TEAMS/acme.NewAction@" or
+	 *     operation. Annotations of an operation (since 1.71.0) or a parameter (since 1.66.0) can
+	 *     be immediately addressed, no matter if they apply for a single overload or for all
+	 *     overloads at the same time, for example "/TEAMS/acme.NewAction@" or
 	 *     "/TEAMS/acme.NewAction/Team_ID@". Annotations of an unbound operation overload can be
 	 *     addressed like "/OperationImport/@$ui5.overload@", while "/OperationImport/@" addresses
 	 *     annotations of the operation import itself. The special name "$ReturnType" can be used
@@ -3094,6 +3129,10 @@ sap.ui.define([
 	 *   information exists. It is also rejected with an error if the value list metadata is
 	 *   inconsistent.
 	 *
+	 *   Since 1.99.0, the <code>com.sap.vocabularies.Common.v1.ValueListWithFixedValues</code>
+	 *   annotation wins, even if a <code>com.sap.vocabularies.Common.v1.ValueList</code> annotation
+	 *   in the service itself has the <code>SearchSupported</code> property.
+	 *
 	 *   An inconsistency can result from one of the following reasons:
 	 *   <ul>
 	 *     <li> There is a reference, but the referenced service does not contain mappings for the
@@ -3105,9 +3144,6 @@ sap.ui.define([
 	 *     <li> There are multiple mappings for a fixed value list.
 	 *     <li> A <code>com.sap.vocabularies.Common.v1.ValueList</code> annotation in a referenced
 	 *       service has the property <code>CollectionRoot</code> or <code>SearchSupported</code>.
-	 *     <li> A <code>com.sap.vocabularies.Common.v1.ValueList</code> annotation in the service
-	 *       itself has the property <code>SearchSupported</code> and additionally the annotation
-	 *       <code>com.sap.vocabularies.Common.v1.ValueListWithFixedValues</code> is defined.
 	 *   </ul>
 	 *
 	 * @public
@@ -3150,11 +3186,6 @@ sap.ui.define([
 			 * @throws {Error} If there is already a mapping for the given qualifier
 			 */
 			function addMapping(mValueListMapping, sQualifier, sMappingUrl, oModel) {
-				if (bFixedValues !== undefined && "SearchSupported" in mValueListMapping) {
-					throw new Error("Must not set 'SearchSupported' in annotation "
-						+ "'com.sap.vocabularies.Common.v1.ValueList' and annotation "
-						+ "'com.sap.vocabularies.Common.v1.ValueListWithFixedValues'");
-				}
 				if ("CollectionRoot" in mValueListMapping) {
 					oModel = that.getOrCreateSharedModel(mValueListMapping.CollectionRoot,
 						undefined, bAutoExpandSelect);
@@ -3208,6 +3239,7 @@ sap.ui.define([
 					// insert the returned mappings into oValueListInfo in the order of aMappingUrls
 					aMappingUrls.forEach(function (sMappingUrl, i) {
 						var mvalueListMappingByQualifier = aResults[i].valueListMappingByQualifier;
+
 						Object.keys(mvalueListMappingByQualifier).forEach(function (sQualifier) {
 							addMapping(mvalueListMappingByQualifier[sQualifier], sQualifier,
 								sMappingUrl, aResults[i].$model);
@@ -3228,8 +3260,8 @@ sap.ui.define([
 				// Each reference must have contributed at least one qualifier. So if oValueListInfo
 				// is empty, there cannot have been a reference.
 				if (isEmptyObject(oValueListInfo)) {
-					throw new Error("No annotation '" + sValueListReferences.slice(1) + "' for " +
-						sPropertyPath);
+					throw new Error("No annotation '" + sValueListReferences.slice(1) + "' for "
+						+ sPropertyPath);
 				}
 
 				return aRelevantQualifiers && oContext && oContext.getBinding
@@ -3279,7 +3311,6 @@ sap.ui.define([
 	 */
 	ODataMetaModel.prototype.filterValueListRelevantQualifiers = function (mValueListByQualifier,
 		aRawRelevantQualifiers, sMetaPath, oContext) {
-
 		return this.requestValue4Annotation(aRawRelevantQualifiers, sMetaPath, oContext)
 			.then(function (aRelevantQualifiers) {
 				var mValueListByRelevantQualifier = {};
@@ -3334,7 +3365,7 @@ sap.ui.define([
 	 *   A relative or absolute path within the metadata model
 	 * @param {sap.ui.model.Context} [oContext]
 	 *   The context to be used as a starting point in case of a relative path
-	 * @returns {string}
+	 * @returns {string|undefined}
 	 *   Resolved path or <code>undefined</code>
 	 * @throws {Error}
 	 *   If relative path starts with a dot which is not followed by a forward slash