@openui5/ts-types 1.121.0 → 1.122.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -280,7 +280,7 @@ declare namespace sap {
280
280
  }
281
281
  }
282
282
 
283
- // For Library Version: 1.121.0
283
+ // For Library Version: 1.122.0
284
284
 
285
285
  declare module "sap/base/assert" {
286
286
  /**
@@ -6794,7 +6794,7 @@ declare namespace sap {
6794
6794
  */
6795
6795
  url?: string;
6796
6796
  /**
6797
- * Initial data of the Component (@see sap.ui.core.Component#getComponentData)
6797
+ * Initial data of the Component, see {@link sap.ui.core.Component#getComponentData}
6798
6798
  */
6799
6799
  componentData?: object;
6800
6800
  /**
@@ -14778,15 +14778,15 @@ declare namespace sap {
14778
14778
  */
14779
14779
  vertical?: boolean;
14780
14780
  /**
14781
- * @deprecated since 1.42, the parameter has no effect
14781
+ * Deprecated since 1.42, the parameter has no effect
14782
14782
  */
14783
14783
  zynga?: boolean;
14784
14784
  /**
14785
- * @deprecated since 1.42, the parameter has no effect
14785
+ * Deprecated since 1.42, the parameter has no effect
14786
14786
  */
14787
14787
  iscroll?: boolean;
14788
14788
  /**
14789
- * @deprecated since 1.42, the parameter has no effect
14789
+ * Deprecated since 1.42, the parameter has no effect
14790
14790
  */
14791
14791
  preventDefault?: boolean;
14792
14792
  /**
@@ -16794,46 +16794,56 @@ declare namespace sap {
16794
16794
  namespace NumberFormat {
16795
16795
  /**
16796
16796
  * Specifies a rounding behavior for numerical operations capable of discarding precision. Each rounding
16797
- * mode in this object indicates how the least significant returned digits of rounded result is to be calculated.
16797
+ * mode in this object indicates how the least significant returned digits of rounded result are to be calculated.
16798
16798
  *
16799
16799
  * This enum is part of the 'sap/ui/core/format/NumberFormat' module export and must be accessed by the
16800
16800
  * property 'RoundingMode'.
16801
16801
  */
16802
16802
  enum RoundingMode {
16803
16803
  /**
16804
- * Rounding mode to round away from zero
16804
+ * Rounding mode to round away from zero; examples of rounding results to one fractional digit: 0.51 is
16805
+ * rounded to 0.6, and -0.51 is rounded to -0.6.
16805
16806
  */
16806
16807
  AWAY_FROM_ZERO = "AWAY_FROM_ZERO",
16807
16808
  /**
16808
- * Rounding mode to round towards positive infinity
16809
+ * Rounding mode to round towards positive infinity; examples of rounding results to one fractional digit:
16810
+ * 0.51 is rounded to 0.6, and -0.51 is rounded to -0.5.
16809
16811
  */
16810
16812
  CEILING = "CEILING",
16811
16813
  /**
16812
- * Rounding mode to round towards negative infinity
16814
+ * Rounding mode to round towards negative infinity; examples of rounding results to one fractional digit:
16815
+ * 0.51 is rounded to 0.5, and -0.51 is rounded to -0.6.
16813
16816
  */
16814
16817
  FLOOR = "FLOOR",
16815
16818
  /**
16816
- * Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case
16817
- * round away from zero.
16819
+ * Rounding mode to round towards the nearest neighbor unless, both neighbors are equidistant, in which
16820
+ * case round away from zero; examples of rounding results to one fractional digit: 0.54 or 0.46 are rounded
16821
+ * to 0.5, -0.54 or -0.46 are rounded to -0.5, 0.55 is rounded to 0.6, and -0.55 is rounded to -0.6.
16818
16822
  */
16819
16823
  HALF_AWAY_FROM_ZERO = "HALF_AWAY_FROM_ZERO",
16820
16824
  /**
16821
- * Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case
16822
- * round towards positive infinity.
16825
+ * Rounding mode to round towards the nearest neighbor, unless both neighbors are equidistant, in which
16826
+ * case round towards positive infinity; examples of rounding results to one fractional digit: 0.54 or 0.46
16827
+ * are rounded to 0.5, -0.54 or -0.46 are rounded to -0.5, 0.55 is rounded to 0.6, and -0.55 is rounded
16828
+ * to -0.5.
16823
16829
  */
16824
16830
  HALF_CEILING = "HALF_CEILING",
16825
16831
  /**
16826
- * Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case
16827
- * round towards negative infinity.
16832
+ * Rounding mode to round towards the nearest neighbor, unless both neighbors are equidistant, in which
16833
+ * case round towards negative infinity; examples of rounding results to one fractional digit: 0.54 or 0.46
16834
+ * are rounded to 0.5, -0.54 or -0.46 are rounded to -0.5, 0.55 is rounded to 0.5, and -0.55 is rounded
16835
+ * to -0.6.
16828
16836
  */
16829
16837
  HALF_FLOOR = "HALF_FLOOR",
16830
16838
  /**
16831
- * Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case
16832
- * round towards zero.
16839
+ * Rounding mode to round towards the nearest neighbor, unless both neighbors are equidistant, in which
16840
+ * case round towards zero; examples of rounding results to one fractional digit: 0.54 or 0.46 are rounded
16841
+ * to 0.5, -0.54 or -0.46 are rounded to -0.5, 0.55 is rounded to 0.5, and -0.55 is rounded to -0.5.
16833
16842
  */
16834
16843
  HALF_TOWARDS_ZERO = "HALF_TOWARDS_ZERO",
16835
16844
  /**
16836
- * Rounding mode to round towards zero
16845
+ * Rounding mode to round towards zero; examples of rounding results to one fractional digit: 0.59 is rounded
16846
+ * to 0.5, and -0.59 is rounded to -0.5.
16837
16847
  */
16838
16848
  TOWARDS_ZERO = "TOWARDS_ZERO",
16839
16849
  }
@@ -17027,10 +17037,10 @@ declare namespace sap {
17027
17037
  */
17028
17038
  relative?: boolean;
17029
17039
  /**
17030
- * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to default value
17031
- * 'day', the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next
17032
- * 6 days are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all
17033
- * dates are formatted relatively.
17040
+ * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to value 'day',
17041
+ * the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next 6 days
17042
+ * are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all dates are
17043
+ * formatted relatively.
17034
17044
  */
17035
17045
  relativeRange?: int[];
17036
17046
  /**
@@ -17250,10 +17260,10 @@ declare namespace sap {
17250
17260
  */
17251
17261
  relative?: boolean;
17252
17262
  /**
17253
- * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to default value
17254
- * 'day', the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next
17255
- * 6 days are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all
17256
- * dates are formatted relatively.
17263
+ * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to value 'day',
17264
+ * the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next 6 days
17265
+ * are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all dates are
17266
+ * formatted relatively.
17257
17267
  */
17258
17268
  relativeRange?: int[];
17259
17269
  /**
@@ -18425,15 +18435,16 @@ declare namespace sap {
18425
18435
  * Format a number according to the given format options.
18426
18436
  *
18427
18437
  *
18428
- * @returns the formatted output value
18438
+ * @returns The formatted value
18429
18439
  */
18430
18440
  format(
18431
18441
  /**
18432
- * the number to format or an array which contains the number to format and the sMeasure parameter
18442
+ * The number to format as a number or a string, such as `1234.45` or `"-1234.45"`, or an array which contains
18443
+ * both the number to format as a number or a string and the `sMeasure` parameter
18433
18444
  */
18434
- vValue: number | any[],
18445
+ vValue: number | string | any[],
18435
18446
  /**
18436
- * an optional unit which has an impact on formatting currencies and units
18447
+ * An optional unit which has an impact on formatting currencies and units
18437
18448
  */
18438
18449
  sMeasure?: string
18439
18450
  ): string;
@@ -19843,8 +19854,16 @@ declare namespace sap {
19843
19854
  * sap.ui.core.Control.prototype.onAfterRendering
19844
19855
  *
19845
19856
  * @ui5-protected Do not call from applications (only from related classes in the framework)
19857
+ *
19858
+ * @returns This lifecycle hook must not have a return value. Return value `void` is deprecated since 1.120,
19859
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
19860
+ * function returning a Promise should be used.
19861
+ *
19862
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
19863
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
19864
+ * and will fail in future major versions of UI5.
19846
19865
  */
19847
- onAfterRendering(): void;
19866
+ onAfterRendering(): void | undefined;
19848
19867
  /**
19849
19868
  * This method is called every time the View is rendered, before the Renderer is called and the HTML is
19850
19869
  * placed in the DOM-Tree. It can be used to perform clean-up-tasks before re-rendering. (Even though this
@@ -19854,8 +19873,16 @@ declare namespace sap {
19854
19873
  * sap.ui.core.Control.prototype.onBeforeRendering
19855
19874
  *
19856
19875
  * @ui5-protected Do not call from applications (only from related classes in the framework)
19876
+ *
19877
+ * @returns This lifecycle hook must not have a return value. Return value `void` is deprecated since 1.120,
19878
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
19879
+ * function returning a Promise should be used.
19880
+ *
19881
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
19882
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
19883
+ * and will fail in future major versions of UI5.
19857
19884
  */
19858
- onBeforeRendering(): void;
19885
+ onBeforeRendering(): void | undefined;
19859
19886
  /**
19860
19887
  * This method is called upon desctuction of the View. The controller should perform its internal destruction
19861
19888
  * in this hook. It is only called once per View instance, unlike the onBeforeRendering and onAfterRendering
@@ -19863,8 +19890,16 @@ declare namespace sap {
19863
19890
  * if the method does not exist, it will simply not be called.)
19864
19891
  *
19865
19892
  * @ui5-protected Do not call from applications (only from related classes in the framework)
19893
+ *
19894
+ * @returns This lifecycle hook must not have a return value. Return value `void` is deprecated since 1.120,
19895
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
19896
+ * function returning a Promise should be used.
19897
+ *
19898
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
19899
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
19900
+ * and will fail in future major versions of UI5.
19866
19901
  */
19867
- onExit(): void;
19902
+ onExit(): void | undefined;
19868
19903
  /**
19869
19904
  * This method is called upon initialization of the View. The controller can perform its internal setup
19870
19905
  * in this hook. It is only called once per View instance, unlike the onBeforeRendering and onAfterRendering
@@ -19878,8 +19913,16 @@ declare namespace sap {
19878
19913
  * event. The event is fired when either the context or the model changes for the control.
19879
19914
  *
19880
19915
  * @ui5-protected Do not call from applications (only from related classes in the framework)
19916
+ *
19917
+ * @returns This lifecycle hook must not have a return value. Return value `void` is deprecated since 1.120,
19918
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
19919
+ * function returning a Promise should be used.
19920
+ *
19921
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
19922
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
19923
+ * and will fail in future major versions of UI5.
19881
19924
  */
19882
- onInit(): void;
19925
+ onInit(): void | undefined;
19883
19926
  }
19884
19927
  /**
19885
19928
  * Base class for controller extensions.
@@ -24186,7 +24229,7 @@ declare namespace sap {
24186
24229
  */
24187
24230
  addRoute(
24188
24231
  /**
24189
- * Configuration object for the route @see sap.ui.core.routing.Route#constructor
24232
+ * Configuration object for the route, see {@link sap.ui.core.routing.Route#constructor}
24190
24233
  */
24191
24234
  oConfig: sap.ui.core.routing.$RouteSettings,
24192
24235
  /**
@@ -36325,7 +36368,7 @@ declare namespace sap {
36325
36368
  */
36326
36369
  settings?: sap.ui.core.$ComponentSettings;
36327
36370
  /**
36328
- * Initial data of the component (@see sap.ui.core.Component#getComponentData)
36371
+ * Initial data of the component, see {@link sap.ui.core.Component#getComponentData}
36329
36372
  */
36330
36373
  componentData?: object;
36331
36374
  }
@@ -36339,8 +36382,16 @@ declare namespace sap {
36339
36382
  * Subclasses of Component should override this hook to implement any necessary cleanup.
36340
36383
  *
36341
36384
  * @ui5-protected Do not call from applications (only from related classes in the framework)
36385
+ *
36386
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
36387
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
36388
+ * function returning a Promise should be used.
36389
+ *
36390
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
36391
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
36392
+ * and will fail in future major versions of UI5.
36342
36393
  */
36343
- exit(): void;
36394
+ exit(): void | undefined;
36344
36395
  /**
36345
36396
  * Returns the list of active terminologies. See the {@link sap.ui.core.Component.create Component.create }
36346
36397
  * factory API documentation for more detail.
@@ -36499,15 +36550,29 @@ declare namespace sap {
36499
36550
  * Subclasses of Component should override this hook to implement any necessary initialization.
36500
36551
  *
36501
36552
  * @ui5-protected Do not call from applications (only from related classes in the framework)
36553
+ *
36554
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
36555
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
36556
+ * function returning a Promise should be used.
36557
+ *
36558
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
36559
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
36560
+ * and will fail in future major versions of UI5.
36502
36561
  */
36503
- init(): void;
36562
+ init(): void | undefined;
36504
36563
  /**
36505
36564
  * This method is called after the component is activated
36506
36565
  *
36507
36566
  * @since 1.88
36508
36567
  * @ui5-protected Do not call from applications (only from related classes in the framework)
36568
+ *
36569
+ * @returns This lifecycle hook must not have a return value.
36570
+ *
36571
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
36572
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
36573
+ * and will fail in future major versions of UI5.
36509
36574
  */
36510
- onActivate(): void;
36575
+ onActivate(): void | undefined;
36511
36576
  /**
36512
36577
  * The hook which gets called when the static configuration of the component has been changed by some configuration
36513
36578
  * extension.
@@ -36525,8 +36590,14 @@ declare namespace sap {
36525
36590
  *
36526
36591
  * @since 1.88
36527
36592
  * @ui5-protected Do not call from applications (only from related classes in the framework)
36593
+ *
36594
+ * @returns This lifecycle hook must not have a return value.
36595
+ *
36596
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
36597
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
36598
+ * and will fail in future major versions of UI5.
36528
36599
  */
36529
- onDeactivate(): void;
36600
+ onDeactivate(): void | undefined;
36530
36601
  /**
36531
36602
  * The window before unload hook. Override this method in your Component class implementation, to handle
36532
36603
  * cleanup before the real unload or to prompt a question to the user, if the component should be exited.
@@ -38064,13 +38135,21 @@ declare namespace sap {
38064
38135
  * Subclasses of Control should override this hook to implement any necessary actions after the rendering.
38065
38136
  *
38066
38137
  * @ui5-protected Do not call from applications (only from related classes in the framework)
38138
+ *
38139
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
38140
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
38141
+ * function returning a Promise should be used.
38142
+ *
38143
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
38144
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
38145
+ * and will fail in future major versions of UI5.
38067
38146
  */
38068
38147
  onAfterRendering(
38069
38148
  /**
38070
38149
  * onAfterRendering event object
38071
38150
  */
38072
38151
  oEvent: jQuery.Event
38073
- ): void;
38152
+ ): void | undefined;
38074
38153
  /**
38075
38154
  * Function is called before the rendering of the control is started.
38076
38155
  *
@@ -38079,13 +38158,21 @@ declare namespace sap {
38079
38158
  * Subclasses of Control should override this hook to implement any necessary actions before the rendering.
38080
38159
  *
38081
38160
  * @ui5-protected Do not call from applications (only from related classes in the framework)
38161
+ *
38162
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
38163
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
38164
+ * function returning a Promise should be used.
38165
+ *
38166
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
38167
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
38168
+ * and will fail in future major versions of UI5.
38082
38169
  */
38083
38170
  onBeforeRendering(
38084
38171
  /**
38085
38172
  * onBeforeRendering event object
38086
38173
  */
38087
38174
  oEvent: jQuery.Event
38088
- ): void;
38175
+ ): void | undefined;
38089
38176
  /**
38090
38177
  * Puts `this` control into the specified container (`oRef`) at the given position (`oPosition`).
38091
38178
  *
@@ -39120,8 +39207,16 @@ declare namespace sap {
39120
39207
  * in the documentation.
39121
39208
  *
39122
39209
  * @ui5-protected Do not call from applications (only from related classes in the framework)
39210
+ *
39211
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
39212
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
39213
+ * function returning a Promise should be used.
39214
+ *
39215
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
39216
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
39217
+ * and will fail in future major versions of UI5.
39123
39218
  */
39124
- exit(): void;
39219
+ exit(): void | undefined;
39125
39220
  /**
39126
39221
  * Searches and returns an array of child elements and controls which are referenced within an aggregation
39127
39222
  * or aggregations of child elements/controls. This can be either done recursive or not.
@@ -39349,8 +39444,16 @@ declare namespace sap {
39349
39444
  * Subclasses of Element should override this hook to implement any necessary initialization.
39350
39445
  *
39351
39446
  * @ui5-protected Do not call from applications (only from related classes in the framework)
39447
+ *
39448
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
39449
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
39450
+ * function returning a Promise should be used.
39451
+ *
39452
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
39453
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
39454
+ * and will fail in future major versions of UI5.
39352
39455
  */
39353
- init(): void;
39456
+ init(): void | undefined;
39354
39457
  /**
39355
39458
  * Inserts a customData into the aggregation {@link #getCustomData customData}.
39356
39459
  *
@@ -50337,21 +50440,21 @@ declare namespace sap {
50337
50440
  */
50338
50441
  addCondition(
50339
50442
  /**
50340
- * The name of the property bound in the condition
50443
+ * The name of the property or a {@link sap.ui.model.Filter} instance
50341
50444
  */
50342
- sPropertyName: string,
50445
+ vPropertyNameOrFilter: string | sap.ui.model.Filter,
50343
50446
  /**
50344
- * operator used for the condition
50447
+ * The operator of the condition, only used if `vPropertyNameOrFilter` is a string
50345
50448
  */
50346
- sOperator: sap.ui.model.FilterOperator,
50449
+ sOperator?: sap.ui.model.FilterOperator,
50347
50450
  /**
50348
- * value to be used for this condition
50451
+ * The value of the condition, only used if `vPropertyNameOrFilter` is a string
50349
50452
  */
50350
- oValue: object,
50453
+ oValue?: object,
50351
50454
  /**
50352
- * (optional) as second value to be used for this condition
50455
+ * The second value of the condition, only used if `vPropertyNameOrFilter` is a string
50353
50456
  */
50354
- oValue2: object
50457
+ oValue2?: object
50355
50458
  ): sap.ui.model.analytics.odata4analytics.FilterExpression;
50356
50459
  /**
50357
50460
  * Add a set condition to the filter expression.
@@ -50373,7 +50476,7 @@ declare namespace sap {
50373
50476
  aValues: any[]
50374
50477
  ): sap.ui.model.analytics.odata4analytics.FilterExpression;
50375
50478
  /**
50376
- * Add an array of UI5 filter conditions to the filter expression.
50479
+ * Adds an array of UI5 filter conditions to the filter expression.
50377
50480
  *
50378
50481
  * The UI5 filter condition is combined with the other given conditions using a logical AND. This method
50379
50482
  * is particularly useful for passing forward already created UI5 filter arrays.
@@ -51645,13 +51748,14 @@ declare namespace sap {
51645
51748
  */
51646
51749
  oContext?: object,
51647
51750
  /**
51648
- * An array of predefined sorters
51751
+ * The sorters used initially; call {@link #sort} to replace them
51649
51752
  */
51650
- aSorter?: any[],
51753
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
51651
51754
  /**
51652
- * An array of predefined filters
51755
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
51756
+ * to replace them
51653
51757
  */
51654
- aFilters?: any[],
51758
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
51655
51759
  /**
51656
51760
  * A map containing additional binding parameters; for the `AnalyticalBinding` this parameter is mandatory
51657
51761
  */
@@ -51743,9 +51847,11 @@ declare namespace sap {
51743
51847
  */
51744
51848
  filter(
51745
51849
  /**
51746
- * an Array of sap.ui.model.Filter objects or a single Filter instance.
51850
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
51851
+ * given in {@link sap.ui.model.odata.v2.ODataModel#bindList}; a falsy value is treated as an empty array
51852
+ * and thus removes all filters of the specified type
51747
51853
  */
51748
- aFilter: sap.ui.model.Filter[] | sap.ui.model.Filter,
51854
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
51749
51855
  /**
51750
51856
  * Type of the filter which should be adjusted.
51751
51857
  */
@@ -52169,9 +52275,10 @@ declare namespace sap {
52169
52275
  */
52170
52276
  sort(
52171
52277
  /**
52172
- * a sorter object or an array of sorter objects which define the sort order.
52278
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.odata.v2.ODataModel#bindList};
52279
+ * a falsy value is treated as an empty array and thus removes all sorters
52173
52280
  */
52174
- aSorter: sap.ui.model.Sorter | any[]
52281
+ aSorter?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
52175
52282
  ): this;
52176
52283
  /**
52177
52284
  * Updates the binding's structure with new analytical information.
@@ -52269,7 +52376,7 @@ declare namespace sap {
52269
52376
  */
52270
52377
  constructor(
52271
52378
  /**
52272
- * optional Setup-Parameter, @see BatchResponseCollector#setup
52379
+ * optional Setup-Parameter, see {@link #setup}
52273
52380
  */
52274
52381
  mParams?: object
52275
52382
  );
@@ -52378,13 +52485,14 @@ declare namespace sap {
52378
52485
  */
52379
52486
  oContext: sap.ui.model.Context,
52380
52487
  /**
52381
- * Initial sort order (can be either a sorter or an array of sorters)
52488
+ * The sorters used initially; call {@link #sort} to replace them
52382
52489
  */
52383
- aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
52490
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
52384
52491
  /**
52385
- * Predefined filter/s (can be either a filter or an array of filters)
52492
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
52493
+ * to replace them
52386
52494
  */
52387
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
52495
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
52388
52496
  /**
52389
52497
  * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
52390
52498
  */
@@ -52498,9 +52606,11 @@ declare namespace sap {
52498
52606
  */
52499
52607
  sURL: string,
52500
52608
  /**
52501
- * A map or string that is sent to the server with the request. Data that is sent to the server is appended
52502
- * to the URL as a query string. If the value of the data parameter is an object (map), it is converted
52503
- * to a string and url-encoded before it is appended to the URL.
52609
+ * A map or string that is sent to the server with the request. If the value of this parameter is a string,
52610
+ * it must already be url-encoded. If the value of this parameter is an object (map), it is converted to
52611
+ * a string and then url-encoded. The resulting string is appended to the URL if the HTTP request method
52612
+ * cannot have a request body, e.g. for a GET request. Otherwise, the resulting string is added to the request
52613
+ * body.
52504
52614
  */
52505
52615
  oParameters?: object | string,
52506
52616
  /**
@@ -52648,9 +52758,10 @@ declare namespace sap {
52648
52758
  */
52649
52759
  oContext?: object,
52650
52760
  /**
52651
- * Predefined filters contained in an array
52761
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
52762
+ * to replace them
52652
52763
  */
52653
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
52764
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
52654
52765
  /**
52655
52766
  * Additional model-specific parameters
52656
52767
  */
@@ -52662,7 +52773,11 @@ declare namespace sap {
52662
52773
  * its child arrays will be ignored as well even if they have been added to `arrayNames`.
52663
52774
  */
52664
52775
  arrayNames?: string[];
52665
- }
52776
+ },
52777
+ /**
52778
+ * The sorters used initially; call {@link #sort} to replace them
52779
+ */
52780
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
52666
52781
  );
52667
52782
  }
52668
52783
  }
@@ -55803,8 +55918,8 @@ declare namespace sap {
55803
55918
  */
55804
55919
  type failedParameters = {
55805
55920
  /**
55806
- * An array of Errors (@see sap.ui.model.v2.ODataAnnotations#error) that occurred while loading a group
55807
- * of annotations
55921
+ * An array of Errors, see {@link sap.ui.model.v2.ODataAnnotations#error} that occurred while loading a
55922
+ * group of annotations
55808
55923
  */
55809
55924
  result: Error[];
55810
55925
  };
@@ -56980,13 +57095,14 @@ declare namespace sap {
56980
57095
  */
56981
57096
  oContext?: sap.ui.model.Context,
56982
57097
  /**
56983
- * Initial sort order, can be either a sorter or an array of sorters.
57098
+ * The sorters used initially; call {@link #sort} to replace them
56984
57099
  */
56985
- aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
57100
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
56986
57101
  /**
56987
- * Predefined filters, can be either a filter or an array of filters.
57102
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
57103
+ * to replace them
56988
57104
  */
56989
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
57105
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
56990
57106
  /**
56991
57107
  * A map which contains additional parameters for the binding.
56992
57108
  */
@@ -57202,11 +57318,13 @@ declare namespace sap {
57202
57318
  */
57203
57319
  filter(
57204
57320
  /**
57205
- * Single filter or array of filter objects
57321
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
57322
+ * given in {@link sap.ui.model.odata.v2.ODataModel#bindList}; a falsy value is treated as an empty array
57323
+ * and thus removes all filters of the specified type
57206
57324
  */
57207
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
57325
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
57208
57326
  /**
57209
- * Type of the filter which should be adjusted. If it is not given, type `Control` is assumed
57327
+ * The type of the filter to replace
57210
57328
  */
57211
57329
  sFilterType?: sap.ui.model.FilterType,
57212
57330
  /**
@@ -57376,9 +57494,10 @@ declare namespace sap {
57376
57494
  */
57377
57495
  sort(
57378
57496
  /**
57379
- * A new sorter or an array of sorters which define the sort order
57497
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.odata.v2.ODataModel#bindList};
57498
+ * a falsy value is treated as an empty array and thus removes all sorters
57380
57499
  */
57381
- aSorters: sap.ui.model.Sorter | sap.ui.model.Sorter[],
57500
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
57382
57501
  /**
57383
57502
  * Whether the success indicator should be returned instead of `this`
57384
57503
  */
@@ -58000,13 +58119,14 @@ declare namespace sap {
58000
58119
  */
58001
58120
  oContext?: sap.ui.model.Context,
58002
58121
  /**
58003
- * Initial sort order, can be either a sorter or an array of sorters.
58122
+ * The sorters used initially; call {@link sap.ui.model.odata.v2.ODataListBinding#sort} to replace them
58004
58123
  */
58005
- aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
58124
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
58006
58125
  /**
58007
- * Predefined filters, can be either a filter or an array of filters.
58126
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link sap.ui.model.odata.v2.ODataListBinding#filter }
58127
+ * to replace them
58008
58128
  */
58009
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
58129
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
58010
58130
  /**
58011
58131
  * A map which contains additional parameters for the binding.
58012
58132
  */
@@ -58132,7 +58252,7 @@ declare namespace sap {
58132
58252
  *
58133
58253
  * Operation Modes: For a full definition and explanation of all OData binding operation modes, see {@link sap.ui.model.odata.OperationMode}.
58134
58254
  *
58135
- * OperationMode.Server: Filtering on the `ODataTreeBinding` is only supported with {@link sap.ui.model.FilterType.Application application filters}.
58255
+ * OperationMode.Server: Filtering on the `ODataTreeBinding` is only supported with filters of type {@link sap.ui.model.FilterType.Application}.
58136
58256
  * Be aware that this applies only to filters which do not prevent the creation of a hierarchy. So filtering
58137
58257
  * on a property (e.g. a "Customer") is fine, as long as the application ensures that the responses from
58138
58258
  * the back end are sufficient to create a valid hierarchy on the client. Subsequent paging requests for
@@ -58166,8 +58286,8 @@ declare namespace sap {
58166
58286
  */
58167
58287
  oContext?: sap.ui.model.Context,
58168
58288
  /**
58169
- * The application filters to be used initially; depending on the operation mode, there are restrictions
58170
- * for using filters, see above
58289
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link sap.ui.model.odata.v2.ODataTreeBinding#filter }
58290
+ * to replace them; depending on the operation mode, there are restrictions for using filters; see above
58171
58291
  */
58172
58292
  vFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
58173
58293
  /**
@@ -58285,9 +58405,9 @@ declare namespace sap {
58285
58405
  navigation?: object;
58286
58406
  },
58287
58407
  /**
58288
- * The dynamic sorters to be used initially
58408
+ * The sorters used initially; call {@link sap.ui.model.odata.v2.ODataTreeBinding#sort} to replace them
58289
58409
  */
58290
- vSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[]
58410
+ vSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
58291
58411
  ): sap.ui.model.odata.v2.ODataTreeBinding;
58292
58412
  /**
58293
58413
  * Triggers a request for the given function import.
@@ -60070,13 +60190,15 @@ declare namespace sap {
60070
60190
  */
60071
60191
  filter(
60072
60192
  /**
60073
- * Filter or array of filters to apply
60193
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
60194
+ * given in {@link sap.ui.model.odata.v2.ODataModel#bindTree}; a falsy value is treated as an empty array
60195
+ * and thus removes all filters of the specified type
60074
60196
  */
60075
- aFilters: sap.ui.model.Filter[] | sap.ui.model.Filter,
60197
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
60076
60198
  /**
60077
- * Type of the filter which should be adjusted. If it is not given, the type `FilterType.Control` is assumed
60199
+ * The type of the filter to replace
60078
60200
  */
60079
- sFilterType: sap.ui.model.FilterType,
60201
+ sFilterType?: sap.ui.model.FilterType,
60080
60202
  /**
60081
60203
  * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
60082
60204
  */
@@ -60227,9 +60349,10 @@ declare namespace sap {
60227
60349
  */
60228
60350
  sort(
60229
60351
  /**
60230
- * The Sorter or an Array of sap.ui.model.Sorter instances
60352
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.odata.v2.ODataModel#bindTree};
60353
+ * a falsy value is treated as an empty array and thus removes all sorters
60231
60354
  */
60232
- aSorters: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
60355
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
60233
60356
  /**
60234
60357
  * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
60235
60358
  */
@@ -61399,7 +61522,8 @@ declare namespace sap {
61399
61522
  * Returns `undefined` if the data is not (yet) available; no request is triggered. Use {@link #requestObject }
61400
61523
  * for asynchronous access.
61401
61524
  *
61402
- * The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
61525
+ * The header context of a list binding only delivers `$count` and `@$ui5.context.isSelected` (wrapped in
61526
+ * an object if `sPath` is "").
61403
61527
  * See:
61404
61528
  * sap.ui.model.Context#getObject
61405
61529
  *
@@ -61417,7 +61541,7 @@ declare namespace sap {
61417
61541
  * Returns the parent node (in case of a recursive hierarchy; see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation})
61418
61542
  * or `undefined` if the parent of this node hasn't been read yet; it can then be requested via {@link #requestParent}.
61419
61543
  *
61420
- * @experimental (since 1.120.0)
61544
+ * @since 1.122.0
61421
61545
  *
61422
61546
  * @returns The parent node, or `null` if this node is a root node and thus has no parent, or `undefined`
61423
61547
  * if the parent node hasn't been read yet
@@ -61539,7 +61663,9 @@ declare namespace sap {
61539
61663
  */
61540
61664
  isKeepAlive(): boolean;
61541
61665
  /**
61542
- * Tells whether this context is currently selected, but not {@link #delete deleted} on the client.
61666
+ * Tells whether this context is currently selected, but not {@link #delete deleted} on the client. Since
61667
+ * 1.122.0 the selection state can also be accessed via instance annotation "@$ui5.context.isSelected" at
61668
+ * the entity. Note that the annotation does not take the deletion state into account.
61543
61669
  * See:
61544
61670
  * #setSelected
61545
61671
  *
@@ -61646,7 +61772,8 @@ declare namespace sap {
61646
61772
  * to the complete data the context points to (if `sPath` is "") or any part thereof. The data is a JSON
61647
61773
  * structure as described in "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link sap.ui.model.odata.v4.Context#setProperty}.
61648
61774
  *
61649
- * The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
61775
+ * The header context of a list binding only delivers `$count` and `@$ui5.context.isSelected` (wrapped in
61776
+ * an object if `sPath` is "").
61650
61777
  *
61651
61778
  * In case of a {@link sap.ui.model.odata.v4.ODataContextBinding#getBoundContext context binding's bound context }
61652
61779
  * that hasn't requested its data yet, this method causes an initial back-end request using the binding's
@@ -61672,12 +61799,10 @@ declare namespace sap {
61672
61799
  ): Promise<any>;
61673
61800
  /**
61674
61801
  * Requests the parent node (in case of a recursive hierarchy; see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
61675
- *
61676
- * Note: **DO NOT** call {@link #setKeepAlive} on the resulting context!
61677
61802
  * See:
61678
61803
  * #getParent
61679
61804
  *
61680
- * @experimental (since 1.120.0)
61805
+ * @since 1.122.0
61681
61806
  *
61682
61807
  * @returns A promise which:
61683
61808
  * - Resolves if successful with either the parent node or `null` for a root node that has no parent
@@ -61695,7 +61820,7 @@ declare namespace sap {
61695
61820
  * @since 1.39.0
61696
61821
  *
61697
61822
  * @returns A promise on the requested value or values; it is rejected if a value is not primitive or if
61698
- * the context is a header context and a path is not "$count"
61823
+ * the context is a header context and a path is not "$count" or "@$ui5.context.isSelected"
61699
61824
  */
61700
61825
  requestProperty(
61701
61826
  /**
@@ -61867,7 +61992,9 @@ declare namespace sap {
61867
61992
  /**
61868
61993
  * Sets a new value for the property identified by the given path. The path is relative to this context
61869
61994
  * and is expected to point to a structural property with primitive type or, since 1.85.0, to an instance
61870
- * annotation.
61995
+ * annotation. Since 1.122.0 the client-side annotation "@$ui5.context.isSelected" can be given as a path.
61996
+ * Note: Writing to a client-side annotation never triggers a PATCH request, even if `sGroupId` is given.
61997
+ * Thus, reverting the value of this annotation cannot be done via {@link #resetChanges}.
61871
61998
  * See:
61872
61999
  * #getProperty
61873
62000
  * sap.ui.model.odata.v4.ODataContextBinding#event:patchSent
@@ -61896,8 +62023,8 @@ declare namespace sap {
61896
62023
  vValue: any,
61897
62024
  /**
61898
62025
  * The group ID to be used for the PATCH request; if not specified, the update group ID for the context's
61899
- * binding is used, see {@link #getUpdateGroupId}. Since 1.74.0, you can use `null` to prevent the PATCH
61900
- * request.
62026
+ * binding is used, see {@link #getUpdateGroupId}. When writing to a client-side annotation, `null` is used
62027
+ * automatically. Since 1.74.0, you can use `null` to prevent the PATCH request.
61901
62028
  */
61902
62029
  sGroupId?: string,
61903
62030
  /**
@@ -61917,9 +62044,11 @@ declare namespace sap {
61917
62044
  bRetry?: boolean
61918
62045
  ): Promise<void>;
61919
62046
  /**
61920
- * Determines whether this context is currently selected. If the preconditions of {@link #setKeepAlive }
62047
+ * Sets whether this context is currently selected. While a context is currently {@link #delete deleted }
62048
+ * on the client, it does not appear as {@link #isSelected selected}. If the preconditions of {@link #setKeepAlive }
61921
62049
  * hold, a best effort is made to implicitly keep a selected context alive in order to preserve the selection
61922
- * state. While a context is currently {@link #delete deleted} on the client, it does not appear as {@link #isSelected selected}.
62050
+ * state. Once the selection is no longer needed, for example because you perform an operation on this context
62051
+ * which logically removes it from its list, you need to reset the selection.
61923
62052
  *
61924
62053
  * **Note:** It is unsafe to keep a reference to a context instance which is not {@link #isKeepAlive kept alive}.
61925
62054
  * See:
@@ -62325,7 +62454,9 @@ declare namespace sap {
62325
62454
  * Refreshes the binding. Prompts the model to retrieve data from the server using the given group ID and
62326
62455
  * notifies the control that new data is available.
62327
62456
  *
62328
- * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context}.
62457
+ * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context},
62458
+ * as well as (since 1.122.0) for bindings with the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList }
62459
+ * and {@link sap.ui.model.odata.v4.ODataModel#bindContext})
62329
62460
  *
62330
62461
  * Note: When calling {@link #refresh} multiple times, the result of the request triggered by the last call
62331
62462
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch }
@@ -63029,7 +63160,7 @@ declare namespace sap {
63029
63160
  */
63030
63161
  getGroupId(): string;
63031
63162
  /**
63032
- * Returns the header context which allows binding to `$count`.
63163
+ * Returns the header context which allows binding to `$count` or `@$ui5.context.isSelected`.
63033
63164
  * See:
63034
63165
  * #getCount
63035
63166
  *
@@ -63186,7 +63317,9 @@ declare namespace sap {
63186
63317
  * Refreshes the binding. Prompts the model to retrieve data from the server using the given group ID and
63187
63318
  * notifies the control that new data is available.
63188
63319
  *
63189
- * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context}.
63320
+ * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context},
63321
+ * as well as (since 1.122.0) for bindings with the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList }
63322
+ * and {@link sap.ui.model.odata.v4.ODataModel#bindContext})
63190
63323
  *
63191
63324
  * Note: When calling {@link #refresh} multiple times, the result of the request triggered by the last call
63192
63325
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch }
@@ -64044,7 +64177,7 @@ declare namespace sap {
64044
64177
  * must refer to a function in `mParameters.scope` in case of a relative name starting with a dot, which
64045
64178
  * is stripped before lookup; see the `<template:alias>` instruction for XML Templating. In case of an
64046
64179
  * absolute name, it is searched in `mParameters.scope` first and then in the global namespace. (Using the
64047
- * global namespace is @deprecated as of version 1.120.3). The names "requestCurrencyCodes" and "requestUnitsOfMeasure"
64180
+ * global namespace is deprecated as of version 1.120.3). The names "requestCurrencyCodes" and "requestUnitsOfMeasure"
64048
64181
  * default to {@link #requestCurrencyCodes} and {@link #requestUnitsOfMeasure} resp. if not present in `mParameters.scope`.
64049
64182
  * This function is called with the current object (or primitive value) and additional details and returns
64050
64183
  * the result of this {@link #requestObject} call. The additional details are given as an object with the
@@ -64870,7 +65003,7 @@ declare namespace sap {
64870
65003
  }
64871
65004
  ): sap.ui.model.odata.v4.ODataPropertyBinding;
64872
65005
  /**
64873
- * Method not supported
65006
+ * Method not supported, use {@link #bindList} with `mParameters.$$aggregation` instead.
64874
65007
  * See:
64875
65008
  * sap.ui.model.Model#bindTree
64876
65009
  *
@@ -65545,7 +65678,9 @@ declare namespace sap {
65545
65678
  * Refreshes the binding. Prompts the model to retrieve data from the server using the given group ID and
65546
65679
  * notifies the control that new data is available.
65547
65680
  *
65548
- * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context}.
65681
+ * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context},
65682
+ * as well as (since 1.122.0) for bindings with the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList }
65683
+ * and {@link sap.ui.model.odata.v4.ODataModel#bindContext})
65549
65684
  *
65550
65685
  * Note: When calling {@link #refresh} multiple times, the result of the request triggered by the last call
65551
65686
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch }
@@ -65664,7 +65799,10 @@ declare namespace sap {
65664
65799
  * Sets the new current value and updates the cache. If the value cannot be accepted or cannot be updated
65665
65800
  * on the server, an error is logged to the console and added to the message manager as a technical message.
65666
65801
  * Unless preconditions fail synchronously, a {@link sap.ui.model.odata.v4.ODataModel#event:propertyChange 'propertyChange' }
65667
- * event is fired and provides a promise on the outcome of the asynchronous operation.
65802
+ * event is fired and provides a promise on the outcome of the asynchronous operation. Since 1.122.0 this
65803
+ * method allows updates to the client-side annotation "@$ui5.context.isSelected". Note: Changing the value
65804
+ * of a client-side annotation never triggers a PATCH request, no matter which `sGroupId` is given. Thus,
65805
+ * it cannot be reverted via {@link #resetChanges}.
65668
65806
  * See:
65669
65807
  * sap.ui.model.PropertyBinding#setValue
65670
65808
  *
@@ -65679,6 +65817,7 @@ declare namespace sap {
65679
65817
  * The group ID to be used for this update call; if not specified, the update group ID for this binding
65680
65818
  * (or its relevant parent binding) is used, see {@link #getUpdateGroupId}. Valid values are `undefined`,
65681
65819
  * '$auto', '$auto.*', '$direct' or application group IDs as specified in {@link sap.ui.model.odata.v4.ODataModel}.
65820
+ * When writing to a client-side annotation, this parameter is ignored.
65682
65821
  */
65683
65822
  sGroupId?: string
65684
65823
  ): void;
@@ -70616,13 +70755,18 @@ declare namespace sap {
70616
70755
  */
70617
70756
  oContext?: object,
70618
70757
  /**
70619
- * Predefined filters contained in an array
70758
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
70759
+ * to replace them
70620
70760
  */
70621
- aFilters?: any[],
70761
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
70622
70762
  /**
70623
70763
  * Additional model-specific parameters
70624
70764
  */
70625
- mParameters?: object
70765
+ mParameters?: object,
70766
+ /**
70767
+ * The sorters used initially; call {@link #sort} to replace them
70768
+ */
70769
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
70626
70770
  );
70627
70771
  /**
70628
70772
  * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -70637,13 +70781,18 @@ declare namespace sap {
70637
70781
  */
70638
70782
  oContext?: object,
70639
70783
  /**
70640
- * Predefined filters contained in an array
70784
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
70785
+ * to replace them
70641
70786
  */
70642
- aFilters?: any[],
70787
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
70643
70788
  /**
70644
70789
  * Additional model-specific parameters
70645
70790
  */
70646
- mParameters?: object
70791
+ mParameters?: object,
70792
+ /**
70793
+ * The sorters used initially; call {@link #sort} to replace them
70794
+ */
70795
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
70647
70796
  );
70648
70797
 
70649
70798
  /**
@@ -72716,13 +72865,14 @@ declare namespace sap {
72716
72865
  */
72717
72866
  oContext: sap.ui.model.Context,
72718
72867
  /**
72719
- * Initial sort order (can be either a sorter or an array of sorters)
72868
+ * The sorters used initially; call {@link #sort} to replace them
72720
72869
  */
72721
- aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
72870
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
72722
72871
  /**
72723
- * Predefined filter/s (can be either a filter or an array of filters)
72872
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
72873
+ * to replace them
72724
72874
  */
72725
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
72875
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
72726
72876
  /**
72727
72877
  * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
72728
72878
  */
@@ -72776,12 +72926,14 @@ declare namespace sap {
72776
72926
  */
72777
72927
  filter(
72778
72928
  /**
72779
- * Single filter object or an array of filter objects
72929
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
72930
+ * given in {@link sap.ui.model.ClientModel#bindList}; a falsy value is treated as an empty array and thus
72931
+ * removes all filters of the specified type
72780
72932
  */
72781
- aFilters: sap.ui.model.Filter | sap.ui.model.Filter[],
72933
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
72782
72934
  /**
72783
- * Type of the filter which should be adjusted; if no type is given, then any previously configured application
72784
- * filters are cleared and the given filters are used as control filters
72935
+ * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
72936
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
72785
72937
  */
72786
72938
  sFilterType?: sap.ui.model.FilterType
72787
72939
  ): this;
@@ -73050,18 +73202,19 @@ declare namespace sap {
73050
73202
  */
73051
73203
  oContext?: sap.ui.model.Context,
73052
73204
  /**
73053
- * Predefined application filter, either a single instance or an array
73205
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
73206
+ * to replace them
73054
73207
  */
73055
- aApplicationFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
73208
+ aApplicationFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
73056
73209
  /**
73057
73210
  * Additional model specific parameters as defined by subclasses; this class does not introduce any own
73058
73211
  * parameters
73059
73212
  */
73060
73213
  mParameters?: object,
73061
73214
  /**
73062
- * Predefined sorter/s contained in an array (optional)
73215
+ * The sorters used initially; call {@link #sort} to replace them
73063
73216
  */
73064
- aSorters?: sap.ui.model.Sorter[]
73217
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
73065
73218
  );
73066
73219
 
73067
73220
  /**
@@ -73111,12 +73264,14 @@ declare namespace sap {
73111
73264
  */
73112
73265
  filter(
73113
73266
  /**
73114
- * Single filter object or an array of filter objects
73267
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
73268
+ * given in {@link sap.ui.model.ClientModel#bindTree}; a falsy value is treated as an empty array and thus
73269
+ * removes all filters of the specified type
73115
73270
  */
73116
- aFilters: sap.ui.model.Filter | sap.ui.model.Filter[],
73271
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
73117
73272
  /**
73118
- * Type of the filter to be adjusted; if no type is given, any previously configured application filters
73119
- * are cleared, and the given filters are used as control filters
73273
+ * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
73274
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
73120
73275
  */
73121
73276
  sFilterType?: sap.ui.model.FilterType
73122
73277
  ): this;
@@ -73189,9 +73344,10 @@ declare namespace sap {
73189
73344
  */
73190
73345
  sort(
73191
73346
  /**
73192
- * An array of Sorter instances which will be applied
73347
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.ClientModel#bindTree}; a falsy
73348
+ * value is treated as an empty array and thus removes all sorters
73193
73349
  */
73194
- aSorters: sap.ui.model.Sorter[]
73350
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
73195
73351
  ): this;
73196
73352
  }
73197
73353
 
@@ -73785,9 +73941,9 @@ declare namespace sap {
73785
73941
  * @since 1.82.0
73786
73942
  *
73787
73943
  * @returns An array of indices that determine which parts of this type shall not propagate their model
73788
- * messages to the attached control
73944
+ * messages to the attached control; an empty array is returned by default
73789
73945
  */
73790
- getPartsIgnoringMessages(): number[];
73946
+ getPartsIgnoringMessages(): int[];
73791
73947
  /**
73792
73948
  * Returns whether the {@link #formatValue} and {@link #parseValue} methods operate on the internal, related
73793
73949
  * native JavaScript values.
@@ -74590,13 +74746,14 @@ declare namespace sap {
74590
74746
  */
74591
74747
  oContext: sap.ui.model.Context,
74592
74748
  /**
74593
- * Initial sort order (can be either a sorter or an array of sorters)
74749
+ * The sorters used initially; call {@link #sort} to replace them
74594
74750
  */
74595
- aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
74751
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
74596
74752
  /**
74597
- * Predefined filter/s (can be either a filter or an array of filters)
74753
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
74754
+ * to replace them
74598
74755
  */
74599
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
74756
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
74600
74757
  /**
74601
74758
  * Additional, implementation-specific parameters that should be used by the new list binding; this base
74602
74759
  * class doesn't define any parameters, check the API reference for the concrete model implementations to
@@ -74782,11 +74939,13 @@ declare namespace sap {
74782
74939
  */
74783
74940
  filter(
74784
74941
  /**
74785
- * Single filter object or an array of filter objects
74942
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
74943
+ * given in {@link sap.ui.model.Model#bindList}; a falsy value is treated as an empty array and thus removes
74944
+ * all filters of the specified type
74786
74945
  */
74787
- aFilters: sap.ui.model.Filter | sap.ui.model.Filter[],
74946
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
74788
74947
  /**
74789
- * Type of the filter which should be adjusted; if no type is given, the behavior depends on the model implementation
74948
+ * The type of the filter to replace; if no type is given, the behavior depends on the model implementation
74790
74949
  */
74791
74950
  sFilterType?: sap.ui.model.FilterType
74792
74951
  ): this;
@@ -74993,9 +75152,10 @@ declare namespace sap {
74993
75152
  */
74994
75153
  sort(
74995
75154
  /**
74996
- * The Sorter object or an array of sorters which defines the sort order
75155
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.Model#bindList}; a falsy value
75156
+ * is treated as an empty array and thus removes all sorters
74997
75157
  */
74998
- aSorters: sap.ui.model.Sorter | sap.ui.model.Sorter[]
75158
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
74999
75159
  ): this;
75000
75160
  /**
75001
75161
  * Update the list and apply sorting and filtering. Called after creation of the list binding on enabling
@@ -75348,13 +75508,14 @@ declare namespace sap {
75348
75508
  */
75349
75509
  oContext?: sap.ui.model.Context,
75350
75510
  /**
75351
- * Initial sort order (can be either a sorter or an array of sorters)
75511
+ * The sorters used initially; call {@link sap.ui.model.ListBinding#sort} to replace them
75352
75512
  */
75353
- aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
75513
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
75354
75514
  /**
75355
- * Predefined filter/s (can be either a filter or an array of filters)
75515
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link sap.ui.model.ListBinding#filter }
75516
+ * to replace them
75356
75517
  */
75357
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
75518
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
75358
75519
  /**
75359
75520
  * Additional model-specific parameters
75360
75521
  */
@@ -75392,17 +75553,18 @@ declare namespace sap {
75392
75553
  */
75393
75554
  oContext?: sap.ui.model.Context,
75394
75555
  /**
75395
- * Predefined filter/s contained in an array
75556
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link sap.ui.model.TreeBinding#filter }
75557
+ * to replace them
75396
75558
  */
75397
- aFilters?: sap.ui.model.Filter[],
75559
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
75398
75560
  /**
75399
75561
  * Additional model specific parameters
75400
75562
  */
75401
75563
  mParameters?: object,
75402
75564
  /**
75403
- * Predefined sap.ui.model.sorter/s contained in an array
75565
+ * The sorters used initially; call {@link sap.ui.model.TreeBinding#sort} to replace them
75404
75566
  */
75405
- aSorters?: sap.ui.model.Sorter[]
75567
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
75406
75568
  ): sap.ui.model.TreeBinding;
75407
75569
  /**
75408
75570
  *
@@ -76643,17 +76805,18 @@ declare namespace sap {
76643
76805
  */
76644
76806
  oContext?: object,
76645
76807
  /**
76646
- * Predefined filter or an array of filters (optional)
76808
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
76809
+ * to replace them
76647
76810
  */
76648
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
76811
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
76649
76812
  /**
76650
76813
  * Additional model specific parameters (optional)
76651
76814
  */
76652
76815
  mParameters?: string,
76653
76816
  /**
76654
- * Predefined sorter or an array of sorters (optional)
76817
+ * The sorters used initially; call {@link #sort} to replace them
76655
76818
  */
76656
- aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[]
76819
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
76657
76820
  );
76658
76821
 
76659
76822
  /**
@@ -76730,13 +76893,15 @@ declare namespace sap {
76730
76893
  */
76731
76894
  filter(
76732
76895
  /**
76733
- * Single sap.ui.model.Filter object or an array of filter objects
76896
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
76897
+ * given in {@link sap.ui.model.Model#bindTree}; a falsy value is treated as an empty array and thus removes
76898
+ * all filters of the specified type
76734
76899
  */
76735
- aFilters: sap.ui.model.Filter | sap.ui.model.Filter[],
76900
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
76736
76901
  /**
76737
- * Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
76902
+ * The type of the filter to replace; if no type is given, the behavior depends on the model implementation
76738
76903
  */
76739
- sFilterType: sap.ui.model.FilterType
76904
+ sFilterType?: sap.ui.model.FilterType
76740
76905
  ): void;
76741
76906
  /**
76742
76907
  * Returns the number of child nodes of a specific context
@@ -76816,9 +76981,10 @@ declare namespace sap {
76816
76981
  */
76817
76982
  sort(
76818
76983
  /**
76819
- * Array of sap.ui.model.Sorter objects
76984
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.Model#bindTree}; a falsy value
76985
+ * is treated as an empty array and thus removes all sorters
76820
76986
  */
76821
- aSorters: sap.ui.model.Sorter[]
76987
+ aSorters?: sap.ui.model.Sorter[]
76822
76988
  ): void;
76823
76989
  }
76824
76990