@sapui5/types 1.113.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.
Files changed (66) hide show
  1. package/LICENSE.txt +35 -0
  2. package/README.md +35 -0
  3. package/package.json +23 -0
  4. package/types/index.d.ts +67 -0
  5. package/types/sap.apf.d.ts +1026 -0
  6. package/types/sap.ca.ui.d.ts +14005 -0
  7. package/types/sap.chart.d.ts +4815 -0
  8. package/types/sap.collaboration.d.ts +2704 -0
  9. package/types/sap.esh.search.ui.d.ts +1595 -0
  10. package/types/sap.f.d.ts +20085 -0
  11. package/types/sap.fe.core.d.ts +1508 -0
  12. package/types/sap.fe.macros.d.ts +975 -0
  13. package/types/sap.fe.navigation.d.ts +917 -0
  14. package/types/sap.fe.templates.d.ts +522 -0
  15. package/types/sap.fe.test.d.ts +3533 -0
  16. package/types/sap.feedback.ui.d.ts +3 -0
  17. package/types/sap.gantt.d.ts +51684 -0
  18. package/types/sap.insights.d.ts +23 -0
  19. package/types/sap.landvisz.d.ts +7952 -0
  20. package/types/sap.m.d.ts +147796 -0
  21. package/types/sap.makit.d.ts +4533 -0
  22. package/types/sap.me.d.ts +3665 -0
  23. package/types/sap.ndc.d.ts +774 -0
  24. package/types/sap.ovp.d.ts +176 -0
  25. package/types/sap.rules.ui.d.ts +1471 -0
  26. package/types/sap.sac.df.d.ts +2292 -0
  27. package/types/sap.sac.grid.d.ts +774 -0
  28. package/types/sap.suite.ui.commons.d.ts +46971 -0
  29. package/types/sap.suite.ui.generic.template.d.ts +3431 -0
  30. package/types/sap.suite.ui.microchart.d.ts +12652 -0
  31. package/types/sap.tnt.d.ts +2227 -0
  32. package/types/sap.ui.codeeditor.d.ts +693 -0
  33. package/types/sap.ui.commons.d.ts +30235 -0
  34. package/types/sap.ui.comp.d.ts +37411 -0
  35. package/types/sap.ui.core.d.ts +78872 -0
  36. package/types/sap.ui.dt.d.ts +3 -0
  37. package/types/sap.ui.export.d.ts +843 -0
  38. package/types/sap.ui.fl.d.ts +1663 -0
  39. package/types/sap.ui.generic.app.d.ts +2683 -0
  40. package/types/sap.ui.generic.template.d.ts +3 -0
  41. package/types/sap.ui.integration.d.ts +4032 -0
  42. package/types/sap.ui.layout.d.ts +14472 -0
  43. package/types/sap.ui.mdc.d.ts +476 -0
  44. package/types/sap.ui.richtexteditor.d.ts +1666 -0
  45. package/types/sap.ui.rta.d.ts +124 -0
  46. package/types/sap.ui.suite.d.ts +685 -0
  47. package/types/sap.ui.support.d.ts +453 -0
  48. package/types/sap.ui.table.d.ts +9325 -0
  49. package/types/sap.ui.testrecorder.d.ts +9 -0
  50. package/types/sap.ui.unified.d.ts +20640 -0
  51. package/types/sap.ui.ux3.d.ts +18288 -0
  52. package/types/sap.ui.vbm.d.ts +17251 -0
  53. package/types/sap.ui.vk.d.ts +42381 -0
  54. package/types/sap.ui.vtm.d.ts +10547 -0
  55. package/types/sap.ui.webc.common.d.ts +113 -0
  56. package/types/sap.ui.webc.fiori.d.ts +13850 -0
  57. package/types/sap.ui.webc.main.d.ts +40833 -0
  58. package/types/sap.uiext.inbox.d.ts +4079 -0
  59. package/types/sap.ushell.d.ts +10255 -0
  60. package/types/sap.ushell_abap.d.ts +9 -0
  61. package/types/sap.uxap.d.ts +7636 -0
  62. package/types/sap.viz.d.ts +51209 -0
  63. package/types/sap.webanalytics.core.d.ts +3 -0
  64. package/types/sap.zen.commons.d.ts +1542 -0
  65. package/types/sap.zen.crosstab.d.ts +1159 -0
  66. package/types/sap.zen.dsh.d.ts +2132 -0
@@ -0,0 +1,2683 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/ui/generic/app/library" {
4
+ export namespace navigation {
5
+ namespace service {
6
+ /**
7
+ * @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavType} instead.
8
+ *
9
+ * A static enumeration type which indicates the type of inbound navigation
10
+ */
11
+ enum NavType {
12
+ /**
13
+ * Back navigation with sap-iapp-state parameter
14
+ */
15
+ iAppState = "undefined",
16
+ /**
17
+ * Initial startup without any navigation or default parameters
18
+ */
19
+ initial = "undefined",
20
+ /**
21
+ * Basic cross-app navigation with URL parameters only (without sap-xapp-state) or initial start with default
22
+ * parameters
23
+ */
24
+ URLParams = "undefined",
25
+ /**
26
+ * Cross-app navigation with sap-xapp-state parameter (and URL parameters), defaulted parameters may be
27
+ * added
28
+ */
29
+ xAppState = "undefined",
30
+ }
31
+ /**
32
+ * @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.ParamHandlingMode} instead.
33
+ *
34
+ * A static enumeration type which indicates the conflict resolution method when merging URL parameters
35
+ * into select options
36
+ */
37
+ enum ParamHandlingMode {
38
+ /**
39
+ * The conflict resolution adds URL parameters to the SelectionVariant
40
+ */
41
+ InsertInSelOpt = "undefined",
42
+ /**
43
+ * The conflict resolution favors the SelectionVariant over URL parameters
44
+ */
45
+ SelVarWins = "undefined",
46
+ /**
47
+ * The conflict resolution favors the URL parameters over the SelectionVariant. Caution: In case of cross-app
48
+ * navigation a navigation parameter value from the source app is overwritten by a default, if a default
49
+ * is maintained in the launchpad designer for this parameter in the target app!
50
+ */
51
+ URLParamWins = "undefined",
52
+ }
53
+ /**
54
+ * @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SuppressionBehavior} instead.
55
+ *
56
+ * A static enumeration type which indicates whether semantic attributes with values `null`, `undefined`
57
+ * or `""` (empty string) shall be suppressed, before they are mixed in to the selection variant in the
58
+ * method {@link sap.ui.generic.app.navigation.service.NavigationHandler.mixAttributesAndSelectionVariant
59
+ * mixAttributesAndSelectionVariant} of the {@link sap.ui.generic.app.navigation.service.NavigationHandler
60
+ * NavigationHandler}
61
+ */
62
+ enum SuppressionBehavior {
63
+ /**
64
+ * Semantic attributes with an empty string are ignored, the remaining attributes are mixed in to the selection
65
+ * variant. Warning! Consider the impact on Boolean variable values!
66
+ */
67
+ ignoreEmptyString = "undefined",
68
+ /**
69
+ * Semantic attributes with a `null` value lead to an {@link sap.fin.central.lib.error.Error error} of type
70
+ * NavigationHandler.INVALID_INPUT
71
+ */
72
+ raiseErrorOnNull = "undefined",
73
+ /**
74
+ * Semantic attributes with an `undefined` value lead to an {@link sap.fin.central.lib.error.Error error}
75
+ * of type NavigationHandler.INVALID_INPUT
76
+ */
77
+ raiseErrorOnUndefined = "undefined",
78
+ /**
79
+ * Standard suppression behavior: semantic attributes with a `null` or an `undefined` value are ignored,
80
+ * the remaining attributes are mixed in to the selection variant
81
+ */
82
+ standard = "undefined",
83
+ }
84
+ }
85
+ }
86
+ }
87
+
88
+ declare module "sap/ui/generic/app/ApplicationController" {
89
+ import BaseController from "sap/ui/generic/app/transaction/BaseController";
90
+
91
+ import ODataModel from "sap/ui/model/odata/v2/ODataModel";
92
+
93
+ import View from "sap/ui/core/mvc/View";
94
+
95
+ import Context from "sap/ui/model/Context";
96
+
97
+ import Metadata from "sap/ui/base/Metadata";
98
+
99
+ import TransactionController from "sap/ui/generic/app/transaction/TransactionController";
100
+
101
+ /**
102
+ * @SINCE 1.32.0
103
+ * @EXPERIMENTAL (since 1.32.0)
104
+ *
105
+ * Application Controller.
106
+ */
107
+ export default class ApplicationController extends BaseController {
108
+ /**
109
+ * Constructor for application controller.
110
+ */
111
+ constructor(
112
+ /**
113
+ * The OData model currently used
114
+ */
115
+ oModel: ODataModel,
116
+ /**
117
+ * The current view
118
+ */
119
+ oView: View
120
+ );
121
+
122
+ /**
123
+ * Creates a new subclass of class sap.ui.generic.app.ApplicationController with name `sClassName` and enriches
124
+ * it with the information contained in `oClassInfo`.
125
+ *
126
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
127
+ *
128
+ * @returns Created class / constructor function
129
+ */
130
+ static extend<T extends Record<string, unknown>>(
131
+ /**
132
+ * Name of the class being created
133
+ */
134
+ sClassName: string,
135
+ /**
136
+ * Object literal with information about the class
137
+ */
138
+ oClassInfo?: sap.ClassInfo<T, ApplicationController>,
139
+ /**
140
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
141
+ * used by this class
142
+ */
143
+ FNMetaImpl?: Function
144
+ ): Function;
145
+ /**
146
+ * Returns a metadata object for class sap.ui.generic.app.ApplicationController.
147
+ *
148
+ * @returns Metadata object describing this class
149
+ */
150
+ static getMetadata(): Metadata;
151
+ /**
152
+ * @EXPERIMENTAL (since 1.32.0)
153
+ *
154
+ * Frees all resources claimed during the life-time of this instance.
155
+ */
156
+ destroy(): void;
157
+ /**
158
+ * Executes annotated side effects for properties/navigation properties or navigation entities. If no properties
159
+ * or entities are passed then the global side effect (the one without source properties and source entities)
160
+ * will be executed. PreparationAction will be called if there is no global side effect annotation available
161
+ * or if no trigger action is configured in the global side effect.
162
+ *
163
+ * @returns A `Promise` for asynchronous execution of the action. The promise is either already resolved
164
+ * (when nothing needs to be processed) or resolves when the `triggerSubmitChanges()` has been executed.
165
+ */
166
+ executeSideEffects(
167
+ /**
168
+ * The given binding context
169
+ */
170
+ oContext: Context,
171
+ /**
172
+ * An array of properties of the given context or properties in a 1:1 association for those side effects
173
+ * shall be executed. Can be `undefined`.
174
+ */
175
+ aSourceProperties: any[],
176
+ /**
177
+ * An array of entities (navigation properties) with the side effects that shall be executed. Can be `undefined`.
178
+ */
179
+ aSourceEntities: any[],
180
+ /**
181
+ * If not explicitly set to `false` a global model refresh is triggered.
182
+ */
183
+ bForceGlobalRefresh: boolean,
184
+ /**
185
+ * Parameters to control the draft preparation
186
+ */
187
+ mAdditionalParameters: Record<string, any>
188
+ ): Promise<any>;
189
+ /**
190
+ * @SINCE 1.38
191
+ * @EXPERIMENTAL
192
+ *
193
+ * Creates a context for an action call (OData function import)
194
+ *
195
+ * @returns A `map` that contains two Promises: `context` which provides the action-specific model context
196
+ * to the resolve function `result` which resolves when the success handler is called and rejects when the
197
+ * error handler is called; The result of the promises is normalized in both cases, error and success.
198
+ */
199
+ getNewActionContext(
200
+ /**
201
+ * Name of the function import that shall be triggered.
202
+ */
203
+ sFunctionName: string,
204
+ /**
205
+ * The given binding context of the object on which the action is called.
206
+ */
207
+ oEntityContext: object,
208
+ /**
209
+ * Parameters to control the behavior of the request.
210
+ */
211
+ mParameters: Record<string, any>
212
+ ): Record<string, any>;
213
+ /**
214
+ * Returns the current transaction controller instance.
215
+ *
216
+ * @returns The transaction controller instance
217
+ */
218
+ getTransactionController(): TransactionController;
219
+ /**
220
+ * Invokes an action for every provided context where the properties are taken as input from. The changes
221
+ * are submitted directly to the back-end.
222
+ *
223
+ * @returns A `Promise` for asynchronous execution of the action
224
+ */
225
+ invokeActions(
226
+ /**
227
+ * The name of the function or action that shall be triggered.
228
+ */
229
+ sFunctionName: string,
230
+ /**
231
+ * The given binding contexts where the parameters of the action shall be filled from.
232
+ */
233
+ aContexts: any[],
234
+ /**
235
+ * Parameters to control the behavior of the request.
236
+ */
237
+ mParameters: {
238
+ /**
239
+ * Property denotes how invocations of the same action on multiple instances are grouped. This is an optional
240
+ * parameter. If parameter set to "com.sap.vocabularies.UI.v1.OperationGroupingType/ChangeSet" every action
241
+ * call is sent in same changeset else a new changeset. Default value of this property is set to "com.sap.vocabularies.UI.v1.OperationGroupingType/Isolated".
242
+ */
243
+ operationGrouping: string;
244
+ }
245
+ ): Promise<any>;
246
+ /**
247
+ * @EXPERIMENTAL (since 1.32.0)
248
+ *
249
+ * Notifies the application controller of a change of a property. Please note that the method is not meant
250
+ * for productive use currently. It is experimental.
251
+ *
252
+ * @returns A `Promise` for asynchronous execution of the action
253
+ */
254
+ propertyChanged(
255
+ /**
256
+ * The path to the changed property
257
+ */
258
+ sPath: string,
259
+ /**
260
+ * The binding context in which the change occurred
261
+ */
262
+ oContext: object
263
+ ): Promise<any>;
264
+ /**
265
+ * @EXPERIMENTAL (since 1.32.0)
266
+ *
267
+ * Registers a change for the given group id.
268
+ */
269
+ registerGroupChange(
270
+ /**
271
+ * The group id where changes were done
272
+ */
273
+ sGroupId: string
274
+ ): void;
275
+ /**
276
+ * @EXPERIMENTAL (since 1.32.0)
277
+ *
278
+ * Registers the given view with the Application Controller.
279
+ */
280
+ registerView(
281
+ /**
282
+ * The view to be registered
283
+ */
284
+ oView: View
285
+ ): void;
286
+ }
287
+ }
288
+
289
+ declare module "sap/ui/generic/app/navigation/service/NavError" {
290
+ import Metadata from "sap/ui/base/Metadata";
291
+
292
+ /**
293
+ * @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavError} instead.
294
+ *
295
+ * An object that provides error handling information during runtime.
296
+ */
297
+ export default class NavError
298
+ /* was: sap.fe.navigation.NavError */ extends Object {
299
+ /**
300
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
301
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
302
+ * of the syntax of the settings object.
303
+ *
304
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.fe.navigation.NavError#constructor
305
+ * sap.fe.navigation.NavError} can be used.
306
+ */
307
+ constructor(
308
+ /**
309
+ * The code for an internal error of a consumer that allows you to track the source locations
310
+ */
311
+ sErrorCode: string
312
+ );
313
+
314
+ /**
315
+ * Creates a new subclass of class sap.ui.generic.app.navigation.service.NavError with name `sClassName`
316
+ * and enriches it with the information contained in `oClassInfo`.
317
+ *
318
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.NavError.extend}.
319
+ *
320
+ * @returns Created class / constructor function
321
+ */
322
+ static extend<T extends Record<string, unknown>>(
323
+ /**
324
+ * Name of the class being created
325
+ */
326
+ sClassName: string,
327
+ /**
328
+ * Object literal with information about the class
329
+ */
330
+ oClassInfo?: sap.ClassInfo<T, NavError>,
331
+ /**
332
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
333
+ * used by this class
334
+ */
335
+ FNMetaImpl?: Function
336
+ ): Function;
337
+ /**
338
+ * Returns a metadata object for class sap.ui.generic.app.navigation.service.NavError.
339
+ *
340
+ * @returns Metadata object describing this class
341
+ */
342
+ static getMetadata(): Metadata;
343
+ /**
344
+ * @deprecated (since 1.83.0)
345
+ *
346
+ * Returns the error code with which the instance has been created.
347
+ *
348
+ * @returns The error code of the error
349
+ */
350
+ getErrorCode(): string;
351
+ }
352
+ }
353
+
354
+ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
355
+ import ODataModel from "sap/ui/model/odata/v2/ODataModel";
356
+
357
+ import Metadata from "sap/ui/base/Metadata";
358
+
359
+ /**
360
+ * @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavigationHandler} instead.
361
+ *
362
+ * Creates a new NavigationHandler class by providing the required environment.
363
+ * The `NavigationHandler` supports the verification of sensitive information. All properties that are
364
+ * part of `selectionVariant` and `valueTexts` will be verified if they are annotated as `com.sap.vocabularies.PersonalData.v1.IsPotentiallySensitive`
365
+ * or `com.sap.vocabularies.UI.v1.ExcludeFromNavigationContext` and will be removed before the data is persisted
366
+ * as the app state.
367
+ * Also, all properties annotated as `com.sap.vocabularies.Analytics.v1.Measure` will be removed from the
368
+ * data stored as the xapp state.
369
+ * To verify the information to be removed, the `NavigationHandler` requires an unnamed model of type {@link
370
+ * sap.ui.model.odata.v2.ODataModel} on component level. It is possible to set such a model using the `setModel`
371
+ * method.
372
+ * **Note:** The check for excluded data requires that the OData metadata has already been loaded completely.
373
+ * If the OData metadata model has not been loaded completely, all properties are removed from the application
374
+ * context.
375
+ * **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation}
376
+ * is available and initialized.
377
+ */
378
+ export default class NavigationHandler
379
+ /* was: sap.fe.navigation.NavigationHandler */ extends Object {
380
+ constructor(
381
+ /**
382
+ * UI5 controller that contains a router and a component; typically the main controller of your application,
383
+ * for example, a subclass of the sap.ca.scfld.md.controller.BaseFullscreenController if scaffolding is
384
+ * used
385
+ */
386
+ oController: object,
387
+ /**
388
+ * Mode to be used to handle conflicts when merging URL parameters and the SelectionVariant class, see {@link
389
+ * sap.ui.generic.app.navigation.service.ParamHandlingMode}
390
+ */
391
+ sParamHandlingMode?: string
392
+ );
393
+
394
+ /**
395
+ * @SINCE 1.60.2
396
+ * @deprecated (since 1.83.0)
397
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
398
+ *
399
+ * The method creates a context url based on provided data. This context url can either be used as {@link
400
+ * sap.ui.generic.app.navigation.service.NavigationHandler#setParameterContextUrl ParameterContextUrl} or
401
+ * {@link sap.ui.generic.app.navigation.service.NavigationHandler#setFilterContextUrl FilterContextUrl}
402
+ *
403
+ * @returns context url for the given entities
404
+ */
405
+ static constructContextUrl(
406
+ /**
407
+ * used for url determination
408
+ */
409
+ sEntitySetName: string,
410
+ /**
411
+ * used for url determination. If omitted, the NavigationHandler model is used.
412
+ */
413
+ oModel?: ODataModel
414
+ ): string;
415
+ /**
416
+ * Creates a new subclass of class sap.ui.generic.app.navigation.service.NavigationHandler with name `sClassName`
417
+ * and enriches it with the information contained in `oClassInfo`.
418
+ *
419
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.NavigationHandler.extend}.
420
+ *
421
+ * @returns Created class / constructor function
422
+ */
423
+ static extend<T extends Record<string, unknown>>(
424
+ /**
425
+ * Name of the class being created
426
+ */
427
+ sClassName: string,
428
+ /**
429
+ * Object literal with information about the class
430
+ */
431
+ oClassInfo?: sap.ClassInfo<T, NavigationHandler>,
432
+ /**
433
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
434
+ * used by this class
435
+ */
436
+ FNMetaImpl?: Function
437
+ ): Function;
438
+ /**
439
+ * Returns a metadata object for class sap.ui.generic.app.navigation.service.NavigationHandler.
440
+ *
441
+ * @returns Metadata object describing this class
442
+ */
443
+ static getMetadata(): Metadata;
444
+ /**
445
+ * @deprecated (since 1.83.0)
446
+ *
447
+ * Gets the application specific technical parameters. Technical parameters will not be added to the selection
448
+ * variant passed to the application. As a default the following values are considered as technical parameters:
449
+ *
450
+ * - `sap-system`
451
+ * - `sap-ushell-defaultedParameterNames`
452
+ * - `"hcpApplicationId"`
453
+ *
454
+ * @returns Containing the technical parameters.
455
+ */
456
+ static getTechnicalParameters(): any[];
457
+ /**
458
+ * @deprecated (since 1.83.0)
459
+ *
460
+ * Combines the given parameters and selection variant into a new selection variant containing properties
461
+ * from both, with the parameters overriding existing properties in the selection variant. The new selection
462
+ * variant does not contain any parameters. All parameters are merged into select options. The output of
463
+ * this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate}
464
+ * method.
465
+ *
466
+ * @returns Instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
467
+ */
468
+ static mixAttributesAndSelectionVariant(
469
+ /**
470
+ * Object containing key/value pairs
471
+ */
472
+ mSemanticAttributes: object,
473
+ /**
474
+ * The selection variant in string format as provided by the SmartFilterBar control
475
+ */
476
+ sSelectionVariant: string,
477
+ /**
478
+ * Indicates whether semantic attributes with special values (see {@link sap.ui.generic.app.navigation.service.SuppressionBehavior
479
+ * suppression behavior}) must be suppressed before they are combined with the selection variant; several
480
+ * {@link sap.ui.generic.app.navigation.service.SuppressionBehavior suppression behaviors} can be combined
481
+ * with the bitwise OR operator (|)
482
+ */
483
+ iSuppressionBehavior?: int
484
+ ): object;
485
+ /**
486
+ * @deprecated (since 1.83.0) -
487
+ * **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
488
+ * based on the `oInnerAppData` data.
489
+ * SmartFilterBar control **Parameters:** {object} **oError**
490
+ * Error object (instance of {@link sap.ui.generic.app.navigation.service.NavError}) that describes
491
+ * which kind of error occurred {string} **oError.errorCode**
492
+ * Code to identify the error {string} **oError.type** Severity
493
+ * of the error (info/warning/error) {array} **oError.params**
494
+ * An array of objects (typically strings) that describe additional value parameters required for generating
495
+ * the message
496
+ *
497
+ * Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
498
+ * mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
499
+ * will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
500
+ * default navigation for opening a URL in-place or ex-place.
501
+ */
502
+ static navigate(
503
+ /**
504
+ * Name of the semantic object of the target app
505
+ */
506
+ sSemanticObject: string,
507
+ /**
508
+ * Name of the action of the target app
509
+ */
510
+ sActionName: string,
511
+ /**
512
+ * Navigation parameters as an object with key/value pairs or as a string representation of such an object.
513
+ * If passed as an object, the properties are not checked against the `IsPotentialSensitive` or `Measure`
514
+ * type.
515
+ */
516
+ vNavigationParameters: object | string,
517
+ /**
518
+ * Object for storing current state of the app
519
+ */
520
+ oInnerAppData: {
521
+ /**
522
+ * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
523
+ */
524
+ selectionVariant?: string;
525
+ /**
526
+ * ID of the SmartTable variant
527
+ */
528
+ tableVariantId?: string;
529
+ /**
530
+ * Object that can be used to store arbitrary data
531
+ */
532
+ customData?: object;
533
+ /**
534
+ * Object containing the current ui state of the app
535
+ */
536
+ presentationVariant?: object;
537
+ /**
538
+ * Object containing value descriptions
539
+ */
540
+ valueTexts?: object;
541
+ /**
542
+ * Object containing semanticDates filter information
543
+ */
544
+ semanticDates?: object;
545
+ },
546
+ /**
547
+ * Callback that is called if an error occurs during navigation
548
+ */
549
+ fnOnError: Function,
550
+ /**
551
+ * Object for storing the state which will be forwarded to the target component.
552
+ */
553
+ oExternalAppData: {
554
+ /**
555
+ * Object containing the current ui state of the app which will be forwarded to the target component.
556
+ */
557
+ presentationVariant?: object;
558
+ /**
559
+ * Object containing value descriptions which will be forwarded to the target component.
560
+ */
561
+ valueTexts?: object;
562
+ /**
563
+ * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
564
+ * will be constructed based on the vNavigationParameters.
565
+ */
566
+ selectionVariant?: object;
567
+ },
568
+ /**
569
+ * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
570
+ * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
571
+ */
572
+ sNavMode?: string
573
+ ): void;
574
+ /**
575
+ * @deprecated (since 1.83.0) -
576
+ * **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
577
+ * based on the `oInnerAppData` data.
578
+ * SmartFilterBar control **Parameters:** {object} **oError**
579
+ * Error object (instance of {@link sap.ui.generic.app.navigation.service.NavError}) that describes
580
+ * which kind of error occurred {string} **oError.errorCode**
581
+ * Code to identify the error {string} **oError.type** Severity
582
+ * of the error (info/warning/error) {array} **oError.params**
583
+ * An array of objects (typically strings) that describe additional value parameters required for generating
584
+ * the message
585
+ *
586
+ * Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
587
+ * mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
588
+ * will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
589
+ * default navigation for opening a URL in-place or ex-place.
590
+ */
591
+ static navigate(
592
+ /**
593
+ * Name of the semantic object of the target app
594
+ */
595
+ sSemanticObject: string,
596
+ /**
597
+ * Name of the action of the target app
598
+ */
599
+ sActionName: string,
600
+ /**
601
+ * Navigation parameters as an object with key/value pairs or as a string representation of such an object.
602
+ * If passed as an object, the properties are not checked against the `IsPotentialSensitive` or `Measure`
603
+ * type.
604
+ */
605
+ vNavigationParameters: object | string,
606
+ /**
607
+ * Object for storing current state of the app
608
+ */
609
+ oInnerAppData: {
610
+ /**
611
+ * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
612
+ */
613
+ selectionVariant?: string;
614
+ /**
615
+ * ID of the SmartTable variant
616
+ */
617
+ tableVariantId?: string;
618
+ /**
619
+ * Object that can be used to store arbitrary data
620
+ */
621
+ customData?: object;
622
+ /**
623
+ * Object containing the current ui state of the app
624
+ */
625
+ presentationVariant?: object;
626
+ /**
627
+ * Object containing value descriptions
628
+ */
629
+ valueTexts?: object;
630
+ /**
631
+ * Object containing semanticDates filter information
632
+ */
633
+ semanticDates?: object;
634
+ },
635
+ /**
636
+ * Object for storing the state which will be forwarded to the target component.
637
+ */
638
+ oExternalAppData: {
639
+ /**
640
+ * Object containing the current ui state of the app which will be forwarded to the target component.
641
+ */
642
+ presentationVariant?: object;
643
+ /**
644
+ * Object containing value descriptions which will be forwarded to the target component.
645
+ */
646
+ valueTexts?: object;
647
+ /**
648
+ * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
649
+ * will be constructed based on the vNavigationParameters.
650
+ */
651
+ selectionVariant?: object;
652
+ },
653
+ /**
654
+ * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
655
+ * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
656
+ */
657
+ sNavMode?: string
658
+ ): void;
659
+ /**
660
+ * @deprecated (since 1.83.0) -
661
+ * **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
662
+ * based on the `oInnerAppData` data.
663
+ * SmartFilterBar control **Parameters:** {object} **oError**
664
+ * Error object (instance of {@link sap.ui.generic.app.navigation.service.NavError}) that describes
665
+ * which kind of error occurred {string} **oError.errorCode**
666
+ * Code to identify the error {string} **oError.type** Severity
667
+ * of the error (info/warning/error) {array} **oError.params**
668
+ * An array of objects (typically strings) that describe additional value parameters required for generating
669
+ * the message
670
+ *
671
+ * Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
672
+ * mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
673
+ * will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
674
+ * default navigation for opening a URL in-place or ex-place.
675
+ */
676
+ static navigate(
677
+ /**
678
+ * Name of the semantic object of the target app
679
+ */
680
+ sSemanticObject: string,
681
+ /**
682
+ * Name of the action of the target app
683
+ */
684
+ sActionName: string,
685
+ /**
686
+ * Navigation parameters as an object with key/value pairs or as a string representation of such an object.
687
+ * If passed as an object, the properties are not checked against the `IsPotentialSensitive` or `Measure`
688
+ * type.
689
+ */
690
+ vNavigationParameters: object | string,
691
+ /**
692
+ * Callback that is called if an error occurs during navigation
693
+ */
694
+ fnOnError: Function,
695
+ /**
696
+ * Object for storing the state which will be forwarded to the target component.
697
+ */
698
+ oExternalAppData: {
699
+ /**
700
+ * Object containing the current ui state of the app which will be forwarded to the target component.
701
+ */
702
+ presentationVariant?: object;
703
+ /**
704
+ * Object containing value descriptions which will be forwarded to the target component.
705
+ */
706
+ valueTexts?: object;
707
+ /**
708
+ * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
709
+ * will be constructed based on the vNavigationParameters.
710
+ */
711
+ selectionVariant?: object;
712
+ },
713
+ /**
714
+ * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
715
+ * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
716
+ */
717
+ sNavMode?: string
718
+ ): void;
719
+ /**
720
+ * @deprecated (since 1.83.0) -
721
+ * **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
722
+ * based on the `oInnerAppData` data.
723
+ * SmartFilterBar control **Parameters:** {object} **oError**
724
+ * Error object (instance of {@link sap.ui.generic.app.navigation.service.NavError}) that describes
725
+ * which kind of error occurred {string} **oError.errorCode**
726
+ * Code to identify the error {string} **oError.type** Severity
727
+ * of the error (info/warning/error) {array} **oError.params**
728
+ * An array of objects (typically strings) that describe additional value parameters required for generating
729
+ * the message
730
+ *
731
+ * Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
732
+ * mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
733
+ * will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
734
+ * default navigation for opening a URL in-place or ex-place.
735
+ */
736
+ static navigate(
737
+ /**
738
+ * Name of the semantic object of the target app
739
+ */
740
+ sSemanticObject: string,
741
+ /**
742
+ * Name of the action of the target app
743
+ */
744
+ sActionName: string,
745
+ /**
746
+ * Object for storing current state of the app
747
+ */
748
+ oInnerAppData: {
749
+ /**
750
+ * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
751
+ */
752
+ selectionVariant?: string;
753
+ /**
754
+ * ID of the SmartTable variant
755
+ */
756
+ tableVariantId?: string;
757
+ /**
758
+ * Object that can be used to store arbitrary data
759
+ */
760
+ customData?: object;
761
+ /**
762
+ * Object containing the current ui state of the app
763
+ */
764
+ presentationVariant?: object;
765
+ /**
766
+ * Object containing value descriptions
767
+ */
768
+ valueTexts?: object;
769
+ /**
770
+ * Object containing semanticDates filter information
771
+ */
772
+ semanticDates?: object;
773
+ },
774
+ /**
775
+ * Callback that is called if an error occurs during navigation
776
+ */
777
+ fnOnError: Function,
778
+ /**
779
+ * Object for storing the state which will be forwarded to the target component.
780
+ */
781
+ oExternalAppData: {
782
+ /**
783
+ * Object containing the current ui state of the app which will be forwarded to the target component.
784
+ */
785
+ presentationVariant?: object;
786
+ /**
787
+ * Object containing value descriptions which will be forwarded to the target component.
788
+ */
789
+ valueTexts?: object;
790
+ /**
791
+ * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
792
+ * will be constructed based on the vNavigationParameters.
793
+ */
794
+ selectionVariant?: object;
795
+ },
796
+ /**
797
+ * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
798
+ * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
799
+ */
800
+ sNavMode?: string
801
+ ): void;
802
+ /**
803
+ * @deprecated (since 1.83.0) -
804
+ * **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
805
+ * based on the `oInnerAppData` data.
806
+ * SmartFilterBar control **Parameters:** {object} **oError**
807
+ * Error object (instance of {@link sap.ui.generic.app.navigation.service.NavError}) that describes
808
+ * which kind of error occurred {string} **oError.errorCode**
809
+ * Code to identify the error {string} **oError.type** Severity
810
+ * of the error (info/warning/error) {array} **oError.params**
811
+ * An array of objects (typically strings) that describe additional value parameters required for generating
812
+ * the message
813
+ *
814
+ * Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
815
+ * mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
816
+ * will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
817
+ * default navigation for opening a URL in-place or ex-place.
818
+ */
819
+ static navigate(
820
+ /**
821
+ * Name of the semantic object of the target app
822
+ */
823
+ sSemanticObject: string,
824
+ /**
825
+ * Name of the action of the target app
826
+ */
827
+ sActionName: string,
828
+ /**
829
+ * Navigation parameters as an object with key/value pairs or as a string representation of such an object.
830
+ * If passed as an object, the properties are not checked against the `IsPotentialSensitive` or `Measure`
831
+ * type.
832
+ */
833
+ vNavigationParameters: object | string,
834
+ /**
835
+ * Object for storing the state which will be forwarded to the target component.
836
+ */
837
+ oExternalAppData: {
838
+ /**
839
+ * Object containing the current ui state of the app which will be forwarded to the target component.
840
+ */
841
+ presentationVariant?: object;
842
+ /**
843
+ * Object containing value descriptions which will be forwarded to the target component.
844
+ */
845
+ valueTexts?: object;
846
+ /**
847
+ * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
848
+ * will be constructed based on the vNavigationParameters.
849
+ */
850
+ selectionVariant?: object;
851
+ },
852
+ /**
853
+ * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
854
+ * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
855
+ */
856
+ sNavMode?: string
857
+ ): void;
858
+ /**
859
+ * @deprecated (since 1.83.0) -
860
+ * **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
861
+ * based on the `oInnerAppData` data.
862
+ * SmartFilterBar control **Parameters:** {object} **oError**
863
+ * Error object (instance of {@link sap.ui.generic.app.navigation.service.NavError}) that describes
864
+ * which kind of error occurred {string} **oError.errorCode**
865
+ * Code to identify the error {string} **oError.type** Severity
866
+ * of the error (info/warning/error) {array} **oError.params**
867
+ * An array of objects (typically strings) that describe additional value parameters required for generating
868
+ * the message
869
+ *
870
+ * Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
871
+ * mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
872
+ * will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
873
+ * default navigation for opening a URL in-place or ex-place.
874
+ */
875
+ static navigate(
876
+ /**
877
+ * Name of the semantic object of the target app
878
+ */
879
+ sSemanticObject: string,
880
+ /**
881
+ * Name of the action of the target app
882
+ */
883
+ sActionName: string,
884
+ /**
885
+ * Object for storing current state of the app
886
+ */
887
+ oInnerAppData: {
888
+ /**
889
+ * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
890
+ */
891
+ selectionVariant?: string;
892
+ /**
893
+ * ID of the SmartTable variant
894
+ */
895
+ tableVariantId?: string;
896
+ /**
897
+ * Object that can be used to store arbitrary data
898
+ */
899
+ customData?: object;
900
+ /**
901
+ * Object containing the current ui state of the app
902
+ */
903
+ presentationVariant?: object;
904
+ /**
905
+ * Object containing value descriptions
906
+ */
907
+ valueTexts?: object;
908
+ /**
909
+ * Object containing semanticDates filter information
910
+ */
911
+ semanticDates?: object;
912
+ },
913
+ /**
914
+ * Object for storing the state which will be forwarded to the target component.
915
+ */
916
+ oExternalAppData: {
917
+ /**
918
+ * Object containing the current ui state of the app which will be forwarded to the target component.
919
+ */
920
+ presentationVariant?: object;
921
+ /**
922
+ * Object containing value descriptions which will be forwarded to the target component.
923
+ */
924
+ valueTexts?: object;
925
+ /**
926
+ * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
927
+ * will be constructed based on the vNavigationParameters.
928
+ */
929
+ selectionVariant?: object;
930
+ },
931
+ /**
932
+ * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
933
+ * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
934
+ */
935
+ sNavMode?: string
936
+ ): void;
937
+ /**
938
+ * @deprecated (since 1.83.0) -
939
+ * **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
940
+ * based on the `oInnerAppData` data.
941
+ * SmartFilterBar control **Parameters:** {object} **oError**
942
+ * Error object (instance of {@link sap.ui.generic.app.navigation.service.NavError}) that describes
943
+ * which kind of error occurred {string} **oError.errorCode**
944
+ * Code to identify the error {string} **oError.type** Severity
945
+ * of the error (info/warning/error) {array} **oError.params**
946
+ * An array of objects (typically strings) that describe additional value parameters required for generating
947
+ * the message
948
+ *
949
+ * Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
950
+ * mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
951
+ * will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
952
+ * default navigation for opening a URL in-place or ex-place.
953
+ */
954
+ static navigate(
955
+ /**
956
+ * Name of the semantic object of the target app
957
+ */
958
+ sSemanticObject: string,
959
+ /**
960
+ * Name of the action of the target app
961
+ */
962
+ sActionName: string,
963
+ /**
964
+ * Callback that is called if an error occurs during navigation
965
+ */
966
+ fnOnError: Function,
967
+ /**
968
+ * Object for storing the state which will be forwarded to the target component.
969
+ */
970
+ oExternalAppData: {
971
+ /**
972
+ * Object containing the current ui state of the app which will be forwarded to the target component.
973
+ */
974
+ presentationVariant?: object;
975
+ /**
976
+ * Object containing value descriptions which will be forwarded to the target component.
977
+ */
978
+ valueTexts?: object;
979
+ /**
980
+ * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
981
+ * will be constructed based on the vNavigationParameters.
982
+ */
983
+ selectionVariant?: object;
984
+ },
985
+ /**
986
+ * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
987
+ * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
988
+ */
989
+ sNavMode?: string
990
+ ): void;
991
+ /**
992
+ * @deprecated (since 1.83.0) -
993
+ * **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
994
+ * based on the `oInnerAppData` data.
995
+ * SmartFilterBar control **Parameters:** {object} **oError**
996
+ * Error object (instance of {@link sap.ui.generic.app.navigation.service.NavError}) that describes
997
+ * which kind of error occurred {string} **oError.errorCode**
998
+ * Code to identify the error {string} **oError.type** Severity
999
+ * of the error (info/warning/error) {array} **oError.params**
1000
+ * An array of objects (typically strings) that describe additional value parameters required for generating
1001
+ * the message
1002
+ *
1003
+ * Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
1004
+ * mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
1005
+ * will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
1006
+ * default navigation for opening a URL in-place or ex-place.
1007
+ */
1008
+ static navigate(
1009
+ /**
1010
+ * Name of the semantic object of the target app
1011
+ */
1012
+ sSemanticObject: string,
1013
+ /**
1014
+ * Name of the action of the target app
1015
+ */
1016
+ sActionName: string,
1017
+ /**
1018
+ * Object for storing the state which will be forwarded to the target component.
1019
+ */
1020
+ oExternalAppData: {
1021
+ /**
1022
+ * Object containing the current ui state of the app which will be forwarded to the target component.
1023
+ */
1024
+ presentationVariant?: object;
1025
+ /**
1026
+ * Object containing value descriptions which will be forwarded to the target component.
1027
+ */
1028
+ valueTexts?: object;
1029
+ /**
1030
+ * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
1031
+ * will be constructed based on the vNavigationParameters.
1032
+ */
1033
+ selectionVariant?: object;
1034
+ },
1035
+ /**
1036
+ * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
1037
+ * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
1038
+ */
1039
+ sNavMode?: string
1040
+ ): void;
1041
+ /**
1042
+ * @deprecated (since 1.83.0)
1043
+ *
1044
+ * Parses the incoming URL and returns a Promise. If this method detects a back navigation, the inner app
1045
+ * state is returned in the resolved Promise. Otherwise startup parameters will be merged into the app state
1046
+ * provided by cross app navigation, and a combined app state will be returned. The conflict resolution
1047
+ * can be influenced with sParamHandlingMode defined in the constructor.
1048
+ *
1049
+ * @returns A Promise object to monitor when all the actions of the function have been executed. If the
1050
+ * execution is successful, the extracted app state, the startup parameters, and the type of navigation
1051
+ * are returned, see also the example above. The app state is an object that contains the following information:
1052
+ *
1053
+ * - `oAppData.oSelectionVariant`: An instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
1054
+ * containing only parameters/select options that are related to navigation
1055
+ * - `oAppData.selectionVariant`: The navigation-related selection variant as a JSON-formatted string
1056
+ *
1057
+ * - `oAppData.oDefaultedSelectionVariant`: An instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
1058
+ * containing only the parameters/select options that are set by user default data
1059
+ * - `oAppData.bNavSelVarHasDefaultsOnly`: A Boolean flag that indicates whether only defaulted parameters
1060
+ * and no navigation parameters are present.
1061
+ * **Note:** If no navigation parameters are available, `bNavSelVarHasDefaultsOnly` is set to `true`, even
1062
+ * though parameters without default might be available as well. If the navigation-related selection
1063
+ * variant is empty, it is replaced by a copy of the defaulted selection variant.
1064
+ * The navigation type is an enumeration type of type {@link sap.ui.generic.app.navigation.service.NavType}
1065
+ * (possible values are initial, URLParams, xAppState, and iAppState).
1066
+ * **Note:** If the navigation type is {@link sap.ui.generic.app.navigation.service.NavType.iAppState}
1067
+ * oAppData has two additional properties
1068
+ * - `oAppData.tableVariantId`
1069
+ * - `oAppData.customData` which return the inner app data as stored in {@link #.navigate navigate}
1070
+ * or {@link #.storeInnerAppState storeInnerAppState}. `oAppData.oDefaultedSelectionVariant` is an empty
1071
+ * selection variant and `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
1072
+ * **Note:** If the navigation type is {@link sap.ui.generic.app.navigation.service.NavType.initial} oAppData
1073
+ * is an empty object!
1074
+ * If an error occurs, an error object of type {@link sap.ui.generic.app.navigation.service.NavError},
1075
+ * URL parameters (if available) and the type of navigation are returned.
1076
+ */
1077
+ static parseNavigation(): object;
1078
+ /**
1079
+ * @deprecated (since 1.83.0) -
1080
+ * **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
1081
+ * based on the `mInnerAppData` data.
1082
+ *
1083
+ *
1084
+ * Processes navigation-related tasks related to beforePopoverOpens event handling for the SmartLink control
1085
+ * and returns a Promise object. In particular, the following tasks are performed before the SmartLink popover
1086
+ * can be opened:
1087
+ * - If `mInnerAppData` is provided, this inner app state is saved for back navigation at a later time.
1088
+ *
1089
+ * - The table event parameters (semantic attributes) and the selection variant data are combined by calling
1090
+ * the method {@link #.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant}.
1091
+ * - The combined data is saved as the cross app state to be handed over to the target app, and the corresponding
1092
+ * sap-xapp-state key is set in the URL.
1093
+ * - All single selections ("including equal") of the combined selection data are passed to the SmartLink
1094
+ * popover as semantic attributes.
1095
+ * - The method `oTableEventParameters.open()` is called. Note that this does not really open the popover,
1096
+ * but the SmartLink control proceeds with firing the event `navigationTargetsObtained`.
1097
+ *
1098
+ * @returns A Promise object to monitor when all actions of the function have been executed; if the execution
1099
+ * is successful, the modified oTableEventParameters is returned; if an error occurs, an error object of
1100
+ * type {@link sap.ui.generic.app.navigation.service.NavError} is returned
1101
+ */
1102
+ static processBeforeSmartLinkPopoverOpens(
1103
+ /**
1104
+ * The parameters made available by the SmartTable control when the SmartLink control has been clicked,
1105
+ * an instance of a PopOver object
1106
+ */
1107
+ oTableEventParameters: object,
1108
+ /**
1109
+ * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
1110
+ */
1111
+ sSelectionVariant: string,
1112
+ /**
1113
+ * Object containing the current state of the app. If provided, opening the Popover is deferred until the
1114
+ * inner app data is saved in a consistent way.
1115
+ */
1116
+ mInnerAppData?: {
1117
+ /**
1118
+ * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the the SmartFilterBar
1119
+ * control; if provided, the selection is merged into the semantic attributes
1120
+ */
1121
+ selectionVariant?: string;
1122
+ /**
1123
+ * ID of the SmartTable variant
1124
+ */
1125
+ tableVariantId?: string;
1126
+ /**
1127
+ * Object that can be used to store additional app-specific data
1128
+ */
1129
+ customData?: object;
1130
+ /**
1131
+ * Object containing the current ui presentationVariantof the app
1132
+ */
1133
+ presentationVariant?: object;
1134
+ /**
1135
+ * Object containing value descriptions
1136
+ */
1137
+ valueTexts?: object;
1138
+ /**
1139
+ * Object containing semanticDates filter information
1140
+ */
1141
+ semanticDates?: object;
1142
+ },
1143
+ /**
1144
+ * Object containing the state which will be passed to the target screen.
1145
+ */
1146
+ oExternalAppData?: {
1147
+ /**
1148
+ * Object containing selectionVariant, which will be passed to the target screen. If not set the sSelectionVariant
1149
+ * will be used.
1150
+ */
1151
+ selectionVariant?: object;
1152
+ /**
1153
+ * Object containing the current ui presentationVariant of the app, which will be passed to the target screen
1154
+ */
1155
+ presentationVariant?: object;
1156
+ /**
1157
+ * Object containing value descriptions, which will be passed to the target screen
1158
+ */
1159
+ valueTexts?: object;
1160
+ }
1161
+ ): object;
1162
+ /**
1163
+ * @deprecated (since 1.83.0)
1164
+ *
1165
+ * Changes the URL according to the current sAppStateKey. As an reaction route change event will be triggered.
1166
+ */
1167
+ static replaceHash(
1168
+ /**
1169
+ * the new app state key.
1170
+ */
1171
+ sAppStateKey: string
1172
+ ): void;
1173
+ /**
1174
+ * @SINCE 1.60.0
1175
+ * @deprecated (since 1.83.0)
1176
+ *
1177
+ * Sets the model that is used for verification of sensitive information. If the model is not set, the unnamed
1178
+ * component model is used for the verification of sensitive information.
1179
+ */
1180
+ static setModel(
1181
+ /**
1182
+ * for checking sensitive information
1183
+ */
1184
+ oModel: ODataModel
1185
+ ): void;
1186
+ /**
1187
+ * @deprecated (since 1.83.0)
1188
+ *
1189
+ * Sets the application specific technical parameters. Technical parameters will not be added to the selection
1190
+ * variant passed to the application. As a default the following values are considered as technical parameters:
1191
+ *
1192
+ * - `sap-system`
1193
+ * - `sap-ushell-defaultedParameterNames`
1194
+ * - `"hcpApplicationId"`
1195
+ */
1196
+ static setTechnicalParameters(
1197
+ /**
1198
+ * list of parameter names to be considered as technical parameters. `null` or `undefined` may be used to
1199
+ * reset the complete list.
1200
+ */
1201
+ aTechnicalParameters: any[]
1202
+ ): void;
1203
+ /**
1204
+ * @deprecated (since 1.83.0)
1205
+ *
1206
+ * Changes the URL according to the current app state and stores the app state for later retrieval.
1207
+ *
1208
+ * @returns A Promise object to monitor when all the actions of the function have been executed; if the
1209
+ * execution is successful, the app state key is returned; if an error occurs, an object of type {@link
1210
+ * sap.ui.generic.app.navigation.service.NavError} is returned
1211
+ */
1212
+ static storeInnerAppState(
1213
+ /**
1214
+ * Object containing the current state of the app
1215
+ */
1216
+ mInnerAppData: {
1217
+ /**
1218
+ * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
1219
+ */
1220
+ selectionVariant: string;
1221
+ /**
1222
+ * ID of the SmartTable variant
1223
+ */
1224
+ tableVariantId?: string;
1225
+ /**
1226
+ * Object that can be used to store additional app-specific data
1227
+ */
1228
+ customData?: object;
1229
+ /**
1230
+ * Object containing the current ui state of the app
1231
+ */
1232
+ presentationVariant?: object;
1233
+ /**
1234
+ * Object containing value descriptions
1235
+ */
1236
+ valueTexts?: object;
1237
+ /**
1238
+ * Object containing semanticDates filter information
1239
+ */
1240
+ semanticDates?: object;
1241
+ },
1242
+ /**
1243
+ * If set to false, the inner app hash will not be replaced until storing is successful; do not set to false
1244
+ * if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed
1245
+ * event
1246
+ */
1247
+ bImmediateHashReplace?: boolean
1248
+ ): object;
1249
+ /**
1250
+ * @deprecated (since 1.83.0)
1251
+ *
1252
+ * Changes the URL according to the current app state and stores the app state for later retrieval.
1253
+ *
1254
+ * @returns An object containing the appStateId and a promise object to monitor when all the actions of
1255
+ * the function have been executed; Please note that the appStateKey may be undefined or empty.
1256
+ */
1257
+ static storeInnerAppStateWithImmediateReturn(
1258
+ /**
1259
+ * Object containing the current state of the app
1260
+ */
1261
+ mInnerAppData: {
1262
+ /**
1263
+ * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
1264
+ */
1265
+ selectionVariant: string;
1266
+ /**
1267
+ * ID of the SmartTable variant
1268
+ */
1269
+ tableVariantId?: string;
1270
+ /**
1271
+ * Object that can be used to store additional app-specific data
1272
+ */
1273
+ customData?: object;
1274
+ /**
1275
+ * Object containing the current ui state of the app
1276
+ */
1277
+ presentationVariant?: object;
1278
+ /**
1279
+ * Object containing value descriptions
1280
+ */
1281
+ valueTexts?: object;
1282
+ /**
1283
+ * Object containing semanticDates filter information
1284
+ */
1285
+ semanticDates?: object;
1286
+ },
1287
+ /**
1288
+ * If set to false, the inner app hash will not be replaced until storing is successful; do not set to false
1289
+ * if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed
1290
+ * event. **Note:**If not provided it will be treated as set to false. **Note:**If set to true, the calling
1291
+ * instance has to ensure that a follow-on call to `replaceHash` will take place!
1292
+ */
1293
+ bImmediateHashReplace?: boolean
1294
+ ): Object;
1295
+ }
1296
+ }
1297
+
1298
+ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
1299
+ import Metadata from "sap/ui/base/Metadata";
1300
+
1301
+ /**
1302
+ * @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.PresentationVariant} instead.
1303
+ *
1304
+ * Creates a new instance of a PresentationVariant class. If no parameter is passed, an new empty instance
1305
+ * is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
1306
+ * Variant Specification will parse it, and the newly created instance will contain the same information.
1307
+ */
1308
+ export default class PresentationVariant
1309
+ /* was: sap.fe.navigation.PresentationVariant */ extends Object {
1310
+ constructor(
1311
+ /**
1312
+ * If of type `string`, the selection variant is JSON-formatted; if of type `object`, the object represents
1313
+ * a selection variant
1314
+ */
1315
+ vPresentationVariant?: string | object
1316
+ );
1317
+
1318
+ /**
1319
+ * Creates a new subclass of class sap.ui.generic.app.navigation.service.PresentationVariant with name `sClassName`
1320
+ * and enriches it with the information contained in `oClassInfo`.
1321
+ *
1322
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.PresentationVariant.extend}.
1323
+ *
1324
+ * @returns Created class / constructor function
1325
+ */
1326
+ static extend<T extends Record<string, unknown>>(
1327
+ /**
1328
+ * Name of the class being created
1329
+ */
1330
+ sClassName: string,
1331
+ /**
1332
+ * Object literal with information about the class
1333
+ */
1334
+ oClassInfo?: sap.ClassInfo<T, PresentationVariant>,
1335
+ /**
1336
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1337
+ * used by this class
1338
+ */
1339
+ FNMetaImpl?: Function
1340
+ ): Function;
1341
+ /**
1342
+ * @deprecated (since 1.83.0)
1343
+ *
1344
+ * Gets the chart visualization property.
1345
+ *
1346
+ * @returns mProperties to be used for the chart visualization.
1347
+ */
1348
+ static getChartVisualization(): Record<string, any>;
1349
+ /**
1350
+ * @deprecated (since 1.83.0)
1351
+ *
1352
+ * Gets the current context URL intended for the query.
1353
+ *
1354
+ * @returns The current context URL for the query
1355
+ */
1356
+ static getContextUrl(): string;
1357
+ /**
1358
+ * @deprecated (since 1.83.0)
1359
+ *
1360
+ * Returns the identification of the selection variant.
1361
+ *
1362
+ * @returns The identification of the selection variant as made available during construction
1363
+ */
1364
+ static getID(): string;
1365
+ /**
1366
+ * Returns a metadata object for class sap.ui.generic.app.navigation.service.PresentationVariant.
1367
+ *
1368
+ * @returns Metadata object describing this class
1369
+ */
1370
+ static getMetadata(): Metadata;
1371
+ /**
1372
+ * @deprecated (since 1.83.0)
1373
+ *
1374
+ * Gets the more trivial properties. Basically all properties with the exception of the Visualization.
1375
+ *
1376
+ * @returns The current properties.
1377
+ */
1378
+ static getProperties(): Record<string, any>;
1379
+ /**
1380
+ * @deprecated (since 1.83.0)
1381
+ *
1382
+ * Gets the table visualization property.
1383
+ *
1384
+ * @returns mProperties to be used for the table visualization.
1385
+ */
1386
+ static getTableVisualization(): Record<string, any>;
1387
+ /**
1388
+ * @deprecated (since 1.83.0)
1389
+ *
1390
+ * Returns the current text / description of this selection variant.
1391
+ *
1392
+ * @returns the current description of this selection variant.
1393
+ */
1394
+ static getText(): string;
1395
+ /**
1396
+ * @deprecated (since 1.83.0)
1397
+ *
1398
+ * Returns `true` if the presentation variant does not contain any properties. nor ranges.
1399
+ *
1400
+ * @returns If set to `true` there are no current properties set; `false` otherwise.
1401
+ */
1402
+ static isEmpty(): boolean;
1403
+ /**
1404
+ * @deprecated (since 1.83.0)
1405
+ *
1406
+ * Sets the chart visualization property.
1407
+ */
1408
+ static setChartVisualization(
1409
+ /**
1410
+ * to be used for the chart visualization.
1411
+ */
1412
+ mProperties: Record<string, any>
1413
+ ): void;
1414
+ /**
1415
+ * @deprecated (since 1.83.0)
1416
+ *
1417
+ * Sets the context URL.
1418
+ */
1419
+ static setContextUrl(
1420
+ /**
1421
+ * The URL of the context
1422
+ */
1423
+ sURL: string
1424
+ ): void;
1425
+ /**
1426
+ * @deprecated (since 1.83.0)
1427
+ *
1428
+ * Sets the identification of the selection variant.
1429
+ */
1430
+ static setID(
1431
+ /**
1432
+ * The new identification of the selection variant
1433
+ */
1434
+ sId: string
1435
+ ): void;
1436
+ /**
1437
+ * @deprecated (since 1.83.0)
1438
+ *
1439
+ * Sets the more trivial properties. Basically all properties with the exception of the Visualization.
1440
+ */
1441
+ static setProperties(
1442
+ /**
1443
+ * properties to be used.
1444
+ */
1445
+ mProperties: Record<string, any>
1446
+ ): void;
1447
+ /**
1448
+ * @deprecated (since 1.83.0)
1449
+ *
1450
+ * Sets the table visualization property.
1451
+ */
1452
+ static setTableVisualization(
1453
+ /**
1454
+ * to be used for the table visualization.
1455
+ */
1456
+ mProperties: Record<string, any>
1457
+ ): void;
1458
+ /**
1459
+ * @deprecated (since 1.83.0)
1460
+ *
1461
+ * Sets the text / description of the selection variant.
1462
+ */
1463
+ static setText(
1464
+ /**
1465
+ * The new description to be used
1466
+ */
1467
+ sNewText: string
1468
+ ): void;
1469
+ /**
1470
+ * @deprecated (since 1.83.0)
1471
+ *
1472
+ * Returns the external representation of the selection variant as JSON object.
1473
+ *
1474
+ * @returns The external representation of this instance as a JSON object
1475
+ */
1476
+ static toJSONObject(): object;
1477
+ /**
1478
+ * @deprecated (since 1.83.0)
1479
+ *
1480
+ * Serializes this instance into a JSON-formatted string.
1481
+ *
1482
+ * @returns The JSON-formatted representation of this instance in stringified format
1483
+ */
1484
+ static toJSONString(): string;
1485
+ }
1486
+ }
1487
+
1488
+ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
1489
+ import Metadata from "sap/ui/base/Metadata";
1490
+
1491
+ /**
1492
+ * @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SelectionVariant} instead.
1493
+ *
1494
+ * Creates a new instance of a SelectionVariant class. If no parameter is passed, an new empty instance
1495
+ * is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
1496
+ * Variant Specification will parse it, and the newly created instance will contain the same information.
1497
+ */
1498
+ export default class SelectionVariant
1499
+ /* was: sap.fe.navigation.SelectionVariant */ extends Object {
1500
+ constructor(
1501
+ /**
1502
+ * If of type `string`, the selection variant is JSON-formatted; if of type `object`, the object represents
1503
+ * a selection variant
1504
+ */
1505
+ vSelectionVariant?: string | object
1506
+ );
1507
+
1508
+ /**
1509
+ * @deprecated (since 1.83.0)
1510
+ *
1511
+ * Sets the value of a parameter called `sName` to the new value `sValue`. If the parameter has already
1512
+ * been set before, its value is overwritten.
1513
+ *
1514
+ * @returns This instance to allow method chaining
1515
+ */
1516
+ static addParameter(
1517
+ /**
1518
+ * The name of the parameter to be set; the `null` value is not allowed
1519
+ */
1520
+ sName: string,
1521
+ /**
1522
+ * The value of the parameter to be set
1523
+ */
1524
+ sValue: string
1525
+ ): object;
1526
+ /**
1527
+ * @deprecated (since 1.83.0)
1528
+ *
1529
+ * Adds a new range to the list of select options for a given parameter.
1530
+ *
1531
+ * @returns This instance to allow method chaining.
1532
+ */
1533
+ static addSelectOption(
1534
+ /**
1535
+ * The name of the property for which the selection range is added
1536
+ */
1537
+ sPropertyName: string,
1538
+ /**
1539
+ * The sign of the range (**I**nclude or **E**xclude)
1540
+ */
1541
+ sSign: string,
1542
+ /**
1543
+ * The option of the range (**EQ** for "equals", **NE** for "not equals", **LE** for "less or equals", **GE**
1544
+ * for "greater or equals", **LT** for "less than" (and not equals), **GT** for "greater than" (and not
1545
+ * equals), **BT** for "between", or **CP** for "contains pattern" (ABAP-styled pattern matching with the
1546
+ * asterisk as wildcard)
1547
+ */
1548
+ sOption: string,
1549
+ /**
1550
+ * The single value or the lower boundary of the interval; the `null` value is not allowed
1551
+ */
1552
+ sLow: string,
1553
+ /**
1554
+ * Set only if sOption is **BT**: the upper boundary of the interval; must be `undefined` or `null` in all
1555
+ * other cases
1556
+ */
1557
+ sHigh?: string
1558
+ ): object;
1559
+ /**
1560
+ * Creates a new subclass of class sap.ui.generic.app.navigation.service.SelectionVariant with name `sClassName`
1561
+ * and enriches it with the information contained in `oClassInfo`.
1562
+ *
1563
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.SelectionVariant.extend}.
1564
+ *
1565
+ * @returns Created class / constructor function
1566
+ */
1567
+ static extend<T extends Record<string, unknown>>(
1568
+ /**
1569
+ * Name of the class being created
1570
+ */
1571
+ sClassName: string,
1572
+ /**
1573
+ * Object literal with information about the class
1574
+ */
1575
+ oClassInfo?: sap.ClassInfo<T, SelectionVariant>,
1576
+ /**
1577
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1578
+ * used by this class
1579
+ */
1580
+ FNMetaImpl?: Function
1581
+ ): Function;
1582
+ /**
1583
+ * @deprecated (since 1.83.0)
1584
+ *
1585
+ * Gets the current context URL intended for the filters.
1586
+ *
1587
+ * @returns The current context URL for the filters
1588
+ */
1589
+ static getFilterContextUrl(): string;
1590
+ /**
1591
+ * @deprecated (since 1.83.0)
1592
+ *
1593
+ * Returns the identification of the selection variant.
1594
+ *
1595
+ * @returns The identification of the selection variant as made available during construction
1596
+ */
1597
+ static getID(): string;
1598
+ /**
1599
+ * Returns a metadata object for class sap.ui.generic.app.navigation.service.SelectionVariant.
1600
+ *
1601
+ * @returns Metadata object describing this class
1602
+ */
1603
+ static getMetadata(): Metadata;
1604
+ /**
1605
+ * @deprecated (since 1.83.0)
1606
+ *
1607
+ * Returns the value of the parameter called `sName` if it has been set. If the parameter has never been
1608
+ * set or has been removed, `undefined` is returned.
1609
+ *
1610
+ * @returns The value of parameter `sName`; returning the value `null` not possible
1611
+ */
1612
+ static getParameter(
1613
+ /**
1614
+ * The name of the parameter to be returned
1615
+ */
1616
+ sName: string
1617
+ ): string;
1618
+ /**
1619
+ * @deprecated (since 1.83.0)
1620
+ *
1621
+ * Gets the current context URL intended for the parameters.
1622
+ *
1623
+ * @returns The current context URL for the parameters
1624
+ */
1625
+ static getParameterContextUrl(): string;
1626
+ /**
1627
+ * @deprecated (since 1.83.0)
1628
+ *
1629
+ * Returns the set of parameter names available in this selection variant
1630
+ *
1631
+ * @returns the list of parameter names which are valid
1632
+ */
1633
+ static getParameterNames(): any[];
1634
+ /**
1635
+ * @deprecated (since 1.83.0)
1636
+ *
1637
+ * Returns the names of the parameter and select option properties available for this instance.
1638
+ *
1639
+ * @returns The list of parameter and select option property names available for this instance
1640
+ */
1641
+ static getPropertyNames(): any[];
1642
+ /**
1643
+ * @deprecated (since 1.83.0)
1644
+ *
1645
+ * Returns the set of select options/ranges available for a given property name.
1646
+ *
1647
+ * @returns If `sPropertyName` is an invalid name of a property or no range exists, `undefined` is returned;
1648
+ * otherwise, an immutable array of ranges is returned. Each entry of the array is an object with the following
1649
+ * properties:
1650
+ * - `Sign`: The sign of the range
1651
+ * - `Option`: The option of the range
1652
+ * - `Low`: The low value of the range; returning value `null` is not possible
1653
+ * - `High`: The high value of the range; if this value is not necessary, `null` is used For further
1654
+ * information about the meaning of the attributes, refer to method `addSelectOption`.
1655
+ */
1656
+ static getSelectOption(
1657
+ /**
1658
+ * The name of the property for which the set of select options/ranges is returned
1659
+ */
1660
+ sPropertyName: string
1661
+ ): any[];
1662
+ /**
1663
+ * @deprecated (since 1.83.0)
1664
+ *
1665
+ * Returns the names of the properties available for this instance.
1666
+ *
1667
+ * @returns The list of property names available for this instance
1668
+ */
1669
+ static getSelectOptionsPropertyNames(): any[];
1670
+ /**
1671
+ * @deprecated (since 1.83.0)
1672
+ *
1673
+ * Returns the current text / description of this selection variant.
1674
+ *
1675
+ * @returns the current description of this selection variant.
1676
+ */
1677
+ static getText(): string;
1678
+ /**
1679
+ * @deprecated (since 1.83.0)
1680
+ *
1681
+ * First tries to retrieve the set of select options/ranges available for `sName` as property name. If successful,
1682
+ * this array of selections is being returned. If it fails, an attempt to find a parameter, whose name is
1683
+ * `sName`, is made. If the latter succeeds, the single value is converted to fit into an array of selections
1684
+ * to make it type compatible with ranges. This array is then returned. If neither a select option
1685
+ * nor a parameter could be found, `undefined` is returned.
1686
+ *
1687
+ * @returns The ranges in the select options for the specified property or a range-converted representation
1688
+ * of a parameter is returned. If both lookups fail, `undefined` is returned. The returned ranges
1689
+ * have the format:
1690
+ * - `Sign`: The sign of the range
1691
+ * - `Option`: The option of the range
1692
+ * - `Low`: The low value of the range; returning the value `null` is not possible
1693
+ * - `High`: The high value of the range; if this value is not necessary, `null` (but does exist)
1694
+ * For further information on the meaning of the attributes, refer to method {@link #.addSelectOption addSelectOption}.
1695
+ */
1696
+ static getValue(
1697
+ /**
1698
+ * The name of the attribute for which the value is retrieved
1699
+ */
1700
+ sName: string
1701
+ ): any[];
1702
+ /**
1703
+ * @deprecated (since 1.83.0)
1704
+ *
1705
+ * Returns `true` if the selection variant does neither contain parameters nor ranges.
1706
+ *
1707
+ * @returns If set to `true` there are no parameters and no select options available in the selection variant;
1708
+ * `false` otherwise.
1709
+ */
1710
+ static isEmpty(): boolean;
1711
+ /**
1712
+ * @deprecated (since 1.83.0)
1713
+ *
1714
+ * Adds a set of select options to the list of select options for a given parameter.
1715
+ *
1716
+ * @returns This instance to allow method chaining
1717
+ */
1718
+ static massAddSelectOption(
1719
+ /**
1720
+ * The name of the property for which the set of select options is added
1721
+ */
1722
+ sPropertyName: string,
1723
+ /**
1724
+ * Set of select options to be added
1725
+ */
1726
+ aSelectOptions: any[]
1727
+ ): object;
1728
+ /**
1729
+ * @deprecated (since 1.83.0)
1730
+ *
1731
+ * Removes a parameter called `sName` from the selection variant.
1732
+ *
1733
+ * @returns This instance to allow method chaining
1734
+ */
1735
+ static removeParameter(
1736
+ /**
1737
+ * The name of the parameter to be removed
1738
+ */
1739
+ sName: string
1740
+ ): object;
1741
+ /**
1742
+ * @deprecated (since 1.83.0)
1743
+ *
1744
+ * Removes a select option called `sName` from the selection variant.
1745
+ *
1746
+ * @returns This instance to allow method chaining.
1747
+ */
1748
+ static removeSelectOption(
1749
+ /**
1750
+ * The name of the select option to be removed
1751
+ */
1752
+ sName: string
1753
+ ): object;
1754
+ /**
1755
+ * @deprecated (since 1.83.0)
1756
+ *
1757
+ * Renames a parameter called `sNameOld` to `sNameNew`. If a parameter or a select option with the name
1758
+ * `sNameNew` already exist, an error is thrown. If a parameter with the name `sNameOld` does not exist,
1759
+ * nothing is changed.
1760
+ *
1761
+ * @returns This instance to allow method chaining
1762
+ */
1763
+ static renameParameter(
1764
+ /**
1765
+ * The current name of the parameter to be renamed
1766
+ */
1767
+ sNameOld: string,
1768
+ /**
1769
+ * The new name of the parameter
1770
+ */
1771
+ sNameNew: string
1772
+ ): object;
1773
+ /**
1774
+ * @deprecated (since 1.83.0)
1775
+ *
1776
+ * Renames a select option called `sNameOld` to `sNameNew`. If a select option or a parameter with the name
1777
+ * `sNameNew` already exist, an error is thrown. If a select option with the name `sNameOld` does not exist,
1778
+ * nothing is changed.
1779
+ *
1780
+ * @returns This instance to allow method chaining
1781
+ */
1782
+ static renameSelectOption(
1783
+ /**
1784
+ * The current name of the select option property to be renamed
1785
+ */
1786
+ sNameOld: string,
1787
+ /**
1788
+ * The new name of the select option property
1789
+ */
1790
+ sNameNew: string
1791
+ ): object;
1792
+ /**
1793
+ * @deprecated (since 1.83.0)
1794
+ *
1795
+ * Sets the context URL intended for the filters.
1796
+ */
1797
+ static setFilterContextUrl(
1798
+ /**
1799
+ * The URL of the filters
1800
+ */
1801
+ sURL: string
1802
+ ): void;
1803
+ /**
1804
+ * @deprecated (since 1.83.0)
1805
+ *
1806
+ * Sets the identification of the selection variant.
1807
+ */
1808
+ static setID(
1809
+ /**
1810
+ * The new identification of the selection variant
1811
+ */
1812
+ sId: string
1813
+ ): void;
1814
+ /**
1815
+ * @deprecated (since 1.83.0)
1816
+ *
1817
+ * Sets the context URL intended for the parameters.
1818
+ */
1819
+ static setParameterContextUrl(
1820
+ /**
1821
+ * The URL of the parameter context
1822
+ */
1823
+ sURL: string
1824
+ ): void;
1825
+ /**
1826
+ * @deprecated (since 1.83.0)
1827
+ *
1828
+ * Sets the text / description of the selection variant.
1829
+ */
1830
+ static setText(
1831
+ /**
1832
+ * The new description to be used
1833
+ */
1834
+ sNewText: string
1835
+ ): void;
1836
+ /**
1837
+ * @deprecated (since 1.83.0)
1838
+ *
1839
+ * Returns the external representation of the selection variant as JSON object.
1840
+ *
1841
+ * @returns The external representation of this instance as a JSON object
1842
+ */
1843
+ static toJSONObject(): object;
1844
+ /**
1845
+ * @deprecated (since 1.83.0)
1846
+ *
1847
+ * Serializes this instance into a JSON-formatted string
1848
+ *
1849
+ * @returns The JSON-formatted representation of this instance in stringified format
1850
+ */
1851
+ static toJSONString(): string;
1852
+ }
1853
+ }
1854
+
1855
+ declare module "sap/ui/generic/app/transaction/BaseController" {
1856
+ import EventProvider from "sap/ui/base/EventProvider";
1857
+
1858
+ import ODataModel from "sap/ui/model/odata/ODataModel";
1859
+
1860
+ import Metadata from "sap/ui/base/Metadata";
1861
+
1862
+ /**
1863
+ * @SINCE 1.30.0
1864
+ *
1865
+ * Common base class for `sap.ui.generic.app.transaction.TransactionController` and `sap.ui.generic.app.transaction.DraftController`,
1866
+ * which offers basic functionality to invoke OData functions and actions as well as OData CRUD functions
1867
+ * in general.
1868
+ */
1869
+ export default class BaseController extends EventProvider {
1870
+ /**
1871
+ * Constructor for base class for controller instances.
1872
+ */
1873
+ constructor(
1874
+ /**
1875
+ * The OData model currently used
1876
+ */
1877
+ oModel: ODataModel,
1878
+ /**
1879
+ * Optional HTTP request queue
1880
+ */
1881
+ oQueue: /* was: sap.ui.generic.app.util.Queue */ any,
1882
+ /**
1883
+ * Delayed draft timer object
1884
+ */
1885
+ oDraftMergeTimer: Object
1886
+ );
1887
+
1888
+ /**
1889
+ * Creates a new subclass of class sap.ui.generic.app.transaction.BaseController with name `sClassName`
1890
+ * and enriches it with the information contained in `oClassInfo`.
1891
+ *
1892
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
1893
+ *
1894
+ * @returns Created class / constructor function
1895
+ */
1896
+ static extend<T extends Record<string, unknown>>(
1897
+ /**
1898
+ * Name of the class being created
1899
+ */
1900
+ sClassName: string,
1901
+ /**
1902
+ * Object literal with information about the class
1903
+ */
1904
+ oClassInfo?: sap.ClassInfo<T, BaseController>,
1905
+ /**
1906
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1907
+ * used by this class
1908
+ */
1909
+ FNMetaImpl?: Function
1910
+ ): Function;
1911
+ /**
1912
+ * Returns a metadata object for class sap.ui.generic.app.transaction.BaseController.
1913
+ *
1914
+ * @returns Metadata object describing this class
1915
+ */
1916
+ static getMetadata(): Metadata;
1917
+ /**
1918
+ * Attaches event handler `fnFunction` to the `fatalError` event.
1919
+ */
1920
+ attachFatalError(
1921
+ /**
1922
+ * The function to call when the event occurs
1923
+ */
1924
+ fnFunction: Function,
1925
+ /**
1926
+ * Object on which to call the given function
1927
+ */
1928
+ oListener?: object
1929
+ ): void;
1930
+ /**
1931
+ * Frees all resources claimed during the life-time of this instance.
1932
+ */
1933
+ destroy(): void;
1934
+ /**
1935
+ * Detaches event handler `fnFunction` from the `fatalError` event.
1936
+ */
1937
+ detachFatalError(
1938
+ /**
1939
+ * The function to call when the event occurs
1940
+ */
1941
+ fnFunction: Function,
1942
+ /**
1943
+ * Object on which to call the given function
1944
+ */
1945
+ oListener?: object
1946
+ ): void;
1947
+ /**
1948
+ * Checks for client messages.
1949
+ *
1950
+ * @returns If client-side messages exist a rejected promise is returned, `null` otherwise
1951
+ */
1952
+ hasClientMessages(): Promise<any>;
1953
+ /**
1954
+ * Triggers submitting the currently tracked changes to the back-end.
1955
+ *
1956
+ * @returns A `Promise` for asynchronous execution of the submit
1957
+ */
1958
+ triggerSubmitChanges(
1959
+ /**
1960
+ * Parameters to control the submit behavior
1961
+ */
1962
+ mParameters: {
1963
+ /**
1964
+ * If set to `true`, the current user interface is not blocked by a busy animation
1965
+ */
1966
+ noBlockUI: boolean;
1967
+ /**
1968
+ * If set to `true`, no success and error messages are shown
1969
+ */
1970
+ noShowResponse: boolean;
1971
+ /**
1972
+ * If set to `true`, the success message is not shown in a toast
1973
+ */
1974
+ noShowSuccessToast: boolean;
1975
+ /**
1976
+ * An optional success message
1977
+ */
1978
+ successMsg: string;
1979
+ /**
1980
+ * An optional error message
1981
+ */
1982
+ failedMsg: string;
1983
+ }
1984
+ ): Promise<any>;
1985
+ }
1986
+ }
1987
+
1988
+ declare module "sap/ui/generic/app/transaction/DraftContext" {
1989
+ import BaseObject from "sap/ui/base/Object";
1990
+
1991
+ import ODataModel from "sap/ui/model/odata/ODataModel";
1992
+
1993
+ import Metadata from "sap/ui/base/Metadata";
1994
+
1995
+ import Context from "sap/ui/model/Context";
1996
+
1997
+ /**
1998
+ * @SINCE 1.30.0
1999
+ *
2000
+ * The class provides access to information on draft handling that is available in the OData service's metadata
2001
+ * as it interprets draft-specific annotations.
2002
+ */
2003
+ export default class DraftContext extends BaseObject {
2004
+ /**
2005
+ * Constructor for meta-model access class.
2006
+ */
2007
+ constructor(
2008
+ /**
2009
+ * The OData model currently used
2010
+ */
2011
+ oModel: ODataModel
2012
+ );
2013
+
2014
+ /**
2015
+ * Creates a new subclass of class sap.ui.generic.app.transaction.DraftContext with name `sClassName` and
2016
+ * enriches it with the information contained in `oClassInfo`.
2017
+ *
2018
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2019
+ *
2020
+ * @returns Created class / constructor function
2021
+ */
2022
+ static extend<T extends Record<string, unknown>>(
2023
+ /**
2024
+ * Name of the class being created
2025
+ */
2026
+ sClassName: string,
2027
+ /**
2028
+ * Object literal with information about the class
2029
+ */
2030
+ oClassInfo?: sap.ClassInfo<T, DraftContext>,
2031
+ /**
2032
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2033
+ * used by this class
2034
+ */
2035
+ FNMetaImpl?: Function
2036
+ ): Function;
2037
+ /**
2038
+ * Returns a metadata object for class sap.ui.generic.app.transaction.DraftContext.
2039
+ *
2040
+ * @returns Metadata object describing this class
2041
+ */
2042
+ static getMetadata(): Metadata;
2043
+ /**
2044
+ * @deprecated (since 1.32.0)
2045
+ *
2046
+ * Checks whether an OData property is annotated with UpdateOnChange. The method is used in context of a
2047
+ * validation success event.
2048
+ *
2049
+ * @returns `true`, if the property is annotated with UpdateOnChange, `false` otherwise
2050
+ */
2051
+ checkUpdateOnChange(
2052
+ /**
2053
+ * The name of the entity set
2054
+ */
2055
+ sEntitySet: string,
2056
+ /**
2057
+ * The name of the property
2058
+ */
2059
+ sProperty: string
2060
+ ): boolean;
2061
+ /**
2062
+ * Frees all resources claimed during the life-time of this instance.
2063
+ */
2064
+ destroy(): void;
2065
+ /**
2066
+ * Returns the name of the function import to be used.
2067
+ *
2068
+ * @returns The name of the function import to be used
2069
+ */
2070
+ getODataDraftFunctionImportName(
2071
+ /**
2072
+ * The given binding context
2073
+ */
2074
+ oContext: Context,
2075
+ /**
2076
+ * The draft function import
2077
+ */
2078
+ sDraftFunctionImport: string
2079
+ ): string;
2080
+ /**
2081
+ * Returns the semantic keys for a given entity set.
2082
+ *
2083
+ * @returns The semantic keys
2084
+ */
2085
+ getSemanticKey(
2086
+ /**
2087
+ * The given entity set
2088
+ */
2089
+ sEntitySet: string
2090
+ ): any[];
2091
+ /**
2092
+ * Checks whether an entity set is draft-enabled. The entity set name is derived from the given binding
2093
+ * context
2094
+ *
2095
+ * @returns `true`, if a given entity set is draft-enabled, `false` otherwise
2096
+ */
2097
+ hasDraft(
2098
+ /**
2099
+ * The given binding context
2100
+ */
2101
+ oContext: Context
2102
+ ): boolean;
2103
+ /**
2104
+ * Checks whether administrative data for a given draft is available.
2105
+ *
2106
+ * @returns `true`, if administrative data is available, `false` otherwise
2107
+ */
2108
+ hasDraftAdministrativeData(
2109
+ /**
2110
+ * The name of the entity set
2111
+ */
2112
+ sEntitySet: string
2113
+ ): boolean;
2114
+ /**
2115
+ * Checks whether an entity set has a draft preparation action. The entity set name is derived from the
2116
+ * given binding context.
2117
+ *
2118
+ * @returns `true`, if a given entity set has a draft preparation action, `false` otherwise
2119
+ */
2120
+ hasDraftPreparationAction(
2121
+ /**
2122
+ * The given binding context
2123
+ */
2124
+ oContext: Context
2125
+ ): boolean;
2126
+ /**
2127
+ * Checks whether an entity set is draft root. The entity set name is derived from the given binding context.
2128
+ *
2129
+ * @returns `true`, if a given entity set is draft root, `false` otherwise
2130
+ */
2131
+ hasDraftRoot(
2132
+ /**
2133
+ * The given binding context
2134
+ */
2135
+ oContext: Context
2136
+ ): boolean;
2137
+ /**
2138
+ * Checks whether an entity set has a draft validation function. The entity set name is derived from the
2139
+ * given binding context.
2140
+ *
2141
+ * @returns `true`, if a given entity set has a draft validation function, `false` otherwise
2142
+ */
2143
+ hasDraftValidationFunction(
2144
+ /**
2145
+ * The given binding context
2146
+ */
2147
+ oContext: Context
2148
+ ): boolean;
2149
+ /**
2150
+ * @SINCE 1.38
2151
+ *
2152
+ * Checks if the parameter "PreserveChanges" is supported by the edit function. If the edit action is triggered
2153
+ * with the parameter set to `true` the ABAP application infrastructure will respond with HTTP response
2154
+ * code 409 if unsaved changes (from another user) exist.
2155
+ *
2156
+ * @returns `true`, if "PreserveChanges" is supported
2157
+ */
2158
+ hasPreserveChanges(): boolean;
2159
+ /**
2160
+ * Checks whether a sibling entity for a given entity set is available.
2161
+ *
2162
+ * @returns `true`, if sibling entity is available, `false` otherwise
2163
+ */
2164
+ hasSiblingEntity(
2165
+ /**
2166
+ * The name of the entity set
2167
+ */
2168
+ sEntitySet: string
2169
+ ): boolean;
2170
+ /**
2171
+ * Checks whether a given entity set is draft-enabled.
2172
+ *
2173
+ * @returns `true`, if a given entity set is draft-enabled, `false` otherwise
2174
+ */
2175
+ isDraftEnabled(
2176
+ /**
2177
+ * The name of the entity set
2178
+ */
2179
+ sEntitySet: string
2180
+ ): boolean;
2181
+ /**
2182
+ * Checks whether a given entity set is a draft root.
2183
+ *
2184
+ * @returns `true`, if a given entity set is draft root, `false` otherwise
2185
+ */
2186
+ isDraftRoot(
2187
+ /**
2188
+ * The name of the entity set
2189
+ */
2190
+ sEntitySet: string
2191
+ ): boolean;
2192
+ /**
2193
+ * Checks whether a given key is a semantic key.
2194
+ *
2195
+ * @returns `true`, if a given key is a semantic key, `false` otherwise
2196
+ */
2197
+ isSemanticKey(
2198
+ /**
2199
+ * The name of the entity set
2200
+ */
2201
+ sEntitySet: string,
2202
+ /**
2203
+ * The given key
2204
+ */
2205
+ oKeys: object
2206
+ ): boolean;
2207
+ /**
2208
+ * Checks whether a given key is a technical key.
2209
+ *
2210
+ * @returns `true`, if a given key is a technical key, `false` otherwise
2211
+ */
2212
+ isTechnicalKey(
2213
+ /**
2214
+ * The name of the entity set
2215
+ */
2216
+ sEntitySet: string,
2217
+ /**
2218
+ * The given key
2219
+ */
2220
+ oKeys: object
2221
+ ): boolean;
2222
+ }
2223
+ }
2224
+
2225
+ declare module "sap/ui/generic/app/transaction/DraftController" {
2226
+ import BaseController from "sap/ui/generic/app/transaction/BaseController";
2227
+
2228
+ import ODataModel from "sap/ui/model/odata/ODataModel";
2229
+
2230
+ import Context from "sap/ui/model/Context";
2231
+
2232
+ import DraftContext from "sap/ui/generic/app/transaction/DraftContext";
2233
+
2234
+ import Metadata from "sap/ui/base/Metadata";
2235
+
2236
+ /**
2237
+ * @SINCE 1.30.0
2238
+ *
2239
+ * Gives access to runtime draft handling for applications. Assuming state-less communication, each single
2240
+ * data modification request (or change set in an OData $batch request) is a "mini-transaction", which saves
2241
+ * data to the database. The class implements the transactional interaction patterns specified for OData
2242
+ * services that support draft documents and provides methods for draft-specific actions, for example validate,
2243
+ * prepare, activate.
2244
+ *
2245
+ * Additionally, it handles transactional request processing, ensures concurrency control and correct ETag
2246
+ * handling. It provides access to the simple interaction patterns of runtime handling for drafts according
2247
+ * to the draft specification. These can be combined as required by client applications. Additionally, error
2248
+ * handling is provided to notify client implementations of error situations. The event `fatalError` is
2249
+ * thrown, if fatal errors occur during execution of OData requests.
2250
+ */
2251
+ export default class DraftController extends BaseController {
2252
+ /**
2253
+ * Constructor for a new draft controller instance.
2254
+ */
2255
+ constructor(
2256
+ /**
2257
+ * The OData model currently used
2258
+ */
2259
+ oModel: ODataModel,
2260
+ /**
2261
+ * Optional HTTP request queue
2262
+ */
2263
+ oQueue: /* was: sap.ui.generic.app.util.Queue */ any,
2264
+ /**
2265
+ * Delayed draft timer object
2266
+ */
2267
+ oDraftMergeTimer: Object
2268
+ );
2269
+
2270
+ /**
2271
+ * Creates a new subclass of class sap.ui.generic.app.transaction.DraftController with name `sClassName`
2272
+ * and enriches it with the information contained in `oClassInfo`.
2273
+ *
2274
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
2275
+ *
2276
+ * @returns Created class / constructor function
2277
+ */
2278
+ static extend<T extends Record<string, unknown>>(
2279
+ /**
2280
+ * Name of the class being created
2281
+ */
2282
+ sClassName: string,
2283
+ /**
2284
+ * Object literal with information about the class
2285
+ */
2286
+ oClassInfo?: sap.ClassInfo<T, DraftController>,
2287
+ /**
2288
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2289
+ * used by this class
2290
+ */
2291
+ FNMetaImpl?: Function
2292
+ ): Function;
2293
+ /**
2294
+ * Returns a metadata object for class sap.ui.generic.app.transaction.DraftController.
2295
+ *
2296
+ * @returns Metadata object describing this class
2297
+ */
2298
+ static getMetadata(): Metadata;
2299
+ /**
2300
+ * Submits changes to the back-end and activates a draft entity in the back-end.
2301
+ *
2302
+ * @returns A `Promise` for asynchronous execution
2303
+ */
2304
+ activateDraftEntity(
2305
+ /**
2306
+ * The given binding context
2307
+ */
2308
+ oContext: Context,
2309
+ /**
2310
+ * Set to `true` to activate the draft even if warnings exist
2311
+ */
2312
+ bIsLenient: boolean,
2313
+ /**
2314
+ * Comma separated navigation properties which needs to be expanded with the root context of the active
2315
+ * instance
2316
+ */
2317
+ sExpand: string
2318
+ ): Promise<any>;
2319
+ /**
2320
+ * Submits changes to the back-end and activates a draft entity in the back-end.
2321
+ *
2322
+ * @returns A `Promise` for asynchronous execution
2323
+ */
2324
+ activateDraftEntity(
2325
+ /**
2326
+ * The given binding context
2327
+ */
2328
+ oContext: Context,
2329
+ /**
2330
+ * Comma separated navigation properties which needs to be expanded with the root context of the active
2331
+ * instance
2332
+ */
2333
+ sExpand: string
2334
+ ): Promise<any>;
2335
+ /**
2336
+ * Creates an edit draft in the back-end. Additionally, possible changes that have been collected on the
2337
+ * client are sent to the back-end.
2338
+ *
2339
+ * @returns A `Promise` for asynchronous execution
2340
+ */
2341
+ createEditDraftEntity(
2342
+ /**
2343
+ * The given binding context
2344
+ */
2345
+ oContext: Context,
2346
+ /**
2347
+ * Set to `true` to avoid the creation of a new draft when unsaved changes exist in the back-end
2348
+ */
2349
+ bPreserveChanges?: boolean,
2350
+ /**
2351
+ * indicates whether root needs to expanded
2352
+ */
2353
+ sRootExpand?: string
2354
+ ): Promise<any>;
2355
+ /**
2356
+ * Creates a new edit draft on the client and sends it to the back-end. Additionally, possible changes that
2357
+ * have been collected on the client are sent to the back-end.
2358
+ *
2359
+ * @returns A `Promise` for asynchronous execution of the request
2360
+ */
2361
+ createNewDraftEntity(
2362
+ /**
2363
+ * The name of the entity set
2364
+ */
2365
+ sEntitySet: string,
2366
+ /**
2367
+ * Path identifying the new entity instance
2368
+ */
2369
+ sPath: string,
2370
+ /**
2371
+ * An array that specifies a set of properties or the entry
2372
+ */
2373
+ vPredefinedValues?: any[] | object,
2374
+ /**
2375
+ * information whether the canonicalRequest parameter should be set for the create request
2376
+ */
2377
+ bCanonicalRequest?: boolean,
2378
+ /**
2379
+ * parameters to be passed to the function
2380
+ */
2381
+ oParameters?: {
2382
+ /**
2383
+ * indicates whether root needs to expanded
2384
+ */
2385
+ sRootExpand?: boolean;
2386
+ /**
2387
+ * controller object required to create ActionUtil instance
2388
+ */
2389
+ oController?: object;
2390
+ /**
2391
+ * applicationController object required to create ActionUtil instance
2392
+ */
2393
+ oApplicationController?: object;
2394
+ /**
2395
+ * manifest entry indicating whether newAction has to be used for draft reation
2396
+ */
2397
+ bUseNewActionForCreate?: boolean;
2398
+ /**
2399
+ * callback to set the busy indicator
2400
+ */
2401
+ fnSetBusy?: Function;
2402
+ }
2403
+ ): Promise<any>;
2404
+ /**
2405
+ * Frees all resources claimed during the life-time of this instance.
2406
+ */
2407
+ destroy(): void;
2408
+ /**
2409
+ * Returns the current draft context instance. If no instance exists, it is created lazily.
2410
+ *
2411
+ * @returns The current draft context instance
2412
+ */
2413
+ getDraftContext(): DraftContext;
2414
+ /**
2415
+ * @SINCE 1.32.0
2416
+ *
2417
+ * Retrieves a possibly existing draft entity for the given active entity using the binding context of the
2418
+ * active entity from the back-end.
2419
+ *
2420
+ * @returns A `Promise` for asynchronous execution
2421
+ */
2422
+ getDraftForActiveEntity(
2423
+ /**
2424
+ * The binding context of the active entity
2425
+ */
2426
+ oContext: Context
2427
+ ): Promise<any>;
2428
+ /**
2429
+ * @SINCE 1.32.0
2430
+ *
2431
+ * Checks whether an entity has an active entity associated.
2432
+ *
2433
+ * @returns `true`, if an active entity exists, `false` otherwise
2434
+ */
2435
+ hasActiveEntity(
2436
+ /**
2437
+ * The given binding context
2438
+ */
2439
+ oContext: Context
2440
+ ): boolean;
2441
+ /**
2442
+ * Checks whether an entity set is active. The entity set name is derived from the given binding context
2443
+ *
2444
+ * @returns `true`, if a given entity set is active, `false` otherwise
2445
+ */
2446
+ isActiveEntity(
2447
+ /**
2448
+ * The given binding context
2449
+ */
2450
+ oContext: Context
2451
+ ): boolean;
2452
+ /**
2453
+ * Submits changes to the back-end and prepares an existing draft entity in the back-end for later activation
2454
+ * by invoking the preparation action.
2455
+ *
2456
+ * @returns A `Promise` for asynchronous execution
2457
+ */
2458
+ prepareDraftEntity(
2459
+ /**
2460
+ * The given binding context
2461
+ */
2462
+ oContext: Context
2463
+ ): Promise<any>;
2464
+ /**
2465
+ * Submits changes to the back-end and prepares a draft entity in the back-end for later activation by invoking
2466
+ * the preparation action.
2467
+ *
2468
+ * @returns A `Promise` for asynchronous execution
2469
+ */
2470
+ saveAndPrepareDraftEntity(
2471
+ /**
2472
+ * The given binding context
2473
+ */
2474
+ oContext: Context,
2475
+ /**
2476
+ * Parameters to control the behavior of the request
2477
+ */
2478
+ mParameters: Record<string, any>
2479
+ ): Promise<any>;
2480
+ /**
2481
+ * Submits changes to the back-end and prepares an existing draft entity in the back-end for later activation
2482
+ * by invoking the validation action.
2483
+ *
2484
+ * @returns A `Promise` for asynchronous execution
2485
+ */
2486
+ validateDraftEntity(
2487
+ /**
2488
+ * The given binding context
2489
+ */
2490
+ oContext: Context
2491
+ ): Promise<any>;
2492
+ }
2493
+ }
2494
+
2495
+ declare module "sap/ui/generic/app/transaction/TransactionController" {
2496
+ import BaseController from "sap/ui/generic/app/transaction/BaseController";
2497
+
2498
+ import ODataModel from "sap/ui/model/odata/ODataModel";
2499
+
2500
+ import Context from "sap/ui/model/Context";
2501
+
2502
+ import DraftController from "sap/ui/generic/app/transaction/DraftController";
2503
+
2504
+ import Metadata from "sap/ui/base/Metadata";
2505
+
2506
+ /**
2507
+ * @SINCE 1.30.0
2508
+ *
2509
+ * Assuming state-less communication, each single data modification request (or change set in an OData $batch
2510
+ * request) is a "mini-transaction", which saves data to the database. The class allows you to submit changes,
2511
+ * invoke actions, OData CRUD operations in general, and trigger client-side validations. It ensures concurrency
2512
+ * control and correct ETag handling.
2513
+ *
2514
+ * The class gives access to runtime draft handling for applications. Additionally error handling capabilities
2515
+ * are provided to notify client implementations of error situations. The event `fatalError` is thrown,
2516
+ * if fatal errors occur during execution of OData requests.
2517
+ */
2518
+ export default class TransactionController extends BaseController {
2519
+ /**
2520
+ * Constructor for a new transaction controller instance.
2521
+ */
2522
+ constructor(
2523
+ /**
2524
+ * The OData model currently used
2525
+ */
2526
+ oModel: ODataModel,
2527
+ /**
2528
+ * Optional HTTP request queue
2529
+ */
2530
+ oQueue: /* was: sap.ui.generic.app.util.Queue */ any,
2531
+ /**
2532
+ * Optional configuration parameters
2533
+ */
2534
+ mParams: {
2535
+ /**
2536
+ * Suppresses creation of batch groups
2537
+ */
2538
+ noBatchGroups: boolean;
2539
+ },
2540
+ /**
2541
+ * Delayed draft timer object
2542
+ */
2543
+ oDraftMergeTimer: Object
2544
+ );
2545
+
2546
+ /**
2547
+ * Creates a new subclass of class sap.ui.generic.app.transaction.TransactionController with name `sClassName`
2548
+ * and enriches it with the information contained in `oClassInfo`.
2549
+ *
2550
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
2551
+ *
2552
+ * @returns Created class / constructor function
2553
+ */
2554
+ static extend<T extends Record<string, unknown>>(
2555
+ /**
2556
+ * Name of the class being created
2557
+ */
2558
+ sClassName: string,
2559
+ /**
2560
+ * Object literal with information about the class
2561
+ */
2562
+ oClassInfo?: sap.ClassInfo<T, TransactionController>,
2563
+ /**
2564
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2565
+ * used by this class
2566
+ */
2567
+ FNMetaImpl?: Function
2568
+ ): Function;
2569
+ /**
2570
+ * Returns a metadata object for class sap.ui.generic.app.transaction.TransactionController.
2571
+ *
2572
+ * @returns Metadata object describing this class
2573
+ */
2574
+ static getMetadata(): Metadata;
2575
+ /**
2576
+ * @SINCE 1.38
2577
+ * @EXPERIMENTAL
2578
+ *
2579
+ * Submits changes to the backend system and deletes a group of entities in the backend system. These entities
2580
+ * can be both draft or active entities.
2581
+ *
2582
+ * @returns A `Promise` that receives an array with the responses of the delete requests. The `Promise`
2583
+ * resolves when at least one request was successful and rejects when all delete requests have been rejected/aborted.
2584
+ */
2585
+ deleteEntities(
2586
+ /**
2587
+ * Binding contexts or paths (strings) which identify the entities
2588
+ */
2589
+ aEntities: any[],
2590
+ /**
2591
+ * Parameters that control the behavior of the request
2592
+ */
2593
+ mParameters: Record<string, any>
2594
+ ): Promise<any>;
2595
+ /**
2596
+ * Submits changes to the backend system and deletes an entity in the backend system. This entity can be
2597
+ * either a draft or an active entity.
2598
+ *
2599
+ * @returns A `Promise` for asynchronous execution
2600
+ */
2601
+ deleteEntity(
2602
+ /**
2603
+ * Binding context or path of the entity
2604
+ */
2605
+ vEntity: Context | string,
2606
+ /**
2607
+ * Parameters that control the behavior of the request
2608
+ */
2609
+ mParameters: Record<string, any>
2610
+ ): Promise<any>;
2611
+ /**
2612
+ * Frees all resources claimed during the life-time of this instance.
2613
+ */
2614
+ destroy(): void;
2615
+ /**
2616
+ * Prepares an entity for editing. If the entity is active and draft enabled, a new draft document is created.
2617
+ * If not, the control is automatically returned to the caller of the method by returning a resolved promise.
2618
+ *
2619
+ * @returns A `Promise` for asynchronous execution
2620
+ */
2621
+ editEntity(
2622
+ /**
2623
+ * The given binding context
2624
+ */
2625
+ oContext: Context,
2626
+ /**
2627
+ * Set to `true` to avoid the creation of a new draft when unsaved changes exist in the back-end
2628
+ */
2629
+ bPreserveChanges?: boolean,
2630
+ /**
2631
+ * indicates whether root needs to expanded
2632
+ */
2633
+ sRootExpand?: string
2634
+ ): Promise<any>;
2635
+ /**
2636
+ * Returns the current draft controller instance.
2637
+ *
2638
+ * @returns The draft controller instance
2639
+ */
2640
+ getDraftController(): DraftController;
2641
+ /**
2642
+ * Resets changes that have been tracked by the current instance of `sap.ui.model.odata.v2.ODatatModel`.
2643
+ * These changes have been created by invoking the `setProperty` method of `sap.ui.model.odata.v2.ODatatModel`.
2644
+ */
2645
+ resetChanges(): void;
2646
+ /**
2647
+ * Multi edit handling.
2648
+ *
2649
+ * @returns A `Promise` which resolves if the given promises have been executed with at least one successfully.
2650
+ * It rejects if all given promises were rejected.
2651
+ */
2652
+ updateMultipleEntities(
2653
+ /**
2654
+ * contains path and data to be updated for all selected contexts.
2655
+ */
2656
+ aContextToBeUpdated: any[]
2657
+ ): Promise<any>;
2658
+ }
2659
+ }
2660
+
2661
+ declare namespace sap {
2662
+ interface IUI5DefineDependencyNames {
2663
+ "sap/ui/generic/app/ApplicationController": undefined;
2664
+
2665
+ "sap/ui/generic/app/library": undefined;
2666
+
2667
+ "sap/ui/generic/app/navigation/service/NavError": undefined;
2668
+
2669
+ "sap/ui/generic/app/navigation/service/NavigationHandler": undefined;
2670
+
2671
+ "sap/ui/generic/app/navigation/service/PresentationVariant": undefined;
2672
+
2673
+ "sap/ui/generic/app/navigation/service/SelectionVariant": undefined;
2674
+
2675
+ "sap/ui/generic/app/transaction/BaseController": undefined;
2676
+
2677
+ "sap/ui/generic/app/transaction/DraftContext": undefined;
2678
+
2679
+ "sap/ui/generic/app/transaction/DraftController": undefined;
2680
+
2681
+ "sap/ui/generic/app/transaction/TransactionController": undefined;
2682
+ }
2683
+ }