@sapui5/ts-types 1.122.2 → 1.123.1

package/types/sap.sac.df.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.1
+// For Library Version: 1.123.1
 
 declare namespace sap {
   namespace sac {
@@ -10,6 +10,11 @@ declare namespace sap {
      */
     namespace df {
       namespace changeHandler {
+        /**
+         * Describes the settings that can be provided to the MultiDimModelChangeHandler constructor.
+         *
+         * @experimental (since 1.120)
+         */
         interface $MultiDimModelChangeHandlerSettings
           extends sap.ui.mdc.$ControlSettings {}
 
@@ -82,12 +87,24 @@ declare namespace sap {
       }
 
       namespace model {
+        /**
+         * Parameters of the MultiDimModel#dataProviderAdded event.
+         */
         interface MultiDimModel$DataProviderAddedEventParameters {}
 
+        /**
+         * Parameters of the MultiDimModel#dataProviderRemoved event.
+         */
         interface MultiDimModel$DataProviderRemovedEventParameters {}
 
+        /**
+         * Parameters of the MultiDimModel#dataProviderUpdated event.
+         */
         interface MultiDimModel$DataProviderUpdatedEventParameters {}
 
+        /**
+         * Parameters of the MultiDimModel#loaded event.
+         */
         interface MultiDimModel$LoadedEventParameters {}
 
         /**
@@ -883,19 +900,28 @@ declare namespace sap {
           toRows(): this;
         }
         /**
-         * Document Object
+         * Documents manager object
+         *
+         * **Structure of Exposed Data:**
+         * ```javascript
+         *
+         * "ActiveDocumentsDirectory": "",
+         * "DocumentsSupportType": ""
+         * "IsBasedOnCDSView": ""
+         * ```
+         *
          *
          * @since 1.119
          * @experimental (since 1.119)
          */
-        class Document extends sap.ui.base.Object {
+        class Documents extends sap.ui.base.Object {
           /**
            * @ui5-protected Do not call from applications (only from related classes in the framework)
            */
           protected constructor();
 
           /**
-           * Creates a new subclass of class sap.sac.df.model.Document with name `sClassName` and enriches it with
+           * Creates a new subclass of class sap.sac.df.model.Documents with name `sClassName` and 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}.
@@ -911,7 +937,7 @@ declare namespace sap {
             /**
              * Object literal with information about the class
              */
-            oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.Document>,
+            oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.Documents>,
             /**
              * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
              * used by this class
@@ -919,14 +945,14 @@ declare namespace sap {
             FNMetaImpl?: Function
           ): Function;
           /**
-           * Returns a metadata object for class sap.sac.df.model.Document.
+           * Returns a metadata object for class sap.sac.df.model.Documents.
            *
            *
            * @returns Metadata object describing this class
            */
           static getMetadata(): sap.ui.base.Metadata;
           /**
-           * Creates a document in the document store
+           * Create a document in the document store
            *
            *
            * @returns a promise which resolves to true if create operation is successful, otherwise false.
@@ -958,7 +984,7 @@ declare namespace sap {
             nColumnIndex: int
           ): Promise<String>;
           /**
-           * Deletes a document in the document store
+           * Delete a document in the document store
            *
            *
            * @returns a promise which resolves to true if delete operation is successful, otherwise false.
@@ -970,7 +996,7 @@ declare namespace sap {
             sDocumentId: undefined
           ): Promise<boolean>;
           /**
-           * Deletes a document ID for a data cell in the result set
+           * Delete a document ID for a data cell in the result set
            *
            *
            * @returns a promise which resolves to true if the delete operation is successful, otherwise false.
@@ -986,7 +1012,7 @@ declare namespace sap {
             nColumnIndex: int
           ): Promise<boolean>;
           /**
-           * Gets a document ID of a data cell in the result set
+           * Get a document ID of a data cell in the result set
            *
            *
            * @returns a promise which resolves with the document ID
@@ -1002,12 +1028,12 @@ declare namespace sap {
             nColumnIndex: int
           ): Promise<String>;
           /**
-           * Gets the type of DocumentsSupport.
+           * Get the type of documents support.
            *
            *
-           * @returns DocumentsSupport type
+           * @returns documents support type
            */
-          getDocumentsSupportType(): string;
+          getDocumentsSupportType(): sap.sac.df.types.DocumentsSupportType;
           /**
            * Retrieves a document from the document store
            *
@@ -1025,7 +1051,7 @@ declare namespace sap {
             sVersion: undefined
           ): Promise<object>;
           /**
-           * Retrieves multiple documents from the document store
+           * Retrieve multiple documents from the document store
            *
            *
            * @returns a promise which resolves with all documents and its versions.
@@ -1037,7 +1063,14 @@ declare namespace sap {
             aDocumentIds: undefined
           ): Promise<object>;
           /**
-           * Updates a document in the document store
+           * Is document storage supporting Read / Write access
+           *
+           *
+           * @returns if Read / Write access is supported
+           */
+          supportsReadWrite(): boolean;
+          /**
+           * Update a document in the document store
            *
            *
            * @returns a promise which resolves to true if update operation is successful, otherwise false.
@@ -1067,7 +1100,7 @@ declare namespace sap {
           /**
            * Documents
            */
-          Documents: sap.sac.df.model.Document;
+          Documents: sap.sac.df.model.Documents;
 
           /**
            * Creates a new subclass of class sap.sac.df.model.Grid with name `sClassName` and enriches it with the
@@ -1922,21 +1955,33 @@ declare namespace sap {
           ): this;
         }
 
+        /**
+         * Event object of the MultiDimModel#dataProviderAdded event.
+         */
         type MultiDimModel$DataProviderAddedEvent = sap.ui.base.Event<
           MultiDimModel$DataProviderAddedEventParameters,
           MultiDimModel
         >;
 
+        /**
+         * Event object of the MultiDimModel#dataProviderRemoved event.
+         */
         type MultiDimModel$DataProviderRemovedEvent = sap.ui.base.Event<
           MultiDimModel$DataProviderRemovedEventParameters,
           MultiDimModel
         >;
 
+        /**
+         * Event object of the MultiDimModel#dataProviderUpdated event.
+         */
         type MultiDimModel$DataProviderUpdatedEvent = sap.ui.base.Event<
           MultiDimModel$DataProviderUpdatedEventParameters,
           MultiDimModel
         >;
 
+        /**
+         * Event object of the MultiDimModel#loaded event.
+         */
         type MultiDimModel$LoadedEvent = sap.ui.base.Event<
           MultiDimModel$LoadedEventParameters,
           MultiDimModel
@@ -1969,6 +2014,27 @@ declare namespace sap {
            */
           View = "View",
         }
+        /**
+         * Documents support type
+         */
+        enum DocumentsSupportType {
+          /**
+           * Documents are not supported.
+           */
+          None = "NONE",
+          /**
+           * Read-only documents support.
+           */
+          Read = "READ",
+          /**
+           * Read, create, change documents support
+           */
+          ReadCreateChange = "READ_CREATE_CHANGE",
+          /**
+           * Read, create, change, delete documents support.
+           */
+          ReadWrite = "READ_WRITE",
+        }
         /**
          * System Type of an InA System
          */
@@ -1991,21 +2057,23 @@ declare namespace sap {
           HANA = "HANA",
         }
       }
-
+      /**
+       * Describes the settings that can be provided to the FilterBar constructor.
+       *
+       * @experimental (since 1.119)
+       */
       interface $FilterBarSettings extends sap.ui.mdc.$FilterBarSettings {
         /**
          * Defines the relative path of the property in the metamodel, based on the current contextPath.
          */
         metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
-
-        /**
-         * Mode
-         *
-         * @deprecated - please use the property `metaPath` instead
-         */
-        mode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      /**
+       * Describes the settings that can be provided to the FilterField constructor.
+       *
+       * @experimental (since 1.48.0)
+       */
       interface $FilterFieldSettings
         extends sap.ui.mdc.field.$FieldBaseSettings {
         /**
@@ -2022,6 +2090,11 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the FlexAnalysis constructor.
+       *
+       * @experimental
+       */
       interface $FlexAnalysisSettings extends sap.ui.core.$ControlSettings {
         /**
          * Sets title to be shown in the control. If not set the name of the corresponding back-end query is used
@@ -2232,6 +2305,11 @@ declare namespace sap {
         onCellClick?: (oEvent: FlexAnalysis$OnCellClickEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the FlexAnalysisPanel constructor.
+       *
+       * @experimental
+       */
       interface $FlexAnalysisPanelSettings
         extends sap.ui.core.$ElementSettings {
         /**
@@ -2258,6 +2336,9 @@ declare namespace sap {
         content?: sap.ui.core.Control;
       }
 
+      /**
+       * Parameters of the FlexAnalysis#onCellClick event.
+       */
       interface FlexAnalysis$OnCellClickEventParameters {
         /**
          * Cell context
@@ -2273,10 +2354,6 @@ declare namespace sap {
       class FilterBar extends sap.ui.mdc.FilterBar {
         /**
          * Constructor for a new Filter Bar.
-         *
-         * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
-         * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
-         * of the syntax of the settings object.
          */
         constructor();
 
@@ -2320,18 +2397,6 @@ declare namespace sap {
          * @returns Value of property `metaPath`
          */
         getMetaPath(): string;
-        /**
-         * Gets current value of property {@link #getMode mode}.
-         *
-         * Mode
-         *
-         * Default value is `"VariablesOfDataProvider"`.
-         *
-         * @deprecated - please use the property `metaPath` instead
-         *
-         * @returns Value of property `mode`
-         */
-        getMode(): string;
         /**
          * Sets a new value for property {@link #getMetaPath metaPath}.
          *
@@ -2348,25 +2413,6 @@ declare namespace sap {
            */
           sMetaPath: string
         ): this;
-        /**
-         * Sets a new value for property {@link #getMode mode}.
-         *
-         * Mode
-         *
-         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-         *
-         * Default value is `"VariablesOfDataProvider"`.
-         *
-         * @deprecated - please use the property `metaPath` instead
-         *
-         * @returns Reference to `this` in order to allow method chaining
-         */
-        setMode(
-          /**
-           * New value for property `mode`
-           */
-          sMode?: string
-        ): this;
       }
       /**
        * The `FilterField` control is used to filter data based on the conditions. The conditions are managed
@@ -3642,6 +3688,9 @@ declare namespace sap {
         ): this;
       }
 
+      /**
+       * Event object of the FlexAnalysis#onCellClick event.
+       */
       type FlexAnalysis$OnCellClickEvent = sap.ui.base.Event<
         FlexAnalysis$OnCellClickEventParameters,
         FlexAnalysis
@@ -3670,7 +3719,7 @@ declare namespace sap {
 
     "sap/sac/df/model/Dimension": undefined;
 
-    "sap/sac/df/model/Document": undefined;
+    "sap/sac/df/model/Documents": undefined;
 
     "sap/sac/df/model/Grid": undefined;
 
@@ -3682,6 +3731,8 @@ declare namespace sap {
 
     "sap/sac/df/types/DataSourceType": undefined;
 
+    "sap/sac/df/types/DocumentsSupportType": undefined;
+
     "sap/sac/df/types/SystemType": undefined;
   }
 }