@openui5/sap.ui.core/src/sap/ui/model/odata/CountMode.js

OpenUI5 Core Library sap.ui.core

/*!
 * OpenUI5
 * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
 * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
 */
/*eslint-disable max-len */
// Provides enumeration sap.ui.model.CountMode
sap.ui.define(function() {
	"use strict";


	/**
	 * Different modes for retrieving the count of collections.
	 *
	 * @enum {string}
	 * @public
	 * @alias sap.ui.model.odata.CountMode
	 * @see sap.ui.model.ODataModel#bindList
	 * @see sap.ui.model.ODataModel#constructor
	 * @see sap.ui.model.v2.ODataModel#bindList
	 * @see sap.ui.model.v2.ODataModel#constructor
	 */
	var CountMode = {
		/**
		 * Count is retrieved by sending a separate <code>$count</code> request before requesting data.
		 *
		 * It depends on the concrete model implementation whether and how the <code>$count</code> request
		 * and the data request are synchronized.
		 * @public
		 */
		Request: "Request",

		/**
		 * Count is retrieved by adding <code>$inlinecount=allpages</code> to data requests
		 * as long as no count has been determined yet.
		 * @public
		 */
		Inline: "Inline",

		/**
		 * Count is retrieved by adding <code>$inlinecount=allpages</code> to every data request.
		 * @public
		 */
		InlineRepeat: "InlineRepeat",

		/**
		 * Count is retrieved by a separate request upfront and inline with each data request.
		 *
		 * The only purpose of this mode is to reflect the behavior of the {@link sap.ui.model.odata.ODataModel ODataModel (v1)}
		 * before the introduction of the <code>CountMode</code>. For compatibility reasons, it is the
		 * default for the <code>ODataModel</code> (v1) and shouldn't be used otherwise.
		 *
		 * @deprecated As of 1.43, this shouldn't be used any longer, decide for one of the other modes.
		 * @public
		 */
		Both: "Both",

		/**
		 * Count is not requested from the server.
		 * @public
		 */
		None: "None"
	};

	return CountMode;

}, /* bExport= */ true);