@sapui5/ts-types 1.101.1 → 1.103.0

package/types/sap.ui.generic.app.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.103.0
 
 declare namespace sap {
   namespace ui {
@@ -41,6 +41,8 @@ declare namespace sap {
                * and enriches it with the information contained in `oClassInfo`.
                *
                * `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.NavError.extend}.
+               *
+               * @returns Created class / constructor function
                */
               static extend<T extends Record<string, unknown>>(
                 /**
@@ -62,12 +64,16 @@ declare namespace sap {
               ): Function;
               /**
                * Returns a metadata object for class sap.ui.generic.app.navigation.service.NavError.
+               *
+               * @returns Metadata object describing this class
                */
               static getMetadata(): sap.ui.base.Metadata;
               /**
                * @deprecated (since 1.83.0)
                *
                * Returns the error code with which the instance has been created.
+               *
+               * @returns The error code of the error
                */
               getErrorCode(): string;
             }
@@ -90,8 +96,8 @@ declare namespace sap {
              *  **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation}
              * is available and initialized.
              */
-            class NavigationHandler extends sap.fe.navigation
-              .NavigationHandler {
+            class NavigationHandler
+              /* was: sap.fe.navigation.NavigationHandler */ extends Object {
               constructor(
                 /**
                  * UI5 controller that contains a router and a component; typically the main controller of your application,
@@ -113,6 +119,8 @@ declare namespace sap {
                * The method creates a context url based on provided data. This context url can either be used as {@link
                * sap.ui.generic.app.navigation.service.NavigationHandler#setParameterContextUrl ParameterContextUrl} or
                * {@link sap.ui.generic.app.navigation.service.NavigationHandler#setFilterContextUrl FilterContextUrl}
+               *
+               * @returns context url for the given entities
                */
               static constructContextUrl(
                 /**
@@ -129,6 +137,8 @@ declare namespace sap {
                * and enriches it with the information contained in `oClassInfo`.
                *
                * `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.NavigationHandler.extend}.
+               *
+               * @returns Created class / constructor function
                */
               static extend<T extends Record<string, unknown>>(
                 /**
@@ -150,6 +160,8 @@ declare namespace sap {
               ): Function;
               /**
                * Returns a metadata object for class sap.ui.generic.app.navigation.service.NavigationHandler.
+               *
+               * @returns Metadata object describing this class
                */
               static getMetadata(): sap.ui.base.Metadata;
               /**
@@ -161,6 +173,8 @@ declare namespace sap {
                * 	 - `sap-system`
                * 	 - `sap-ushell-defaultedParameterNames`
                * 	 - `"hcpApplicationId"`
+               *
+               * @returns Containing the technical parameters.
                */
               static getTechnicalParameters(): any[];
               /**
@@ -171,6 +185,8 @@ declare namespace sap {
                * variant does not contain any parameters. All parameters are merged into select options. The output of
                * this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate}
                * method.
+               *
+               * @returns Instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
                */
               static mixAttributesAndSelectionVariant(
                 /**
@@ -752,6 +768,34 @@ declare namespace sap {
                * state is returned in the resolved Promise. Otherwise startup parameters will be merged into the app state
                * provided by cross app navigation, and a combined app state will be returned. The conflict resolution
                * can be influenced with sParamHandlingMode defined in the constructor.
+               *
+               * @returns A Promise object to monitor when all the actions of the function have been executed. If the
+               * execution is successful, the extracted app state, the startup parameters, and the type of navigation
+               * are returned, see also the example above. The app state is an object that contains the following information:
+               *
+               * 	 - `oAppData.oSelectionVariant`: An instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
+               * 			containing only parameters/select options that are related to navigation
+               * 	 - `oAppData.selectionVariant`: The navigation-related selection variant as a JSON-formatted string
+               *
+               * 	 - `oAppData.oDefaultedSelectionVariant`: An instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
+               * 			containing only the parameters/select options that are set by user default data
+               * 	 - `oAppData.bNavSelVarHasDefaultsOnly`: A Boolean flag that indicates whether only defaulted parameters
+               * 			and no navigation parameters are present.
+               *  **Note:** If no navigation parameters are available, `bNavSelVarHasDefaultsOnly` is set to `true`, even
+               * though parameters without default might be available as well.  If the navigation-related selection
+               * variant is empty, it is replaced by a copy of the defaulted selection variant.
+               *  The navigation type is an enumeration type of type {@link sap.ui.generic.app.navigation.service.NavType}
+               * (possible values are initial, URLParams, xAppState, and iAppState).
+               *  **Note:** If the navigation type is {@link sap.ui.generic.app.navigation.service.NavType.iAppState}
+               * oAppData has two additional properties
+               * 	 - `oAppData.tableVariantId`
+               * 	 - `oAppData.customData`  which return the inner app data as stored in {@link #.navigate navigate}
+               * 			or {@link #.storeInnerAppState storeInnerAppState}. `oAppData.oDefaultedSelectionVariant` is an empty
+               * 			selection variant and `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
+               *  **Note:** If the navigation type is {@link sap.ui.generic.app.navigation.service.NavType.initial} oAppData
+               * is an empty object!
+               *  If an error occurs, an error object of type {@link sap.ui.generic.app.navigation.service.NavError},
+               * URL parameters (if available) and the type of navigation are returned.
                */
               static parseNavigation(): object;
               /**
@@ -773,6 +817,10 @@ declare namespace sap {
                * 			popover as semantic attributes.
                * 	 - The method `oTableEventParameters.open()` is called. Note that this does not really open the popover,
                * 			but the SmartLink control proceeds with firing the event `navigationTargetsObtained`.
+               *
+               * @returns A Promise object to monitor when all actions of the function have been executed; if the execution
+               * is successful, the modified oTableEventParameters is returned; if an error occurs, an error object of
+               * type {@link sap.ui.generic.app.navigation.service.NavError} is returned
                */
               static processBeforeSmartLinkPopoverOpens(
                 /**
@@ -879,6 +927,10 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Changes the URL according to the current app state and stores the app state for later retrieval.
+               *
+               * @returns A Promise object to monitor when all the actions of the function have been executed; if the
+               * execution is successful, the app state key is returned; if an error occurs, an object of type {@link
+               * sap.ui.generic.app.navigation.service.NavError} is returned
                */
               static storeInnerAppState(
                 /**
@@ -921,6 +973,9 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Changes the URL according to the current app state and stores the app state for later retrieval.
+               *
+               * @returns An object containing the appStateId and a promise object to monitor when all the actions of
+               * the function have been executed; Please note that the appStateKey may be undefined or empty.
                */
               static storeInnerAppStateWithImmediateReturn(
                 /**
@@ -968,8 +1023,8 @@ declare namespace sap {
              * is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
              * Variant Specification will parse it, and the newly created instance will contain the same information.
              */
-            class PresentationVariant extends sap.fe.navigation
-              .PresentationVariant {
+            class PresentationVariant
+              /* was: sap.fe.navigation.PresentationVariant */ extends Object {
               constructor(
                 /**
                  * If of type `string`, the selection variant is JSON-formatted; if of type `object`, the object represents
@@ -983,6 +1038,8 @@ declare namespace sap {
                * and enriches it with the information contained in `oClassInfo`.
                *
                * `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.PresentationVariant.extend}.
+               *
+               * @returns Created class / constructor function
                */
               static extend<T extends Record<string, unknown>>(
                 /**
@@ -1006,46 +1063,62 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Gets the chart visualization property.
+               *
+               * @returns mProperties to be used for the chart visualization.
                */
               static getChartVisualization(): Record<string, any>;
               /**
                * @deprecated (since 1.83.0)
                *
                * Gets the current context URL intended for the query.
+               *
+               * @returns The current context URL for the query
                */
               static getContextUrl(): string;
               /**
                * @deprecated (since 1.83.0)
                *
                * Returns the identification of the selection variant.
+               *
+               * @returns The identification of the selection variant as made available during construction
                */
               static getID(): string;
               /**
                * Returns a metadata object for class sap.ui.generic.app.navigation.service.PresentationVariant.
+               *
+               * @returns Metadata object describing this class
                */
               static getMetadata(): sap.ui.base.Metadata;
               /**
                * @deprecated (since 1.83.0)
                *
                * Gets the more trivial properties. Basically all properties with the exception of the Visualization.
+               *
+               * @returns The current properties.
                */
               static getProperties(): Record<string, any>;
               /**
                * @deprecated (since 1.83.0)
                *
                * Gets the table visualization property.
+               *
+               * @returns mProperties to be used for the table visualization.
                */
               static getTableVisualization(): Record<string, any>;
               /**
                * @deprecated (since 1.83.0)
                *
                * Returns the current text / description of this selection variant.
+               *
+               * @returns the current description of this selection variant.
                */
               static getText(): string;
               /**
                * @deprecated (since 1.83.0)
                *
                * Returns `true` if the presentation variant does not contain any properties. nor ranges.
+               *
+               * @returns If set to `true` there are no current properties set; `false` otherwise.
                */
               static isEmpty(): boolean;
               /**
@@ -1118,12 +1191,16 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Returns the external representation of the selection variant as JSON object.
+               *
+               * @returns The external representation of this instance as a JSON object
                */
               static toJSONObject(): object;
               /**
                * @deprecated (since 1.83.0)
                *
                * Serializes this instance into a JSON-formatted string.
+               *
+               * @returns The JSON-formatted representation of this instance in stringified format
                */
               static toJSONString(): string;
             }
@@ -1134,7 +1211,8 @@ declare namespace sap {
              * is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
              * Variant Specification will parse it, and the newly created instance will contain the same information.
              */
-            class SelectionVariant extends sap.fe.navigation.SelectionVariant {
+            class SelectionVariant
+              /* was: sap.fe.navigation.SelectionVariant */ extends Object {
               constructor(
                 /**
                  * If of type `string`, the selection variant is JSON-formatted; if of type `object`, the object represents
@@ -1148,6 +1226,8 @@ declare namespace sap {
                *
                * Sets the value of a parameter called `sName` to the new value `sValue`. If the parameter has already
                * been set before, its value is overwritten.
+               *
+               * @returns This instance to allow method chaining
                */
               static addParameter(
                 /**
@@ -1163,6 +1243,8 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Adds a new range to the list of select options for a given parameter.
+               *
+               * @returns This instance to allow method chaining.
                */
               static addSelectOption(
                 /**
@@ -1195,6 +1277,8 @@ declare namespace sap {
                * and enriches it with the information contained in `oClassInfo`.
                *
                * `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.SelectionVariant.extend}.
+               *
+               * @returns Created class / constructor function
                */
               static extend<T extends Record<string, unknown>>(
                 /**
@@ -1218,16 +1302,22 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Gets the current context URL intended for the filters.
+               *
+               * @returns The current context URL for the filters
                */
               static getFilterContextUrl(): string;
               /**
                * @deprecated (since 1.83.0)
                *
                * Returns the identification of the selection variant.
+               *
+               * @returns The identification of the selection variant as made available during construction
                */
               static getID(): string;
               /**
                * Returns a metadata object for class sap.ui.generic.app.navigation.service.SelectionVariant.
+               *
+               * @returns Metadata object describing this class
                */
               static getMetadata(): sap.ui.base.Metadata;
               /**
@@ -1235,6 +1325,8 @@ declare namespace sap {
                *
                * Returns the value of the parameter called `sName` if it has been set. If the parameter has never been
                * set or has been removed, `undefined` is returned.
+               *
+               * @returns The value of parameter `sName`; returning the value `null` not possible
                */
               static getParameter(
                 /**
@@ -1246,24 +1338,39 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Gets the current context URL intended for the parameters.
+               *
+               * @returns The current context URL for the parameters
                */
               static getParameterContextUrl(): string;
               /**
                * @deprecated (since 1.83.0)
                *
                * Returns the set of parameter names available in this selection variant
+               *
+               * @returns the list of parameter names which are valid
                */
               static getParameterNames(): any[];
               /**
                * @deprecated (since 1.83.0)
                *
                * Returns the names of the parameter and select option properties available for this instance.
+               *
+               * @returns The list of parameter and select option property names available for this instance
                */
               static getPropertyNames(): any[];
               /**
                * @deprecated (since 1.83.0)
                *
                * Returns the set of select options/ranges available for a given property name.
+               *
+               * @returns If `sPropertyName` is an invalid name of a property or no range exists, `undefined` is returned;
+               * otherwise, an immutable array of ranges is returned. Each entry of the array is an object with the following
+               * properties:
+               * 	 - `Sign`: The sign of the range
+               * 	 - `Option`: The option of the range
+               * 	 - `Low`: The low value of the range; returning value `null` is not possible
+               * 	 - `High`: The high value of the range; if this value is not necessary, `null` is used  For further
+               * 			information about the meaning of the attributes, refer to method `addSelectOption`.
                */
               static getSelectOption(
                 /**
@@ -1275,12 +1382,16 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Returns the names of the properties available for this instance.
+               *
+               * @returns The list of property names available for this instance
                */
               static getSelectOptionsPropertyNames(): any[];
               /**
                * @deprecated (since 1.83.0)
                *
                * Returns the current text / description of this selection variant.
+               *
+               * @returns the current description of this selection variant.
                */
               static getText(): string;
               /**
@@ -1291,6 +1402,15 @@ declare namespace sap {
                * `sName`, is made. If the latter succeeds, the single value is converted to fit into an array of selections
                * to make it type compatible with ranges. This array is then returned.  If neither a select option
                * nor a parameter could be found, `undefined` is returned.
+               *
+               * @returns The ranges in the select options for the specified property or a range-converted representation
+               * of a parameter is returned. If both lookups fail, `undefined` is returned.  The returned ranges
+               * have the format:
+               * 	 - `Sign`: The sign of the range
+               * 	 - `Option`: The option of the range
+               * 	 - `Low`: The low value of the range; returning the value `null` is not possible
+               * 	 - `High`: The high value of the range; if this value is not necessary, `null` (but does exist)
+               * 			For further information on the meaning of the attributes, refer to method {@link #.addSelectOption addSelectOption}.
                */
               static getValue(
                 /**
@@ -1302,12 +1422,17 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Returns `true` if the selection variant does neither contain parameters nor ranges.
+               *
+               * @returns If set to `true` there are no parameters and no select options available in the selection variant;
+               * `false` otherwise.
                */
               static isEmpty(): boolean;
               /**
                * @deprecated (since 1.83.0)
                *
                * Adds a set of select options to the list of select options for a given parameter.
+               *
+               * @returns This instance to allow method chaining
                */
               static massAddSelectOption(
                 /**
@@ -1323,6 +1448,8 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Removes a parameter called `sName` from the selection variant.
+               *
+               * @returns This instance to allow method chaining
                */
               static removeParameter(
                 /**
@@ -1334,6 +1461,8 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Removes a select option called `sName` from the selection variant.
+               *
+               * @returns This instance to allow method chaining.
                */
               static removeSelectOption(
                 /**
@@ -1347,6 +1476,8 @@ declare namespace sap {
                * Renames a parameter called `sNameOld` to `sNameNew`. If a parameter or a select option with the name
                * `sNameNew` already exist, an error is thrown. If a parameter with the name `sNameOld` does not exist,
                * nothing is changed.
+               *
+               * @returns This instance to allow method chaining
                */
               static renameParameter(
                 /**
@@ -1364,6 +1495,8 @@ declare namespace sap {
                * Renames a select option called `sNameOld` to `sNameNew`. If a select option or a parameter with the name
                * `sNameNew` already exist, an error is thrown. If a select option with the name `sNameOld` does not exist,
                * nothing is changed.
+               *
+               * @returns This instance to allow method chaining
                */
               static renameSelectOption(
                 /**
@@ -1423,12 +1556,16 @@ declare namespace sap {
                * @deprecated (since 1.83.0)
                *
                * Returns the external representation of the selection variant as JSON object.
+               *
+               * @returns The external representation of this instance as a JSON object
                */
               static toJSONObject(): object;
               /**
                * @deprecated (since 1.83.0)
                *
                * Serializes this instance into a JSON-formatted string
+               *
+               * @returns The JSON-formatted representation of this instance in stringified format
                */
               static toJSONString(): string;
             }
@@ -1437,48 +1574,14 @@ declare namespace sap {
              *
              * A static enumeration type which indicates the type of inbound navigation
              */
-            enum NavType {
-              /**
-               * Back navigation with sap-iapp-state parameter
-               */
-              iAppState = "iAppState",
-              /**
-               * Initial startup without any navigation or default parameters
-               */
-              initial = "initial",
-              /**
-               * Basic cross-app navigation with URL parameters only (without sap-xapp-state) or initial start with default
-               * parameters
-               */
-              URLParams = "URLParams",
-              /**
-               * Cross-app navigation with sap-xapp-state parameter (and URL parameters), defaulted parameters may be
-               * added
-               */
-              xAppState = "xAppState",
-            }
+            enum NavType {}
             /**
              * @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.ParamHandlingMode} instead.
              *
              * A static enumeration type which indicates the conflict resolution method when merging URL parameters
              * into select options
              */
-            enum ParamHandlingMode {
-              /**
-               * The conflict resolution adds URL parameters to the SelectionVariant
-               */
-              InsertInSelOpt = "undefined",
-              /**
-               * The conflict resolution favors the SelectionVariant over URL parameters
-               */
-              SelVarWins = "undefined",
-              /**
-               * The conflict resolution favors the URL parameters over the SelectionVariant. Caution: In case of cross-app
-               * navigation a navigation parameter value from the source app is overwritten by a default, if a default
-               * is maintained in the launchpad designer for this parameter in the target app!
-               */
-              URLParamWins = "undefined",
-            }
+            enum ParamHandlingMode {}
             /**
              * @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SuppressionBehavior} instead.
              *
@@ -1488,28 +1591,7 @@ declare namespace sap {
              * mixAttributesAndSelectionVariant} of the {@link sap.ui.generic.app.navigation.service.NavigationHandler
              * NavigationHandler}
              */
-            enum SuppressionBehavior {
-              /**
-               * Semantic attributes with an empty string are ignored, the remaining attributes are mixed in to the selection
-               * variant. Warning! Consider the impact on Boolean variable values!
-               */
-              ignoreEmptyString = "undefined",
-              /**
-               * Semantic attributes with a `null` value lead to an {@link sap.fin.central.lib.error.Error error} of type
-               * NavigationHandler.INVALID_INPUT
-               */
-              raiseErrorOnNull = "undefined",
-              /**
-               * Semantic attributes with an `undefined` value lead to an {@link sap.fin.central.lib.error.Error error}
-               * of type NavigationHandler.INVALID_INPUT
-               */
-              raiseErrorOnUndefined = "undefined",
-              /**
-               * Standard suppression behavior: semantic attributes with a `null` or an `undefined` value are ignored,
-               * the remaining attributes are mixed in to the selection variant
-               */
-              standard = "undefined",
-            }
+            enum SuppressionBehavior {}
           }
         }
 
@@ -1541,6 +1623,8 @@ declare namespace sap {
              * and enriches it with the information contained in `oClassInfo`.
              *
              * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
+             *
+             * @returns Created class / constructor function
              */
             static extend<T extends Record<string, unknown>>(
               /**
@@ -1562,6 +1646,8 @@ declare namespace sap {
             ): Function;
             /**
              * Returns a metadata object for class sap.ui.generic.app.transaction.BaseController.
+             *
+             * @returns Metadata object describing this class
              */
             static getMetadata(): sap.ui.base.Metadata;
             /**
@@ -1596,10 +1682,14 @@ declare namespace sap {
             ): void;
             /**
              * Checks for client messages.
+             *
+             * @returns If client-side messages exist a rejected promise is returned, `null` otherwise
              */
             hasClientMessages(): Promise<any>;
             /**
              * Triggers submitting the currently tracked changes to the back-end.
+             *
+             * @returns A `Promise` for asynchronous execution of the submit
              */
             triggerSubmitChanges(
               /**
@@ -1651,6 +1741,8 @@ declare namespace sap {
              * enriches it with the information contained in `oClassInfo`.
              *
              * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+             *
+             * @returns Created class / constructor function
              */
             static extend<T extends Record<string, unknown>>(
               /**
@@ -1672,6 +1764,8 @@ declare namespace sap {
             ): Function;
             /**
              * Returns a metadata object for class sap.ui.generic.app.transaction.DraftContext.
+             *
+             * @returns Metadata object describing this class
              */
             static getMetadata(): sap.ui.base.Metadata;
             /**
@@ -1679,6 +1773,8 @@ declare namespace sap {
              *
              * Checks whether an OData property is annotated with UpdateOnChange. The method is used in context of a
              * validation success event.
+             *
+             * @returns `true`, if the property is annotated with UpdateOnChange, `false` otherwise
              */
             checkUpdateOnChange(
               /**
@@ -1696,6 +1792,8 @@ declare namespace sap {
             destroy(): void;
             /**
              * Returns the name of the function import to be used.
+             *
+             * @returns The name of the function import to be used
              */
             getODataDraftFunctionImportName(
               /**
@@ -1709,6 +1807,8 @@ declare namespace sap {
             ): string;
             /**
              * Returns the semantic keys for a given entity set.
+             *
+             * @returns The semantic keys
              */
             getSemanticKey(
               /**
@@ -1719,6 +1819,8 @@ declare namespace sap {
             /**
              * Checks whether an entity set is draft-enabled. The entity set name is derived from the given binding
              * context
+             *
+             * @returns `true`, if a given entity set is draft-enabled, `false` otherwise
              */
             hasDraft(
               /**
@@ -1728,6 +1830,8 @@ declare namespace sap {
             ): boolean;
             /**
              * Checks whether administrative data for a given draft is available.
+             *
+             * @returns `true`, if administrative data is available, `false` otherwise
              */
             hasDraftAdministrativeData(
               /**
@@ -1738,6 +1842,8 @@ declare namespace sap {
             /**
              * Checks whether an entity set has a draft preparation action. The entity set name is derived from the
              * given binding context.
+             *
+             * @returns `true`, if a given entity set has a draft preparation action, `false` otherwise
              */
             hasDraftPreparationAction(
               /**
@@ -1747,6 +1853,8 @@ declare namespace sap {
             ): boolean;
             /**
              * Checks whether an entity set is draft root. The entity set name is derived from the given binding context.
+             *
+             * @returns `true`, if a given entity set is draft root, `false` otherwise
              */
             hasDraftRoot(
               /**
@@ -1757,6 +1865,8 @@ declare namespace sap {
             /**
              * Checks whether an entity set has a draft validation function. The entity set name is derived from the
              * given binding context.
+             *
+             * @returns `true`, if a given entity set has a draft validation function, `false` otherwise
              */
             hasDraftValidationFunction(
               /**
@@ -1770,10 +1880,14 @@ declare namespace sap {
              * Checks if the parameter "PreserveChanges" is supported by the edit function. If the edit action is triggered
              * with the parameter set to `true` the ABAP application infrastructure will respond with HTTP response
              * code 409 if unsaved changes (from another user) exist.
+             *
+             * @returns `true`, if "PreserveChanges" is supported
              */
             hasPreserveChanges(): boolean;
             /**
              * Checks whether a sibling entity for a given entity set is available.
+             *
+             * @returns `true`, if sibling entity is available, `false` otherwise
              */
             hasSiblingEntity(
               /**
@@ -1783,6 +1897,8 @@ declare namespace sap {
             ): boolean;
             /**
              * Checks whether a given entity set is draft-enabled.
+             *
+             * @returns `true`, if a given entity set is draft-enabled, `false` otherwise
              */
             isDraftEnabled(
               /**
@@ -1792,6 +1908,8 @@ declare namespace sap {
             ): boolean;
             /**
              * Checks whether a given entity set is a draft root.
+             *
+             * @returns `true`, if a given entity set is draft root, `false` otherwise
              */
             isDraftRoot(
               /**
@@ -1801,6 +1919,8 @@ declare namespace sap {
             ): boolean;
             /**
              * Checks whether a given key is a semantic key.
+             *
+             * @returns `true`, if a given key is a semantic key, `false` otherwise
              */
             isSemanticKey(
               /**
@@ -1814,6 +1934,8 @@ declare namespace sap {
             ): boolean;
             /**
              * Checks whether a given key is a technical key.
+             *
+             * @returns `true`, if a given key is a technical key, `false` otherwise
              */
             isTechnicalKey(
               /**
@@ -1862,6 +1984,8 @@ declare namespace sap {
              * and enriches it with the information contained in `oClassInfo`.
              *
              * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
+             *
+             * @returns Created class / constructor function
              */
             static extend<T extends Record<string, unknown>>(
               /**
@@ -1883,10 +2007,14 @@ declare namespace sap {
             ): Function;
             /**
              * Returns a metadata object for class sap.ui.generic.app.transaction.DraftController.
+             *
+             * @returns Metadata object describing this class
              */
             static getMetadata(): sap.ui.base.Metadata;
             /**
              * Submits changes to the back-end and activates a draft entity in the back-end.
+             *
+             * @returns A `Promise` for asynchronous execution
              */
             activateDraftEntity(
               /**
@@ -1905,6 +2033,8 @@ declare namespace sap {
             ): Promise<any>;
             /**
              * Submits changes to the back-end and activates a draft entity in the back-end.
+             *
+             * @returns A `Promise` for asynchronous execution
              */
             activateDraftEntity(
               /**
@@ -1920,6 +2050,8 @@ declare namespace sap {
             /**
              * Creates an edit draft in the back-end. Additionally, possible changes that have been collected on the
              * client are sent to the back-end.
+             *
+             * @returns A `Promise` for asynchronous execution
              */
             createEditDraftEntity(
               /**
@@ -1938,6 +2070,8 @@ declare namespace sap {
             /**
              * Creates a new edit draft on the client and sends it to the back-end. Additionally, possible changes that
              * have been collected on the client are sent to the back-end.
+             *
+             * @returns A `Promise` for asynchronous execution of the request
              */
             createNewDraftEntity(
               /**
@@ -1988,6 +2122,8 @@ declare namespace sap {
             destroy(): void;
             /**
              * Returns the current draft context instance. If no instance exists, it is created lazily.
+             *
+             * @returns The current draft context instance
              */
             getDraftContext(): sap.ui.generic.app.transaction.DraftContext;
             /**
@@ -1995,6 +2131,8 @@ declare namespace sap {
              *
              * Retrieves a possibly existing draft entity for the given active entity using the binding context of the
              * active entity from the back-end.
+             *
+             * @returns A `Promise` for asynchronous execution
              */
             getDraftForActiveEntity(
               /**
@@ -2006,6 +2144,8 @@ declare namespace sap {
              * @SINCE 1.32.0
              *
              * Checks whether an entity has an active entity associated.
+             *
+             * @returns `true`, if an active entity exists, `false` otherwise
              */
             hasActiveEntity(
               /**
@@ -2015,6 +2155,8 @@ declare namespace sap {
             ): boolean;
             /**
              * Checks whether an entity set is active. The entity set name is derived from the given binding context
+             *
+             * @returns `true`, if a given entity set is active, `false` otherwise
              */
             isActiveEntity(
               /**
@@ -2025,6 +2167,8 @@ declare namespace sap {
             /**
              * Submits changes to the back-end and prepares an existing draft entity in the back-end for later activation
              * by invoking the preparation action.
+             *
+             * @returns A `Promise` for asynchronous execution
              */
             prepareDraftEntity(
               /**
@@ -2035,6 +2179,8 @@ declare namespace sap {
             /**
              * Submits changes to the back-end and prepares a draft entity in the back-end for later activation by invoking
              * the preparation action.
+             *
+             * @returns A `Promise` for asynchronous execution
              */
             saveAndPrepareDraftEntity(
               /**
@@ -2049,6 +2195,8 @@ declare namespace sap {
             /**
              * Submits changes to the back-end and prepares an existing draft entity in the back-end for later activation
              * by invoking the validation action.
+             *
+             * @returns A `Promise` for asynchronous execution
              */
             validateDraftEntity(
               /**
@@ -2099,6 +2247,8 @@ declare namespace sap {
              * and enriches it with the information contained in `oClassInfo`.
              *
              * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
+             *
+             * @returns Created class / constructor function
              */
             static extend<T extends Record<string, unknown>>(
               /**
@@ -2120,6 +2270,8 @@ declare namespace sap {
             ): Function;
             /**
              * Returns a metadata object for class sap.ui.generic.app.transaction.TransactionController.
+             *
+             * @returns Metadata object describing this class
              */
             static getMetadata(): sap.ui.base.Metadata;
             /**
@@ -2128,6 +2280,9 @@ declare namespace sap {
              *
              * Submits changes to the backend system and deletes a group of entities in the backend system. These entities
              * can be both draft or active entities.
+             *
+             * @returns A `Promise` that receives an array with the responses of the delete requests. The `Promise`
+             * resolves when at least one request was successful and rejects when all delete requests have been rejected/aborted.
              */
             deleteEntities(
               /**
@@ -2142,6 +2297,8 @@ declare namespace sap {
             /**
              * Submits changes to the backend system and deletes an entity in the backend system. This entity can be
              * either a draft or an active entity.
+             *
+             * @returns A `Promise` for asynchronous execution
              */
             deleteEntity(
               /**
@@ -2160,6 +2317,8 @@ declare namespace sap {
             /**
              * Prepares an entity for editing. If the entity is active and draft enabled, a new draft document is created.
              * If not, the control is automatically returned to the caller of the method by returning a resolved promise.
+             *
+             * @returns A `Promise` for asynchronous execution
              */
             editEntity(
               /**
@@ -2177,6 +2336,8 @@ declare namespace sap {
             ): Promise<any>;
             /**
              * Returns the current draft controller instance.
+             *
+             * @returns The draft controller instance
              */
             getDraftController(): sap.ui.generic.app.transaction.DraftController;
             /**
@@ -2186,6 +2347,9 @@ declare namespace sap {
             resetChanges(): void;
             /**
              * Multi edit handling.
+             *
+             * @returns A `Promise` which resolves if the given promises have been executed with at least one successfully.
+             * It rejects if all given promises were rejected.
              */
             updateMultipleEntities(
               /**
@@ -2223,6 +2387,8 @@ declare namespace sap {
            * it with the information contained in `oClassInfo`.
            *
            * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
+           *
+           * @returns Created class / constructor function
            */
           static extend<T extends Record<string, unknown>>(
             /**
@@ -2244,6 +2410,8 @@ declare namespace sap {
           ): Function;
           /**
            * Returns a metadata object for class sap.ui.generic.app.ApplicationController.
+           *
+           * @returns Metadata object describing this class
            */
           static getMetadata(): sap.ui.base.Metadata;
           /**
@@ -2257,6 +2425,9 @@ declare namespace sap {
            * or entities are passed the unspecified side effect is executed. This unspecified side effect uses either
            * the annotated targets of the unspecified side effect or - in case of no available annotation - triggers
            * a complete model refresh on the OData model.
+           *
+           * @returns A `Promise` for asynchronous execution of the action. The promise is either already resolved
+           * (when nothing needs to be processed) or resolves when the `triggerSubmitChanges()` has been executed.
            */
           executeSideEffects(
             /**
@@ -2282,6 +2453,10 @@ declare namespace sap {
            * @EXPERIMENTAL
            *
            * Creates a context for an action call (OData function import)
+           *
+           * @returns A `map` that contains two Promises: `context` which provides the action-specific model context
+           * to the resolve function `result` which resolves when the success handler is called and rejects when the
+           * error handler is called; The result of the promises is noramlized in both cases, error and success.
            */
           getNewActionContext(
             /**
@@ -2299,11 +2474,15 @@ declare namespace sap {
           ): Record<string, any>;
           /**
            * Returns the current transaction controller instance.
+           *
+           * @returns The transaction controller instance
            */
           getTransactionController(): sap.ui.generic.app.transaction.TransactionController;
           /**
            * Invokes an action for every provided context where the properties are taken as input from. The changes
            * are submitted directly to the back-end.
+           *
+           * @returns A `Promise` for asynchronous execution of the action
            */
           invokeActions(
             /**
@@ -2331,6 +2510,8 @@ declare namespace sap {
            *
            * Notifies the application controller of a change of a property. Please note that the method is not meant
            * for productive use currently. It is experimental.
+           *
+           * @returns A `Promise` for asynchronous execution of the action
            */
           propertyChanged(
             /**