@openui5/sap.ui.core 1.94.0 → 1.97.0

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 // Provides the OData model implementation of a tree binding
 sap.ui.define([
 	"sap/base/assert",
@@ -92,7 +92,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.TreeBinding
 	 * @hideconstructor
 	 * @public
-	 * @version 1.94.0
+	 * @version 1.97.0
 	 */
 	var ODataTreeBinding = TreeBinding.extend("sap.ui.model.odata.v2.ODataTreeBinding", /** @lends sap.ui.model.odata.v2.ODataTreeBinding.prototype */ {
 
@@ -102,8 +102,8 @@ sap.ui.define([
 			//make sure we have at least an empty parameter object
 			this.mParameters = this.mParameters || mParameters || {};
 
-			this.sGroupId;
-			this.sRefreshGroupId;
+			this.sGroupId = undefined;
+			this.sRefreshGroupId = undefined;
 			this.oFinalLengths = {};
 			this.oLengths = {};
 			this.oKeys = {};
@@ -158,14 +158,9 @@ sap.ui.define([
 			}
 
 			// internal operation mode switch, default is the same as "OperationMode.Server"
-			this.bClientOperation = false;
-
-			// the internal operation mode might change, the external operation mode (this.sOperationMode) will always be the original value
-			switch (this.sOperationMode) {
-				case OperationMode.Server: this.bClientOperation = false; break;
-				case OperationMode.Client: this.bClientOperation = true; break;
-				case OperationMode.Auto: this.bClientOperation = false; break; //initially start the same as the server mode
-			}
+			// the internal operation mode might change, the external operation mode
+			// (this.sOperationMode) will always be the original value
+			this.bClientOperation = this.sOperationMode === OperationMode.Client;
 
 			// the threshold for the OperationMode.Auto
 			this.iThreshold = (mParameters && mParameters.threshold) || 0;
@@ -206,19 +201,30 @@ sap.ui.define([
 	/**
 	 * Builds a node filter string.
 	 * mParams.id holds the ID value for filtering on the hierarchy node.
+	 *
+	 * @param {object} mParams The filter params
+	 * @returns {string} The filter to use with <code>$filter</code>
 	 */
 	ODataTreeBinding.prototype._getNodeFilterParams = function (mParams) {
-		var sPropName = mParams.isRoot ? this.oTreeProperties["hierarchy-node-for"] : this.oTreeProperties["hierarchy-parent-node-for"];
+		var sPropName = mParams.isRoot ? this.oTreeProperties["hierarchy-node-for"]
+			: this.oTreeProperties["hierarchy-parent-node-for"];
 		var oEntityType = this._getEntityType();
-		return ODataUtils._createFilterParams(new Filter(sPropName, "EQ", mParams.id), this.oModel.oMetadata, oEntityType);
+		return ODataUtils._createFilterParams(new Filter(sPropName, "EQ", mParams.id),
+			this.oModel.oMetadata, oEntityType);
 	};
 
 	/**
 	 * Builds the Level-Filter string
+	 *
+	 * @param {string} sOperator The filter operator
+	 * @param {number} iLevel The filter level
+	 * @returns {string} The filter to use with <code>$filter</code>
 	 */
 	ODataTreeBinding.prototype._getLevelFilterParams = function (sOperator, iLevel) {
 		var oEntityType = this._getEntityType();
-		return ODataUtils._createFilterParams(new Filter(this.oTreeProperties["hierarchy-level-for"], sOperator, iLevel), this.oModel.oMetadata, oEntityType);
+		return ODataUtils._createFilterParams(
+			new Filter(this.oTreeProperties["hierarchy-level-for"], sOperator, iLevel),
+			this.oModel.oMetadata, oEntityType);
 	};
 
 	/**
@@ -411,19 +417,22 @@ sap.ui.define([
 	 * @public
 	 */
 	ODataTreeBinding.prototype.hasChildren = function(oContext) {
+		var iLength;
+
 		if (this.bHasTreeAnnotations) {
 			if (!oContext) {
 				return false;
 			}
-			var sDrilldownState = oContext.getProperty(this.oTreeProperties["hierarchy-drill-state-for"]);
+			var sDrilldownState = oContext.getProperty(
+				this.oTreeProperties["hierarchy-drill-state-for"]);
 
 			var sNodeKey = this.oModel.getKey(oContext);
-			//var sHierarchyNode = oContext.getProperty(this.oTreeProperties["hierarchy-node-for"]);
 
-			var iLength = this.oLengths[sNodeKey];
+			iLength = this.oLengths[sNodeKey];
 
-			// if the server returned no children for a node (even though it has a DrilldownState of "expanded"),
-			// the length for this node is set to 0 and finalized -> no children available
+			// if the server returned no children for a node (even though it has a DrilldownState of
+			// "expanded"), the length for this node is set to 0 and finalized
+			// -> no children available
 			if (iLength === 0 && this.oFinalLengths[sNodeKey]) {
 				return false;
 			}
@@ -435,8 +444,10 @@ sap.ui.define([
 			} else if (sDrilldownState === "leaf"){
 				return false;
 			} else {
-				Log.warning("The entity '" + oContext.getPath() + "' has not specified Drilldown State property value.");
-				//fault tolerance for empty property values (we optimistically say that those nodes can be expanded/collapsed)
+				Log.warning("The entity '" + oContext.getPath() +
+					"' has not specified Drilldown State property value.");
+				//fault tolerance for empty property values (we optimistically say that those nodes
+				// can be expanded/collapsed)
 				if (sDrilldownState === undefined || sDrilldownState === "") {
 					return true;
 				}
@@ -446,9 +457,10 @@ sap.ui.define([
 			if (!oContext) {
 				return this.oLengths[this.getPath()] > 0;
 			}
-			var iLength = this.oLengths[oContext.getPath() + "/" + this._getNavPath(oContext.getPath())];
+			iLength = this.oLengths[oContext.getPath() + "/" + this._getNavPath(oContext.getPath())];
 
-			//only return false if we definitely know that the length is 0, otherwise, we have either a known length or none at all (undefined)
+			//only return false if we definitely know that the length is 0, otherwise, we have
+			// either a known length or none at all (undefined)
 			return iLength !== 0;
 		}
 	};
@@ -558,6 +570,7 @@ sap.ui.define([
 				}
 			}
 
+			return false;
 			// check requested sections where we still wait for an answer
 		};
 
@@ -603,7 +616,7 @@ sap.ui.define([
 				i = Math.max((aMissingSections[0].startIndex - iThreshold - this._iPageSize), 0);
 				var iFirstStartIndex = aMissingSections[0].startIndex;
 				for (i; i < iFirstStartIndex; i++) {
-					var sKey = this.oKeys[sNodeId][i];
+					sKey = this.oKeys[sNodeId][i];
 					if (!sKey) {
 						if (!fnFindInLoadedSections(i)) {
 							aMissingSections = TreeBindingUtils.mergeSections(aMissingSections, {startIndex: i, length: 1});
@@ -620,7 +633,7 @@ sap.ui.define([
 				}
 
 				for (i; i < iEndIndex; i++) {
-					var sKey = this.oKeys[sNodeId][i];
+					sKey = this.oKeys[sNodeId][i];
 					if (!sKey) {
 						if (!fnFindInLoadedSections(i)) {
 							aMissingSections = TreeBindingUtils.mergeSections(aMissingSections, {startIndex: i, length: 1});
@@ -628,14 +641,13 @@ sap.ui.define([
 					}
 				}
 			}
-		} else {
 			// for initial loading of a node use this shortcut.
-			if (!fnFindInLoadedSections(iStartIndex)) {
-				// "i" is our shifted forward startIndex for the "negative" thresholding
-				// in this case i is always smaller than iStartIndex, but minimum is 0
-				var iLengthShift = iStartIndex - i;
-				aMissingSections = TreeBindingUtils.mergeSections(aMissingSections, {startIndex: i, length: iLength + iLengthShift + iThreshold});
-			}
+		} else if (!fnFindInLoadedSections(iStartIndex)) {
+			// "i" is our shifted forward startIndex for the "negative" thresholding
+			// in this case i is always smaller than iStartIndex, but minimum is 0
+			var iLengthShift = iStartIndex - i;
+			aMissingSections = TreeBindingUtils.mergeSections(aMissingSections,
+				{startIndex: i, length: iLength + iLengthShift + iThreshold});
 		}
 
 		// check if metadata are already available
@@ -701,17 +713,23 @@ sap.ui.define([
 					// request the missing sections and manage the loaded sections map
 					for (i = 0; i < aMissingSections.length; i++) {
 						var oRequestedSection = aMissingSections[i];
-						this._mLoadedSections[sNodeId] = TreeBindingUtils.mergeSections(this._mLoadedSections[sNodeId], {startIndex: oRequestedSection.startIndex, length: oRequestedSection.length});
-						this._loadSubNodes(sNodeId, oRequestedSection.startIndex, oRequestedSection.length, 0, aParams, mRequestParameters, oRequestedSection);
+						this._mLoadedSections[sNodeId] = TreeBindingUtils.mergeSections(
+							this._mLoadedSections[sNodeId],
+							{
+								startIndex: oRequestedSection.startIndex,
+								length: oRequestedSection.length
+							});
+						this._loadSubNodes(sNodeId, oRequestedSection.startIndex,
+							oRequestedSection.length, 0, aParams, mRequestParameters,
+							oRequestedSection);
 					}
-				} else {
-					// OperationMode is set to "Client" AND we have something missing (should only happen once, at the very first loading request)
+				} else if (!this.oAllKeys
+						&& !this.mRequestHandles[ODataTreeBinding.REQUEST_KEY_CLIENT]) {
+					// OperationMode is set to "Client" AND we have something missing (should only
+					// happen once, at the very first loading request)
 					// of course also make sure no request is running already
-					if (!this.oAllKeys && !this.mRequestHandles[ODataTreeBinding.REQUEST_KEY_CLIENT]) {
-						this._loadCompleteTreeWithAnnotations(aParams);
-					}
+					this._loadCompleteTreeWithAnnotations(aParams);
 				}
-
 			}
 		}
 
@@ -775,7 +793,7 @@ sap.ui.define([
 		// if necessary we add all other filters to the count request
 		var sFilterParams = "";
 		if (this.bUseServersideApplicationFilters) {
-			var sFilterParams = this.getFilterParams();
+			sFilterParams = this.getFilterParams();
 		}
 
 		//only build filter statement if necessary
@@ -809,10 +827,13 @@ sap.ui.define([
 
 	/**
 	 * Issues a $count request for the given node-id/odata-key.
-	 * Only used when running in CountMode.Request. Inlinecounts are appended directly when issuing a loading request.
+	 * Only used when running in <code>CountMode.Request</code>. Inlinecounts are appended directly
+	 * when issuing a loading request.
+	 *
+	 * @param {string} sNodeId The node's ID
 	 * @private
 	 */
-	ODataTreeBinding.prototype._getCountForNodeId = function(sNodeId, iStartIndex, iLength, iThreshold, mParameters) {
+	ODataTreeBinding.prototype._getCountForNodeId = function(sNodeId) {
 		var that = this,
 			sGroupId;
 
@@ -908,8 +929,12 @@ sap.ui.define([
 	/**
 	 * Creates key map for given data
 	 *
-	 * @param {Array} aData data which should be preprocessed
-	 * @returns {Object<string,string[]>} Map of parent and child keys
+	 * @param {Array} aData
+	 *   Data which should be preprocessed
+	 * @param {boolean} bSkipFirstNode
+	 *   Whether to skip the first node
+	 * @returns {Object<string,string[]>|undefined}
+	 *   Map of parent and child keys or <code>undefined</code> when <code>aData</code> is empty
 	 *
 	 * @private
 	 */
@@ -935,6 +960,8 @@ sap.ui.define([
 
 			return mKeys;
 		}
+
+		return undefined;
 	};
 
 	/**
@@ -961,8 +988,8 @@ sap.ui.define([
 	/**
 	 * Update node key in case if it changes
 	 *
-	 * @param {object} oNode
-	 * @param {string} sNewKey
+	 * @param {object} oNode The node
+	 * @param {string} sNewKey The new key
 	 *
 	 * @private
 	 */
@@ -1066,17 +1093,27 @@ sap.ui.define([
 	/**
 	 * Triggers backend requests to load the child nodes of the node with the given sNodeId.
 	 *
-	 * @param {string} sNodeId the value of the hierarchy node property on which a parent node filter will be performed
-	 * @param {int} iStartIndex start index of the page
-	 * @param {int} iLength length of the page
-	 * @param {int} iThreshold additionally loaded entities
-	 * @param {array} aParams OData URL parameters, already concatenated with "="
-	 * @param {object} mParameters additional request parameters
-	 * @param {object} mParameters.navPath the navigation path
+	 * @param {string} sNodeId
+	 *   The value of the hierarchy node property on which a parent node filter will be performed
+	 * @param {int} iStartIndex
+	 *   Start index of the page
+	 * @param {int} iLength
+	 *   Length of the page
+	 * @param {int} iThreshold
+	 *   Additionally loaded entities
+	 * @param {array} aParams
+	 *   OData URL parameters, already concatenated with "="
+	 * @param {object} mParameters
+	 *   Additional request parameters
+	 * @param {object} mParameters.navPath
+	 *   The navigation path
+	 * @param {object} oRequestedSection
+	 *   The requested section
 	 *
 	 * @private
 	 */
-	ODataTreeBinding.prototype._loadSubNodes = function(sNodeId, iStartIndex, iLength, iThreshold, aParams, mParameters, oRequestedSection) {
+	ODataTreeBinding.prototype._loadSubNodes = function(sNodeId, iStartIndex, iLength, iThreshold,
+			aParams, mParameters, oRequestedSection) {
 		var that = this,
 			sGroupId,
 			bInlineCountRequested = false;
@@ -1102,6 +1139,7 @@ sap.ui.define([
 		var sRequestKey = "" + sNodeId + "-" + iStartIndex + "-" + this._iPageSize + "-" + iThreshold;
 
 		function fnSuccess(oData) {
+			var oEntry, i;
 
 			if (oData) {
 				// make sure we have a keys array
@@ -1123,8 +1161,8 @@ sap.ui.define([
 				if (that.bHasTreeAnnotations) {
 					var mLastNodeIdIndices = {};
 
-					for (var i = 0; i < oData.results.length; i++) {
-						var oEntry = oData.results[i];
+					for (i = 0; i < oData.results.length; i++) {
+						oEntry = oData.results[i];
 
 						if (i == 0) {
 							mLastNodeIdIndices[sNodeId] = iStartIndex;
@@ -1137,8 +1175,8 @@ sap.ui.define([
 					}
 				} else {
 					// Case 1b: Navigation Properties
-					for (var i = 0; i < oData.results.length; i++) {
-						var oEntry = oData.results[i];
+					for (i = 0; i < oData.results.length; i++) {
+						oEntry = oData.results[i];
 						var sKey = that.oModel._getKey(oEntry);
 						that._processODataObject(oEntry, "/" + sKey, mParameters.navPath);
 						that.oKeys[sNodeId][i + iStartIndex] = sKey;
@@ -1225,9 +1263,11 @@ sap.ui.define([
 	ODataTreeBinding.REQUEST_KEY_CLIENT = "_OPERATIONMODE_CLIENT_TREE_LOADING";
 
 	/**
-	 * Loads the complete collection from the given binding path.
-	 * The tree is then reconstructed from the response entries based on the properties with hierarchy annotations.
+	 * Loads the complete collection from the given binding path. The tree is then reconstructed
+	 * from the response entries based on the properties with hierarchy annotations.
 	 * Adds additional URL parameters.
+	 *
+	 * @param {string[]} aURLParams Additional URL parameters
 	 */
 	ODataTreeBinding.prototype._loadCompleteTreeWithAnnotations = function (aURLParams) {
 		var that = this;
@@ -1375,16 +1415,11 @@ sap.ui.define([
 		} else {
 			this.oKeys = {};
 
-			// the internal operation mode might change, the external operation mode (this.sOperationMode) will always be the original value
+			// the internal operation mode might change, the external operation mode
+			// (this.sOperationMode) will always be the original value
 			// internal operation mode switch, default is the same as "OperationMode.Server"
-			this.bClientOperation = false;
+			this.bClientOperation = this.sOperationMode === OperationMode.Client;
 
-			// the internal operation mode might change, the external operation mode (this.sOperationMode) will always be the original value
-			switch (this.sOperationMode) {
-				case OperationMode.Server: this.bClientOperation = false; break;
-				case OperationMode.Client: this.bClientOperation = true; break;
-				case OperationMode.Auto: this.bClientOperation = false; break; //initially start the same as the server mode
-			}
 			// if no data is available after the reset we can't be sure the threshold is met or rejected
 			this.bThresholdRejected = false;
 
@@ -1439,8 +1474,8 @@ sap.ui.define([
 	 * validation, use the parameter <code>bForceUpdate</code>.
 	 *
 	 * @param {boolean} [bForceUpdate] Update the bound control even if no data has been changed
-	 * @param {object} [mChangedEntities]
-	 * @param {string} [mEntityTypes]
+	 * @param {object} [mChangedEntities] A map of changed entities
+	 * @param {string} [mEntityTypes] A map of entity types
 	 *
 	 * @private
 	 */
@@ -1503,25 +1538,36 @@ sap.ui.define([
 	/**
 	 * Applies the given filters to the ODataTreeBinding.
 	 *
-	 * Please note that filters of type <code>FilterType.Control</code> are not supported for <code>OperationMode.Server</code>,
-	 * here only filters of type <code>FilterType.Application</code> are allowed. Filters given via the constructor are always
-	 * of type <code>Application</code> and will be sent with every backend request.
-	 * See the constructor documentation for more information.
+	 * Please note that filters of type <code>FilterType.Control</code> are not supported for
+	 * <code>OperationMode.Server</code>,
+	 * here only filters of type <code>FilterType.Application</code> are allowed. Filters given via
+	 * {@link sap.ui.model.odata.v2.ODataModel#bindTree} are always
+	 * of type <code>Application</code> and will be sent with every back-end request.
+	 * For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
 	 *
-	 * Since 1.34.0, complete client-side filtering is supported for <code>OperationMode.Client</code> and also in
-	 * <code>OperationMode.Auto</code> if the backend count is lower than the threshold.
+	 * Since 1.34.0, complete client-side filtering is supported for
+	 * <code>OperationMode.Client</code> and also in <code>OperationMode.Auto</code> if the
+	 * back-end count is lower than the threshold.
 	 * In this case, all types of filters will be applied on the client.
-	 * See also: {@link sap.ui.model.odata.OperationMode.Auto}, {@link sap.ui.model.FilterType}.
-	 *
-	 * For the <code>OperationMode.Client</code> and <code>OperationMode.Auto</code>, you may also specify the
-	 * binding parameter <code>useServersideApplicationFilters</code> in the constructor. If it is set, the filters of type
-	 * <code>Application</code> will always be applied on the backend and trigger an OData request.
-	 * See the constructor documentation for more information.
-	 *
-	 * @param {sap.ui.model.Filter[]|sap.ui.model.Filter} aFilters Filter or array of filters to apply
-	 * @param {sap.ui.model.FilterType} sFilterType Type of the filter which should be adjusted. If it is not given,
+	 * See also: {@link sap.ui.model.odata.OperationMode.Auto} and {@link sap.ui.model.FilterType}.
+	 *
+	 * For the <code>OperationMode.Client</code> and <code>OperationMode.Auto</code>, you may also
+	 * specify the <code>useServersideApplicationFilters</code>  binding parameter when creating an
+	 * instance. If it is set, the filters of type <code>Application</code> will always be applied
+	 * on the back end and trigger an OData request.
+	 * For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
+	 *
+	 * @param {sap.ui.model.Filter[]|sap.ui.model.Filter} aFilters
+	 *   Filter or array of filters to apply
+	 * @param {sap.ui.model.FilterType} sFilterType
+	 *   Type of the filter which should be adjusted. If it is not given,
 	 *   the type <code>FilterType.Control</code> is assumed
-	 * @return {this} Returns <code>this</code> to facilitate method chaining
+	 * @param {boolean} [bReturnSuccess]
+	 *   Whether to return <code>true</code> or <code>false</code>, instead of <code>this</code>,
+	 *   depending on whether the filtering has been done
+	 * @return {this}
+	 *   Returns <code>this</code> to facilitate method chaining
+	 *
 	 * @see sap.ui.model.TreeBinding.prototype.filter
 	 * @public
 	 */
@@ -1536,7 +1582,8 @@ sap.ui.define([
 		if (sFilterType == FilterType.Control && (!this.bClientOperation || this.sOperationMode == OperationMode.Server)) {
 			Log.warning("Filtering with ControlFilters is ONLY possible if the ODataTreeBinding is running in OperationMode.Client or " +
 			"OperationMode.Auto, in case the given threshold is lower than the total number of tree nodes.");
-			return;
+
+			return this;
 		}
 
 		// empty filters
@@ -1672,11 +1719,17 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sorts the Tree according to the given Sorter(s).
-	 * In OperationMode.Client or OperationMode.Auto (if the given threshold is satisfied), the sorters are applied locally on the client.
-	 *
-	 * @param {sap.ui.model.Sorter[]|sap.ui.model.Sorter} aSorters the Sorter or an Array of sap.ui.model.Sorter instances
+	 * Sorts the Tree according to the given Sorter(s). In <code>OperationMode.Client</code> or
+	 * <code>OperationMode.Auto</code> (if the given threshold is satisfied), the sorters are
+	 * applied locally on the client.
+	 *
+	 * @param {sap.ui.model.Sorter[]|sap.ui.model.Sorter} aSorters
+	 *   The Sorter or an Array of sap.ui.model.Sorter instances
+	 * @param {boolean} [bReturnSuccess]
+	 *   Whether to return <code>true</code> or <code>false</code>, instead of <code>this</code>,
+	 *   depending on whether the sorting has been done
 	 * @return {this} returns <code>this</code> to facilitate method chaining
+	 *
 	 * @public
 	 */
 	ODataTreeBinding.prototype.sort = function(aSorters, bReturnSuccess) {
@@ -1720,6 +1773,10 @@ sap.ui.define([
 	/**
 	 * Sets the comparator for each sorter in the sorters array according to the
 	 * Edm type of the sort property
+	 *
+	 * @param {sap.ui.model.Sorter[]} aSorters The sorters
+	 * @param {object} oEntityType The entity type of the collection
+	 *
 	 * @private
 	 */
 	ODataTreeBinding.prototype.addSortComparators = function(aSorters, oEntityType) {
@@ -1761,10 +1818,13 @@ sap.ui.define([
 	};
 
 	/**
-	 * Check whether this Binding would provide new values and in case it changed,
-	 * inform interested parties about this.
+	 * Check whether this Binding would provide new values and in case it changed,fire a change
+	 * event.
 	 *
 	 * @param {boolean} bForceUpdate
+	 *   Whether to fire the event regardless of the bindings state
+	 * @param {object} mChangedEntities
+	 *   A map of changed entities
 	 *
 	 * @private
 	 */
@@ -1782,10 +1842,14 @@ sap.ui.define([
 							bChangeDetected = true;
 							return false;
 						}
+
+						return true;
 					});
 					if (bChangeDetected) {
 						return false;
 					}
+
+					return true;
 				});
 			}
 		}
@@ -1801,7 +1865,9 @@ sap.ui.define([
 	 * Splits the given path along the navigation properties.
 	 * Only used when bound against a service, which describes the tree via navigation properties.
 	 *
-	 * @param {string} sPath
+	 * @param {string} sPath The path
+	 * @returns {string} The split path
+	 *
 	 * @private
 	 */
 	ODataTreeBinding.prototype._getNavPath = function(sPath) {
@@ -1809,7 +1875,7 @@ sap.ui.define([
 		var sAbsolutePath = this.oModel.resolve(sPath, this.getContext());
 
 		if (!sAbsolutePath) {
-			return;
+			return undefined;
 		}
 
 		var aPathParts = sAbsolutePath.split("/"),
@@ -1822,6 +1888,7 @@ sap.ui.define([
 			//Replace context with subitems context
 			sNavPath = this.oNavigationPaths[sCurrent];
 		}
+
 		return sNavPath;
 	};
 
@@ -1873,6 +1940,8 @@ sap.ui.define([
 	 *
 	 * The extracted hierarchy information will be stored in "this.oTreeProperties" (if any)
 	 *
+	 * @returns {boolean} Whether the metadata has tree annotations
+	 *
 	 * @private
 	 */
 	ODataTreeBinding.prototype._hasTreeAnnotations = function() {
@@ -1949,6 +2018,8 @@ sap.ui.define([
 					that.oTreeProperties[sName] = oProperty.name;
 				}
 			});
+
+			return true;
 		});
 
 		return fnSanityCheckTreeAnnotations();
@@ -2032,10 +2103,12 @@ sap.ui.define([
 	/**
 	 * Initially only apply the Adapter interface.
 	 * The real adapter will be applied after the initialize.
+	 *
+	 * @returns {this} A reference to itself
 	 * @private
 	 */
 	ODataTreeBinding.prototype.applyAdapterInterface = function () {
-		/**
+		/*
 		 * Data Interface.
 		 * Documentation, see the corresponding Adapter classes.
 		 */
@@ -2054,7 +2127,7 @@ sap.ui.define([
 		this.getContextByIndex = this.getContextByIndex || function () {
 			return;
 		};
-		/**
+		/*
 		 * Event Interface.
 		 * Documentation, see the corresponding Adapter classes.
 		 */
@@ -2115,6 +2188,8 @@ sap.ui.define([
 						that.oTreeProperties[sName] = oProperty.name;
 					}
 				});
+
+				return true;
 			});
 			//perform magnitude annotation check
 			this.oTreeProperties[sMagnitudeAnnotation] = this.oTreeProperties[sMagnitudeAnnotation]
@@ -2279,9 +2354,7 @@ sap.ui.define([
 
 		sPath = this.getResolvedPath();
 
-		if (sPath) {
-			return this.oModel._createRequestUrl(sPath, null, aParams);
-		}
+		return sPath && this.oModel._createRequestUrl(sPath, null, aParams);
 	};
 
 	/**
@@ -2317,11 +2390,15 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sets the rootLevel
-	 * The root level is the level of the topmost tree nodes, which will be used as an entry point for OData services.
-	 * This is only possible (and necessary) for OData services implementing the hierarchy annotation specification,
-	 * or when providing the annotation information locally as a binding parameter. See the constructor for API documentation on this.
-	 * @param {int} iRootLevel
+	 * Sets the <code>rootLevel</code>.
+	 * The root level is the level of the topmost tree nodes that will be used as an entry point
+	 * for OData services.
+	 * This is only possible (and necessary) for OData services implementing the hierarchy
+	 * annotation specification,
+	 * or when providing the annotation information locally as a binding parameter.
+	 * For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
+	 *
+	 * @param {int} iRootLevel The new <code>rootLevel</code>
 	 *
 	 * @public
 	 */
@@ -2338,7 +2415,8 @@ sap.ui.define([
 
 	/**
 	 * Returns the rootLevel
-	 * @returns {int}
+	 *
+	 * @returns {int} The root level
 	 *
 	 * @public
 	 */
@@ -2348,9 +2426,13 @@ sap.ui.define([
 
 	/**
 	 * Retrieves the EntityType of the bindings path, resolved with the current context.
+	 *
+	 * @returns {object|undefined}
+	 *   The entity type or <code>undefined</code>, if the bindings path can't be resolved
+	 *
 	 * @private
 	 */
-	ODataTreeBinding.prototype._getEntityType = function(){
+	ODataTreeBinding.prototype._getEntityType = function() {
 		var sResolvedPath = this.getResolvedPath();
 
 		if (sResolvedPath) {