@sap/open.fe 1.97.0 → 1.98.0

package/packages/sap.fe.navigation/test/sap/fe/navigation/designtime/api.json

@@ -1 +1 @@
-{"$schema-ref":"http://schemas.sap.com/sapui5/designtime/api.json/1.0","version":"1.97.0","library":"sap.fe.navigation","symbols":[{"kind":"namespace","name":"sap.fe.navigation","basename":"navigation","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"","static":true,"visibility":"public","since":"1.83.0","description":"Common library for all cross-application navigation functions."},{"kind":"enum","name":"sap.fe.navigation.Mode","basename":"Mode","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"Mode","static":true,"visibility":"public","since":"1.83.0","description":"A static enumeration type which indicates the Odata version used for runnning the Navigation Handler.","properties":[{"name":"ODataV2","visibility":"public","static":true,"type":"undefined","description":"This is used for ODataV2 services to do some internal tasks like creation of appstate, removal of sensitive data etc.,"},{"name":"ODataV4","visibility":"public","static":true,"type":"undefined","description":"This is used for ODataV4 services to do some internal tasks like creation of appstate, removal of sensitive data etc.,"}]},{"kind":"class","name":"sap.fe.navigation.NavError","basename":"NavError","resource":"sap/fe/navigation/NavError.js","module":"sap/fe/navigation/NavError","export":"","static":true,"visibility":"public","since":"1.83.0","extends":"sap.ui.base.Object","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.NavError}.<br> An object that provides error handling information during runtime.","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"sErrorCode","type":"string","optional":false,"description":"The code for an internal error of a consumer that allows you to track the source locations"}],"description":"Accepts an object literal <code>mSettings</code> that defines initial property values, aggregated and associated objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.\n\nThis class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.Object#constructor sap.ui.base.Object} can be used."},"methods":[{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.navigation.NavError with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.base.Object.extend}."},{"name":"getErrorCode","visibility":"public","returnValue":{"type":"string","description":"The error code of the error"},"description":"Returns the error code with which the instance has been created."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.navigation.NavError."}]},{"kind":"class","name":"sap.fe.navigation.NavigationHandler","basename":"NavigationHandler","resource":"sap/fe/navigation/NavigationHandler.js","module":"sap/fe/navigation/NavigationHandler","export":"","static":true,"visibility":"public","since":"1.83.0","extends":"sap.ui.base.Object","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.NavigationHandler}.<br> Creates a new NavigationHandler class by providing the required environment. <br> The <code>NavigationHandler</code> supports the verification of sensitive information. All properties that are part of <code>selectionVariant</code> and <code>valueTexts</code> will be verified if they are annotated as <code>com.sap.vocabularies.PersonalData.v1.IsPotentiallySensitive</code> or <code>com.sap.vocabularies.UI.v1.ExcludeFromNavigationContext</code> and will be removed before the data is persisted as the app state.<br> Also, all properties annotated as <code>com.sap.vocabularies.Analytics.v1.Measure</code> will be removed from the data stored as the xapp state.<br> To verify the information to be removed, the <code>NavigationHandler</code> requires an unnamed model of type {@link sap.ui.model.odata.v2.ODataModel} on component level. It is possible to set such a model using the <code>setModel</code> method.<br> <b>Note:</b> The check for excluded data requires that the OData metadata has already been loaded completely.<br> If the OData metadata model has not been loaded completely, all properties are removed from the application context.<br> <b>Note:</b> This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation} is available and initialized.","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"oController","type":"object","optional":false,"description":"UI5 controller that contains a router and a component; typically the main controller of your application, for example, a subclass of the sap.ca.scfld.md.controller.BaseFullscreenController if scaffolding is used"},{"name":"sMode","type":"string","optional":true,"defaultValue":"sap.fe.navigation.Mode.ODataV4","description":"Mode to be used to indicates the Odata version used for runnning the Navigation Handler, see {@link sap.fe.navigation.Mode}.<br> Note: Mode has to be sap.fe.navigation.Mode.ODataV2 whenever this constructor is used to initialize a OData V2 based service."},{"name":"sParamHandlingMode","type":"string","optional":true,"defaultValue":"SelVarWins","description":"Mode to be used to handle conflicts when merging URL parameters and the SelectionVariant class, see {@link sap.fe.navigation.ParamHandlingMode}"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr> <th align=\"left\">NavError code</th> <th align=\"left\">Description</th> </tr> <tr> <td>NavigationHandler.INVALID_INPUT</td> <td>Indicates that the input parameter is invalid</td> </tr> </table>","type":"undefined"}]},"methods":[{"name":"_getAppStateKeyAndUrlParameters","visibility":"restricted","static":true,"returnValue":{"type":"object","description":"A Promise object to monitor when all actions of the function have been executed; if the execution is successful, the semanticAttributes as well as the appStateKey are returned; if an error occurs, an error object of type {@link sap.fe.navigation.NavError} is returned <br>"},"parameters":[{"name":"sSelectionVariant","type":"string","optional":false,"description":"Stringified JSON object"}],"description":"Processes selectionVariant string and returns a Promise object (semanticAttributes and AppStateKey).","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\", \"sap/fe/navigation/SelectionVariant\"], function (NavigationHandler, SelectionVariant) {\n\t\tvar oSelectionVariant = new SelectionVariant();\n\t\toSelectionVariant.addSelectOption(\"CompanyCode\", \"I\", \"EQ\", \"0001\");\n\t\toSelectionVariant.addSelectOption(\"Customer\", \"I\", \"EQ\", \"C0001\");\n\t\tvar sSelectionVariant= oSelectionVariant.toJSONString();\n\n\t\tvar oNavigationHandler = new NavigationHandler(oController);\n\t\tvar oPromiseObject = oNavigationHandler._getAppStateKeyAndUrlParameters(sSelectionVariant);\n\n\t\toPromiseObject.done(function(oSemanticAttributes, sAppStateKey){\n\t\t\t// here you can add coding that should run after all app state and the semantic attributes have been returned.\n\t\t});\n\n\t\toPromiseObject.fail(function(oError){\n\t\t\t//some error handling\n\t\t});\n\t});\n</code>"}]},{"name":"constructContextUrl","visibility":"protected","static":true,"returnValue":{"type":"string","description":"The context url for the given entities"},"parameters":[{"name":"sEntitySetName","type":"string","optional":false,"description":"Used for url determination"},{"name":"oModel","type":"sap.ui.model.odata.v2.ODataModel","optional":true,"description":"Used for url determination. If omitted, the NavigationHandler model is used."}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of missing or wrong passed parameters","type":"undefined"}],"description":"The method creates a context url based on provided data. This context url can either be used as {@link sap.fe.navigation.NavigationHandler#setParameterContextUrl ParameterContextUrl} or {@link sap.fe.navigation.NavigationHandler#setFilterContextUrl FilterContextUrl}."},{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.navigation.NavigationHandler with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.base.Object.extend}."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.navigation.NavigationHandler."},{"name":"getTechnicalParameters","visibility":"public","static":true,"returnValue":{"type":"Array","description":"Containing the technical parameters."},"description":"Gets the application specific technical parameters. Technical parameters will not be added to the selection variant passed to the application. As a default the following values are considered as technical parameters: <ul> <li><code>sap-system</code></li> <li><code>sap-ushell-defaultedParameterNames</code></li> <li><code>\"hcpApplicationId\"</code></li> </ul>."},{"name":"mixAttributesAndSelectionVariant","visibility":"public","static":true,"returnValue":{"type":"object","description":"Instance of {@link sap.fe.navigation.SelectionVariant}"},"parameters":[{"name":"vSemanticAttributes","type":"object|Array","optional":false,"description":"Object/(Array of Objects) containing key/value pairs"},{"name":"sSelectionVariant","type":"string","optional":false,"description":"The selection variant in string format as provided by the SmartFilterBar control"},{"name":"iSuppressionBehavior","type":"int","optional":true,"defaultValue":"sap.fe.navigation.SuppressionBehavior.standard","description":"Indicates whether semantic attributes with special values (see {@link sap.fe.navigation.SuppressionBehavior suppression behavior}) must be suppressed before they are combined with the selection variant; several {@link sap.fe.navigation.SuppressionBehavior suppression behaviors} can be combined with the bitwise OR operator (|)"}],"description":"Combines the given parameters and selection variant into a new selection variant containing properties from both, with the parameters overriding existing properties in the selection variant. The new selection variant does not contain any parameters. All parameters are merged into select options. The output of this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate} method.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\", \"sap/fe/navigation/SelectionVariant\"], function (NavigationHandler, SelectionVariant) {\n\tvar vSemanticAttributes = { \"Customer\" : \"C0001\" };\n\tor\n\tvar vSemanticAttributes = [{ \"Customer\" : \"C0001\" },{ \"Customer\" : \"C0002\" }];\n\tvar sSelectionVariant = oSmartFilterBar.getDataSuiteFormat();\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar sNavigationSelectionVariant = oNavigationHandler.mixAttributesAndSelectionVariant(vSemanticAttributes, sSelectionVariant).toJSONString();\n\t// In case of an vSemanticAttributes being an array, the semanticAttributes are merged to a single SV and compared against the sSelectionVariant(second agrument).\n\t// Optionally, you can specify one or several suppression behaviors. Several suppression behaviors are combined with the bitwise OR operator, e.g.\n\t// var iSuppressionBehavior = sap.fe.navigation.SuppressionBehavior.raiseErrorOnNull | sap.fe.navigation.SuppressionBehavior.raiseErrorOnUndefined;\n\t// var sNavigationSelectionVariant = oNavigationHandler.mixAttributesAndSelectionVariant(mSemanticAttributes, sSelectionVariant, iSuppressionBehavior).toJSONString();\n\n\toNavigationHandler.navigate(\"SalesOrder\", \"create\", sNavigationSelectionVariant);\n});\n</code>"}]},{"name":"navigate","visibility":"public","static":true,"parameters":[{"name":"sSemanticObject","type":"string","optional":false,"description":"Name of the semantic object of the target app"},{"name":"sActionName","type":"string","optional":false,"description":"Name of the action of the target app"},{"name":"vNavigationParameters","type":"object|string","optional":true,"description":"Navigation parameters as an object with key/value pairs or as a string representation of such an object. If passed as an object, the properties are not checked against the <code>IsPotentialSensitive</code> or <code>Measure</code> type."},{"name":"oInnerAppData","type":"object","optional":true,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"string","optional":true,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control"},"tableVariantId":{"name":"tableVariantId","type":"string","optional":true,"description":"ID of the SmartTable variant"},"customData":{"name":"customData","type":"object","optional":true,"description":"Object that can be used to store arbitrary data"},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui state of the app"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions"},"semanticDates":{"name":"semanticDates","type":"object","optional":true,"description":"Object containing semanticDates filter information"}},"description":"Object for storing current state of the app"},{"name":"fnOnError","type":"function","optional":true,"description":"Callback that is called if an error occurs during navigation <br>"},{"name":"oExternalAppData","type":"object","optional":false,"parameterProperties":{"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui state of the app which will be forwarded to the target component."},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions which will be forwarded to the target component."},"selectionVariant":{"name":"selectionVariant","type":"object","optional":true,"description":"Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant will be constructed based on the vNavigationParameters."}},"description":"Object for storing the state which will be forwarded to the target component."},{"name":"sNavMode","type":"string","optional":true,"description":"Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the <code>explace</code> or <code>inplace</code> values are allowed. Any other value will lead to an exception <code>NavigationHandler.INVALID_NAV_MODE</code>."}],"description":"Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode based on <code>sap-ushell-next-navmode</code> is taken into account. If set to <code>explace</code> the inner app state will not be changed. <b>Note:</b> The <code>sNavMode</code> argument can be used to overwrite the SAP Fiori launchpad default navigation for opening a URL in-place or ex-place.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\", \"sap/fe/navigation/SelectionVariant\"], function (NavigationHandler, SelectionVariant) {\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar sSemanticObject = \"SalesOrder\";\n\tvar sActionName = \"create\";\n\n\t//simple parameters as Object\n\tvar vNavigationParameters = {\n\t\tCompanyCode : \"0001\",\n\t\tCustomer : \"C0001\"\n\t};\n\n\t//or as selection variant\n\tvar oSelectionVariant = new SelectionVariant();\n\t oSelectionVariant.addSelectOption(\"CompanyCode\", \"I\", \"EQ\", \"0001\");\n\toSelectionVariant.addSelectOption(\"Customer\", \"I\", \"EQ\", \"C0001\");\n\tvNavigationParameters = oSelectionVariant.toJSONString();\n\n\t//or directly from SmartFilterBar\n\tvNavigationParameters = oSmartFilterBar.getDataSuiteFormat();\n\n\t//app state for back navigation\n\t var oInnerAppData = {\n\t\tselectionVariant : oSmartFilterBar.getDataSuiteFormat(),\n\t\ttableVariantId : oSmartTable.getCurrentVariantId(),\n\t\tcustomData : oMyCustomData\n\t};\n\n\t// callback function in case of errors\n\tvar fnOnError = function(oError){\n\t\tvar oi18n = oController.getView().getModel(\"i18n\").getResourceBundle();\n\t\toError.setUIText({oi18n : oi18n, sTextKey : \"OUTBOUND_NAV_ERROR\"});\n\t\toError.showMessageBox();\n\t};\n\n\toNavigationHandler.navigate(sSemanticObject, sActionName, vNavigationParameters, oInnerAppData, fnOnError);\n});\n</code>"}]},{"name":"parseNavigation","visibility":"public","static":true,"returnValue":{"type":"object","description":"A Promise object to monitor when all the actions of the function have been executed. If the execution is successful, the extracted app state, the startup parameters, and the type of navigation are returned, see also the example above. The app state is an object that contains the following information: <ul> <li><code>oAppData.oSelectionVariant</code>: An instance of {@link sap.fe.navigation.SelectionVariant} containing only parameters/select options that are related to navigation</li> <li><code>oAppData.selectionVariant</code>: The navigation-related selection variant as a JSON-formatted string</li> <li><code>oAppData.oDefaultedSelectionVariant</code>: An instance of {@link sap.fe.navigation.SelectionVariant} containing only the parameters/select options that are set by user default data</li> <li><code>oAppData.bNavSelVarHasDefaultsOnly</code>: A Boolean flag that indicates whether only defaulted parameters and no navigation parameters are present.<br> <b>Note:</b> If no navigation parameters are available, <code>bNavSelVarHasDefaultsOnly</code> is set to <code>true</code>, even though parameters without default might be available as well.</li> </ul> If the navigation-related selection variant is empty, it is replaced by a copy of the defaulted selection variant.<br> The navigation type is an enumeration type of type {@link sap.fe.navigation.NavType} (possible values are initial, URLParams, xAppState, and iAppState).<br> <b>Note:</b> If the navigation type is {@link sap.fe.navigation.NavType.iAppState} oAppData has two additional properties <ul> <li><code>oAppData.tableVariantId</code></li> <li><code>oAppData.customData</code></li> </ul> which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppState storeInnerAppState}. <code>oAppData.oDefaultedSelectionVariant</code> is an empty selection variant and <code>oAppData.bNavSelVarHasDefaultsOnly</code> is <code>false</code> in this case.<br> <b>Note:</b> If the navigation type is {@link sap.fe.navigation.NavType.initial} oAppData is an empty object!<br> If an error occurs, an error object of type {@link sap.fe.navigation.NavError}, URL parameters (if available) and the type of navigation are returned."},"description":"Parses the incoming URL and returns a Promise. If this method detects a back navigation, the inner app state is returned in the resolved Promise. Otherwise startup parameters will be merged into the app state provided by cross app navigation, and a combined app state will be returned. The conflict resolution can be influenced with sParamHandlingMode defined in the constructor.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\"], function (NavigationHandler) {\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar oParseNavigationPromise = oNavigationHandler.parseNavigation();\n\n\toParseNavigationPromise.done(function(oAppData, oStartupParameters, sNavType){\n\t\t\toSmartFilterBar.setDataSuiteFormat(oAppData.selectionVariant);\n\t\t\t// oAppData.oSelectionVariant can be used to manipulate the selection variant\n\t\t\t// oAppData.oDefaultedSelectionVariant contains the parameters which are set by user defaults\n\t\t\t// oAppData.bNavSelVarHasDefaultsOnly indicates whether only defaulted parameters and no navigation parameters are present\n\t});\n\toParseNavigationPromise.fail(function(oError, oURLParameters, sNavType){\n\t\t// if e.g. the xapp state could not be loaded, nevertheless there may be URL parameters available\n\t\t//some error handling\n\t});\n});\n</code>"}]},{"name":"processBeforeSmartLinkPopoverOpens","visibility":"public","static":true,"returnValue":{"type":"object","description":"A Promise object to monitor when all actions of the function have been executed; if the execution is successful, the modified oTableEventParameters is returned; if an error occurs, an error object of type {@link sap.fe.navigation.NavError} is returned"},"parameters":[{"name":"oTableEventParameters","type":"object","optional":false,"description":"The parameters made available by the SmartTable control when the SmartLink control has been clicked, an instance of a PopOver object"},{"name":"sSelectionVariant","type":"string","optional":false,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control"},{"name":"mInnerAppData","type":"object","optional":true,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"string","optional":true,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the the SmartFilterBar control; if provided, the selection is merged into the semantic attributes"},"tableVariantId":{"name":"tableVariantId","type":"string","optional":true,"description":"ID of the SmartTable variant"},"customData":{"name":"customData","type":"object","optional":true,"description":"Object that can be used to store additional app-specific data"},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui presentationVariantof the app"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions"},"semanticDates":{"name":"semanticDates","type":"object","optional":true,"description":"Object containing semanticDates filter information"}},"description":"Object containing the current state of the app. If provided, opening the Popover is deferred until the inner app data is saved in a consistent way."},{"name":"oExternalAppData","type":"object","optional":true,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"object","optional":true,"description":"Object containing selectionVariant, which will be passed to the target screen. If not set the sSelectionVariant will be used."},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui presentationVariant of the app, which will be passed to the target screen"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions, which will be passed to the target screen"}},"description":"Object containing the state which will be passed to the target screen."}],"description":"Processes navigation-related tasks related to beforePopoverOpens event handling for the SmartLink control and returns a Promise object. In particular, the following tasks are performed before the SmartLink popover can be opened: <ul> <li>If <code>mInnerAppData</code> is provided, this inner app state is saved for back navigation at a later time.</li> <li>The table event parameters (semantic attributes) and the selection variant data are combined by calling the method {@link #.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant}.</li> <li>The combined data is saved as the cross app state to be handed over to the target app, and the corresponding sap-xapp-state key is set in the URL.</li> <li>All single selections (\"including equal\") of the combined selection data are passed to the SmartLink popover as semantic attributes.</li> <li>The method <code>oTableEventParameters.open()</code> is called. Note that this does not really open the popover, but the SmartLink control proceeds with firing the event <code>navigationTargetsObtained</code>.</li> </ul>.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\", \"sap/fe/navigation/SelectionVariant\"], function (NavigationHandler, SelectionVariant) {\n\t//event handler for the smart link event \"beforePopoverOpens\"\n\t\tonBeforePopoverOpens: function(oEvent) {\n\t\t\tvar oTableEventParameters = oEvent.getParameters();\n\n\t\t\tvar mInnerAppData = {\n\t\t\t\tselectionVariant : oSmartFilterBar.getDataSuiteFormat(),\n\t\t\t\ttableVariantId : oSmartTable.getCurrentVariantId(),\n\t\t\t\tcustomData : oMyCustomData\n\t\t\t};\n\n\t\t\tvar oSelectionVariant = new SelectionVariant();\n\t\t\toSelectionVariant.addSelectOption(\"CompanyCode\", \"I\", \"EQ\", \"0001\");\n\t\t\toSelectionVariant.addSelectOption(\"Customer\", \"I\", \"EQ\", \"C0001\");\n\t\t\tvar sSelectionVariant= oSelectionVariant.toJSONString();\n\n\t\t\tvar oNavigationHandler = new NavigationHandler(oController);\n\t\t\tvar oSmartLinkPromise = oNavigationHandler.processBeforeSmartLinkPopoverOpens(oTableEventParameters, sSelectionVariant, mInnerAppData);\n\n\t\t\toSmartLinkPromise.done(function(oTableEventParameters){\n\t\t\t\t// here you can add coding that should run after all app states are saved and the semantic attributes are set\n\t\t\t});\n\n\t\t\toSmartLinkPromise.fail(function(oError){\n\t\t\t//some error handling\n\t\t\t});\n\t\t};\n\t});\n</code>"}]},{"name":"replaceHash","visibility":"public","static":true,"parameters":[{"name":"sAppStateKey","type":"string","optional":false,"description":"The new app state key."}],"description":"Changes the URL according to the current sAppStateKey. As an reaction route change event will be triggered."},{"name":"setModel","visibility":"public","static":true,"parameters":[{"name":"oModel","type":"sap.ui.model.odata.v2.ODataModel","optional":false,"description":"For checking sensitive information"}],"description":"Sets the model that is used for verification of sensitive information. If the model is not set, the unnamed component model is used for the verification of sensitive information."},{"name":"setTechnicalParameters","visibility":"public","static":true,"parameters":[{"name":"aTechnicalParameters","type":"Array","optional":false,"description":"List of parameter names to be considered as technical parameters. <code>null</code> or <code>undefined</code> may be used to reset the complete list."}],"description":"Sets the application specific technical parameters. Technical parameters will not be added to the selection variant passed to the application. As a default the following values are considered as technical parameters: <ul> <li><code>sap-system</code></li> <li><code>sap-ushell-defaultedParameterNames</code></li> <li><code>\"hcpApplicationId\"</code></li> </ul>."},{"name":"storeInnerAppState","visibility":"public","static":true,"returnValue":{"type":"object","description":"A Promise object to monitor when all the actions of the function have been executed; if the execution is successful, the app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError} is returned"},"parameters":[{"name":"mInnerAppData","type":"object","optional":false,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"string","optional":false,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control"},"tableVariantId":{"name":"tableVariantId","type":"string","optional":true,"description":"ID of the SmartTable variant"},"customData":{"name":"customData","type":"object","optional":true,"description":"Object that can be used to store additional app-specific data"},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui state of the app"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions"},"semanticDates":{"name":"semanticDates","type":"object","optional":true,"description":"Object containing semanticDates filter information"}},"description":"Object containing the current state of the app"},{"name":"bImmediateHashReplace","type":"boolean","optional":true,"defaultValue":true,"description":"If set to false, the inner app hash will not be replaced until storing is successful; do not set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed event"}],"description":"Changes the URL according to the current app state and stores the app state for later retrieval.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\"], function (NavigationHandler) {\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar mInnerAppData = {\n\t\tselectionVariant : oSmartFilterBar.getDataSuiteFormat(),\n\t\ttableVariantId : oSmartTable.getCurrentVariantId(),\n\t\tcustomData : oMyCustomData\n\t};\n\n\tvar oStoreInnerAppStatePromise = oNavigationHandler.storeInnerAppState(mInnerAppData);\n\n\toStoreInnerAppStatePromise.done(function(sAppStateKey){\n\t\t//your inner app state is saved now, sAppStateKey was added to URL\n\t\t//perform actions that must run after save\n\t});\n\n\toStoreInnerAppStatePromise.fail(function(oError){\n\t\t//some error handling\n\t});\n});\n</code>"}]},{"name":"storeInnerAppStateWithImmediateReturn","visibility":"public","static":true,"returnValue":{"type":"object","description":"An object containing the appStateId and a promise object to monitor when all the actions of the function have been executed; Please note that the appStateKey may be undefined or empty."},"parameters":[{"name":"mInnerAppData","type":"object","optional":false,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"string","optional":false,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control"},"tableVariantId":{"name":"tableVariantId","type":"string","optional":true,"description":"ID of the SmartTable variant"},"customData":{"name":"customData","type":"object","optional":true,"description":"Object that can be used to store additional app-specific data"},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui state of the app"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions"},"semanticDates":{"name":"semanticDates","type":"object","optional":true,"description":"Object containing semanticDates filter information"}},"description":"Object containing the current state of the app"},{"name":"bImmediateHashReplace","type":"boolean","optional":true,"defaultValue":false,"description":"If set to false, the inner app hash will not be replaced until storing is successful; do not set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed event. <b>Note:</b>If not provided it will be treated as set to false. <b>Note:</b>If set to true, the calling instance has to ensure that a follow-on call to <code>replaceHash</code> will take place!"}],"description":"Changes the URL according to the current app state and stores the app state for later retrieval.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\"], function (NavigationHandler) {\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar mInnerAppData = {\n\t\tselectionVariant : oSmartFilterBar.getDataSuiteFormat(),\n\t\ttableVariantId : oSmartTable.getCurrentVariantId(),\n\t\tcustomData : oMyCustomData\n\t};\n\n\tvar oStoreInnerAppState = storeInnerAppStateWithNonDelayedReturn(mInnerAppData);\n\tvar sAppStateKey = oStoreInnerAppState.appStateKey;\n\tif (!sAppStateKey) {\n   // no appStateKey obtained...\n\t};\n\tvar oStoreInnerAppStatePromise = oStoreInnerAppState.promise;\n\n\toStoreInnerAppStatePromise.done(function(sAppStateKey){\n\t\t//your inner app state is saved now, sAppStateKey was added to URL\n\t\t//perform actions that must run after save\n\t});\n\n\toStoreInnerAppStatePromise.fail(function(oError){\n\t\t//some error handling\n\t});\n});\n</code>"}]}]},{"kind":"enum","name":"sap.fe.navigation.NavType","basename":"NavType","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"NavType","static":true,"visibility":"public","since":"1.83.0","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.NavType}.<br> A static enumeration type which indicates the type of inbound navigation.","properties":[{"name":"iAppState","visibility":"public","static":true,"type":"undefined","description":"Back navigation with sap-iapp-state parameter"},{"name":"initial","visibility":"public","static":true,"type":"undefined","description":"Initial startup without any navigation or default parameters"},{"name":"URLParams","visibility":"public","static":true,"type":"undefined","description":"Basic cross-app navigation with URL parameters only (without sap-xapp-state) or initial start with default parameters"},{"name":"xAppState","visibility":"public","static":true,"type":"undefined","description":"Cross-app navigation with sap-xapp-state parameter (and URL parameters), defaulted parameters may be added"}]},{"kind":"enum","name":"sap.fe.navigation.ParamHandlingMode","basename":"ParamHandlingMode","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"ParamHandlingMode","static":true,"visibility":"public","since":"1.83.0","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.ParamHandlingMode}.<br> A static enumeration type which indicates the conflict resolution method when merging URL parameters into select options.","properties":[{"name":"InsertInSelOpt","visibility":"public","static":true,"type":"undefined","description":"The conflict resolution adds URL parameters to the SelectionVariant"},{"name":"SelVarWins","visibility":"public","static":true,"type":"undefined","description":"The conflict resolution favors the SelectionVariant over URL parameters"},{"name":"URLParamWins","visibility":"public","static":true,"type":"undefined","description":"The conflict resolution favors the URL parameters over the SelectionVariant. Caution: In case of cross-app navigation a navigation parameter value from the source app is overwritten by a default, if a default is maintained in the launchpad designer for this parameter in the target app!"}]},{"kind":"class","name":"sap.fe.navigation.PresentationVariant","basename":"PresentationVariant","resource":"sap/fe/navigation/PresentationVariant.js","module":"sap/fe/navigation/PresentationVariant","export":"","static":true,"visibility":"public","since":"1.83.0","extends":"sap.ui.base.Object","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.PresentationVariant}.<br> Creates a new instance of a PresentationVariant class. If no parameter is passed, an new empty instance is created whose ID has been set to <code>\"\"</code>. Passing a JSON-serialized string complying to the Selection Variant Specification will parse it, and the newly created instance will contain the same information.","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"vPresentationVariant","type":"string|object","optional":true,"description":"If of type <code>string</code>, the selection variant is JSON-formatted; if of type <code>object</code>, the object represents a selection variant"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>PresentationVariant.INVALID_INPUT_TYPE</td><td>Indicates that the data format of the selection variant provided is inconsistent</td></tr> <tr><td>PresentationVariant.UNABLE_TO_PARSE_INPUT</td><td>Indicates that the provided string is not a JSON-formatted string</td></tr> <tr><td>PresentationVariant.INPUT_DOES_NOT_CONTAIN_SELECTIONVARIANT_ID</td><td>Indicates that the PresentationVariantID cannot be retrieved</td></tr> <tr><td>PresentationVariant.PARAMETER_WITHOUT_VALUE</td><td>Indicates that there was an attempt to specify a parameter, but without providing any value (not even an empty value)</td></tr> <tr><td>PresentationVariant.SELECT_OPTION_WITHOUT_PROPERTY_NAME</td><td>Indicates that a selection option has been defined, but the Ranges definition is missing</td></tr> <tr><td>PresentationVariant.SELECT_OPTION_RANGES_NOT_ARRAY</td><td>Indicates that the Ranges definition is not an array</td></tr> </table> These exceptions can only be thrown if the parameter <code>vPresentationVariant</code> has been provided.","type":"undefined"}]},"methods":[{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.navigation.PresentationVariant with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.base.Object.extend}."},{"name":"getChartVisualization","visibility":"public","static":true,"returnValue":{"type":"Object<string,any>","description":"An object containing the properties to be used for the chart visualization."},"description":"Gets the chart visualization property."},{"name":"getContextUrl","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current context URL for the query"},"description":"Gets the current context URL intended for the query."},{"name":"getID","visibility":"public","static":true,"returnValue":{"type":"string","description":"The identification of the selection variant as made available during construction"},"description":"Returns the identification of the selection variant."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.navigation.PresentationVariant."},{"name":"getProperties","visibility":"public","static":true,"returnValue":{"type":"Object<string,any>","description":"The current properties."},"description":"Gets the more trivial properties. Basically all properties with the exception of the Visualization."},{"name":"getTableVisualization","visibility":"public","static":true,"returnValue":{"type":"Object<string,any>","description":"An object containing the properties to be used for the table visualization."},"description":"Gets the table visualization property."},{"name":"getText","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current description of this selection variant."},"description":"Returns the current text / description of this selection variant."},{"name":"isEmpty","visibility":"public","static":true,"returnValue":{"type":"boolean","description":"If set to <code>true</code> there are no current properties set; <code>false</code> otherwise."},"description":"Returns <code>true</code> if the presentation variant does not contain any properties. nor ranges."},{"name":"setChartVisualization","visibility":"public","static":true,"parameters":[{"name":"mProperties","type":"Object<string,any>","optional":false,"description":"An object containing the properties to be used for the chart visualization."}],"description":"Sets the chart visualization property."},{"name":"setContextUrl","visibility":"public","static":true,"parameters":[{"name":"sURL","type":"string","optional":false,"description":"The URL of the context"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>PresentationVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the context URL."},{"name":"setID","visibility":"public","static":true,"parameters":[{"name":"sId","type":"string","optional":false,"description":"The new identification of the selection variant"}],"description":"Sets the identification of the selection variant."},{"name":"setProperties","visibility":"public","static":true,"parameters":[{"name":"mProperties","type":"Object<string,any>","optional":false,"description":"The properties to be used."}],"description":"Sets the more trivial properties. Basically all properties with the exception of the Visualization."},{"name":"setTableVisualization","visibility":"public","static":true,"parameters":[{"name":"mProperties","type":"Object<string,any>","optional":false,"description":"An object containing the properties to be used for the table visualization."}],"description":"Sets the table visualization property."},{"name":"setText","visibility":"public","static":true,"parameters":[{"name":"sNewText","type":"string","optional":false,"description":"The new description to be used"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>PresentationVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the text / description of the selection variant."},{"name":"toJSONObject","visibility":"public","static":true,"returnValue":{"type":"object","description":"The external representation of this instance as a JSON object"},"description":"Returns the external representation of the selection variant as JSON object."},{"name":"toJSONString","visibility":"public","static":true,"returnValue":{"type":"string","description":"The JSON-formatted representation of this instance in stringified format"},"description":"Serializes this instance into a JSON-formatted string."}]},{"kind":"class","name":"sap.fe.navigation.SelectionVariant","basename":"SelectionVariant","resource":"sap/fe/navigation/SelectionVariant.js","module":"sap/fe/navigation/SelectionVariant","export":"","static":true,"visibility":"public","since":"1.83.0","extends":"sap.ui.base.Object","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.SelectionVariant}.<br> Creates a new instance of a SelectionVariant class. If no parameter is passed, an new empty instance is created whose ID has been set to <code>\"\"</code>. Passing a JSON-serialized string complying to the Selection Variant Specification will parse it, and the newly created instance will contain the same information.","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"vSelectionVariant","type":"string|object","optional":true,"description":"If of type <code>string</code>, the selection variant is JSON-formatted; if of type <code>object</code>, the object represents a selection variant"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that the data format of the selection variant provided is inconsistent</td></tr> <tr><td>SelectionVariant.UNABLE_TO_PARSE_INPUT</td><td>Indicates that the provided string is not a JSON-formatted string</td></tr> <tr><td>SelectionVariant.INPUT_DOES_NOT_CONTAIN_SELECTIONVARIANT_ID</td><td>Indicates that the SelectionVariantID cannot be retrieved</td></tr> <tr><td>SelectionVariant.PARAMETER_WITHOUT_VALUE</td><td>Indicates that there was an attempt to specify a parameter, but without providing any value (not even an empty value)</td></tr> <tr><td>SelectionVariant.SELECT_OPTION_WITHOUT_PROPERTY_NAME</td><td>Indicates that a selection option has been defined, but the Ranges definition is missing</td></tr> <tr><td>SelectionVariant.SELECT_OPTION_RANGES_NOT_ARRAY</td><td>Indicates that the Ranges definition is not an array</td></tr> </table> These exceptions can only be thrown if the parameter <code>vSelectionVariant</code> has been provided.","type":"undefined"}]},"methods":[{"name":"addParameter","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the parameter to be set; the <code>null</code> value is not allowed"},{"name":"sValue","type":"string","optional":false,"description":"The value of the parameter to be set"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.PARAMETER_WITHOUT_NAME</td><td>Indicates that the name of the parameter has not been specified</td></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type or the value is set to <code>null</code></td></tr> <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another SelectOption with the same name as the parameter already exists</td></tr> </table>","type":"undefined"}],"description":"Sets the value of a parameter called <code>sName</code> to the new value <code>sValue</code>. If the parameter has already been set before, its value is overwritten."},{"name":"addSelectOption","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining."},"parameters":[{"name":"sPropertyName","type":"string","optional":false,"description":"The name of the property for which the selection range is added"},{"name":"sSign","type":"string","optional":false,"description":"The sign of the range (<b>I</b>nclude or <b>E</b>xclude)"},{"name":"sOption","type":"string","optional":false,"description":"The option of the range (<b>EQ</b> for \"equals\", <b>NE</b> for \"not equals\", <b>LE</b> for \"less or equals\", <b>GE</b> for \"greater or equals\", <b>LT</b> for \"less than\" (and not equals), <b>GT</b> for \"greater than\" (and not equals), <b>BT</b> for \"between\", or <b>CP</b> for \"contains pattern\" (ABAP-styled pattern matching with the asterisk as wildcard)"},{"name":"sLow","type":"string","optional":false,"description":"The single value or the lower boundary of the interval; the <code>null</code> value is not allowed"},{"name":"sHigh","type":"string","optional":true,"description":"Set only if sOption is <b>BT</b>: the upper boundary of the interval; must be <code>undefined</code> or <code>null</code> in all other cases"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_SIGN</td><td>Indicates that the sign is an invalid expression</td></tr> <tr><td>SelectionVariant.INVALID_OPTION</td><td>Indicates that the option is an invalid expression</td></tr> <tr><td>SelectionVariant.HIGH_PROVIDED_THOUGH_NOT_ALLOWED</td><td>Indicates that the upper boundary has been specified, even though the option is not 'BT'</td></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type or the value is set to <code>null</code></td></tr> <tr><td>SelectionVariant.INVALID_PROPERTY_NAME</td><td>Indicates that the property name is invalid, for example, it has not been specified</td></tr> <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another parameter with the same name as the property name already exists</td></tr> </table>","type":"undefined"}],"description":"Adds a new range to the list of select options for a given parameter."},{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.navigation.SelectionVariant with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.base.Object.extend}."},{"name":"getFilterContextUrl","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current context URL for the filters"},"description":"Gets the current context URL intended for the filters."},{"name":"getID","visibility":"public","static":true,"returnValue":{"type":"string","description":"The identification of the selection variant as made available during construction"},"description":"Returns the identification of the selection variant."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.navigation.SelectionVariant."},{"name":"getParameter","visibility":"public","static":true,"returnValue":{"type":"string","description":"The value of parameter <code>sName</code>; returning the value <code>null</code> not possible"},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the parameter to be returned"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Returns the value of the parameter called <code>sName</code> if it has been set. If the parameter has never been set or has been removed, <code>undefined</code> is returned."},{"name":"getParameterContextUrl","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current context URL for the parameters"},"description":"Gets the current context URL intended for the parameters."},{"name":"getParameterNames","visibility":"public","static":true,"returnValue":{"type":"Array","description":"The list of parameter names which are valid"},"description":"Returns the set of parameter names available in this selection variant."},{"name":"getPropertyNames","visibility":"public","static":true,"returnValue":{"type":"Array","description":"The list of parameter and select option property names available for this instance"},"description":"Returns the names of the parameter and select option properties available for this instance."},{"name":"getSelectOption","visibility":"public","static":true,"returnValue":{"type":"Array","description":"If <code>sPropertyName</code> is an invalid name of a property or no range exists, <code>undefined</code> is returned; otherwise, an immutable array of ranges is returned. Each entry of the array is an object with the following properties: <ul> <li><code>Sign</code>: The sign of the range</li> <li><code>Option</code>: The option of the range</li> <li><code>Low</code>: The low value of the range; returning value <code>null</code> is not possible</li> <li><code>High</code>: The high value of the range; if this value is not necessary, <code>null</code> is used</li> </ul> For further information about the meaning of the attributes, refer to method <code>addSelectOption</code>."},"parameters":[{"name":"sPropertyName","type":"string","optional":false,"description":"The name of the property for which the set of select options/ranges is returned"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> <tr><td>SelectionVariant.INVALID_PROPERTY_NAME</td><td>Indicates that the property name is invalid, for example, it has not been specified</td></tr> </table>","type":"undefined"}],"description":"Returns the set of select options/ranges available for a given property name."},{"name":"getSelectOptionsPropertyNames","visibility":"public","static":true,"returnValue":{"type":"Array","description":"The list of property names available for this instance"},"description":"Returns the names of the properties available for this instance."},{"name":"getText","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current description of this selection variant."},"description":"Returns the current text / description of this selection variant."},{"name":"getValue","visibility":"public","static":true,"returnValue":{"type":"Array","description":"The ranges in the select options for the specified property or a range-converted representation of a parameter is returned. If both lookups fail, <code>undefined</code> is returned. <br /> The returned ranges have the format: <ul> <li><code>Sign</code>: The sign of the range</li> <li><code>Option</code>: The option of the range</li> <li><code>Low</code>: The low value of the range; returning the value <code>null</code> is not possible</li> <li><code>High</code>: The high value of the range; if this value is not necessary, <code>null</code> (but does exist)</li> </ul> For further information on the meaning of the attributes, refer to method {@link #.addSelectOption addSelectOption}."},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the attribute for which the value is retrieved"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> <tr><td>SelectionVariant.INVALID_PROPERTY_NAME</td><td>Indicates that the property name is invalid, for example, it has not been specified</td></tr> </table>","type":"undefined"}],"description":"First tries to retrieve the set of select options/ranges available for <code>sName</code> as property name. If successful, this array of selections is being returned. If it fails, an attempt to find a parameter, whose name is <code>sName</code>, is made. If the latter succeeds, the single value is converted to fit into an array of selections to make it type compatible with ranges. This array is then returned. <br /> If neither a select option nor a parameter could be found, <code>undefined</code> is returned."},{"name":"isEmpty","visibility":"public","static":true,"returnValue":{"type":"boolean","description":"If set to <code>true</code> there are no parameters and no select options available in the selection variant; <code>false</code> otherwise."},"description":"Returns <code>true</code> if the selection variant does neither contain parameters nor ranges."},{"name":"massAddSelectOption","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sPropertyName","type":"string","optional":false,"description":"The name of the property for which the set of select options is added"},{"name":"aSelectOptions","type":"Array","optional":false,"description":"Set of select options to be added"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Adds a set of select options to the list of select options for a given parameter."},{"name":"removeParameter","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the parameter to be removed"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.PARAMETER_WITHOUT_NAME</td><td>Indicates that name of the parameter has not been specified</td></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Removes a parameter called <code>sName</code> from the selection variant."},{"name":"removeSelectOption","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining."},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the select option to be removed"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.SELOPT_WITHOUT_NAME</td><td>Indicates that name of the select option has not been specified</td></tr> <tr><td>SelectionVariant.SELOPT_WRONG_TYPE</td><td>Indicates that the name of the parameter <code>sName</code> has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Removes a select option called <code>sName</code> from the selection variant."},{"name":"renameParameter","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sNameOld","type":"string","optional":false,"description":"The current name of the parameter to be renamed"},{"name":"sNameNew","type":"string","optional":false,"description":"The new name of the parameter"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.PARAMETER_WITHOUT_NAME</td><td>Indicates that the name of a parameter has not been specified</td></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another select option with the same new name already exists</td></tr> <tr><td>SelectionVariant.PARAMETER_COLLISION</td><td>Indicates that another parameter with the same new name already exists</td></tr> </table>","type":"undefined"}],"description":"Renames a parameter called <code>sNameOld</code> to <code>sNameNew</code>. If a parameter or a select option with the name <code>sNameNew</code> already exist, an error is thrown. If a parameter with the name <code>sNameOld</code> does not exist, nothing is changed."},{"name":"renameSelectOption","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sNameOld","type":"string","optional":false,"description":"The current name of the select option property to be renamed"},{"name":"sNameNew","type":"string","optional":false,"description":"The new name of the select option property"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.SELOPT_WITHOUT_NAME</td><td>Indicates that the name of a select option has not been specified</td></tr> <tr><td>SelectionVariant.SELOPT_WRONG_TYPE</td><td>Indicates that a select option has an invalid type</td></tr> <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another parameter with the same new name already exists</td></tr> <tr><td>SelectionVariant.SELOPT_COLLISION</td><td>Indicates that another select option with the same new name already exists</td></tr> </table>","type":"undefined"}],"description":"Renames a select option called <code>sNameOld</code> to <code>sNameNew</code>. If a select option or a parameter with the name <code>sNameNew</code> already exist, an error is thrown. If a select option with the name <code>sNameOld</code> does not exist, nothing is changed."},{"name":"setFilterContextUrl","visibility":"public","static":true,"parameters":[{"name":"sURL","type":"string","optional":false,"description":"The URL of the filters"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the context URL intended for the filters."},{"name":"setID","visibility":"public","static":true,"parameters":[{"name":"sId","type":"string","optional":false,"description":"The new identification of the selection variant"}],"description":"Sets the identification of the selection variant."},{"name":"setParameterContextUrl","visibility":"public","static":true,"parameters":[{"name":"sURL","type":"string","optional":false,"description":"The URL of the parameter context"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the context URL intended for the parameters."},{"name":"setText","visibility":"public","static":true,"parameters":[{"name":"sNewText","type":"string","optional":false,"description":"The new description to be used"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the text / description of the selection variant."},{"name":"toJSONObject","visibility":"public","static":true,"returnValue":{"type":"object","description":"The external representation of this instance as a JSON object"},"description":"Returns the external representation of the selection variant as JSON object."},{"name":"toJSONString","visibility":"public","static":true,"returnValue":{"type":"string","description":"The JSON-formatted representation of this instance in stringified format"},"description":"Serializes this instance into a JSON-formatted string."}]},{"kind":"enum","name":"sap.fe.navigation.SuppressionBehavior","basename":"SuppressionBehavior","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"SuppressionBehavior","static":true,"visibility":"public","since":"1.83.0","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.SuppressionBehavior}.<br> A static enumeration type which indicates whether semantic attributes with values <code>null</code>, <code>undefined</code> or <code>\"\"</code> (empty string) shall be suppressed, before they are mixed in to the selection variant in the method {@link sap.fe.navigation.NavigationHandler.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant} of the {@link sap.fe.navigation.NavigationHandler NavigationHandler}.","properties":[{"name":"ignoreEmptyString","visibility":"public","static":true,"type":"undefined","description":"Semantic attributes with an empty string are ignored, the remaining attributes are mixed in to the selection variant. Warning! Consider the impact on Boolean variable values!"},{"name":"raiseErrorOnNull","visibility":"public","static":true,"type":"undefined","description":"Semantic attributes with a <code>null</code> value lead to an {@link sap.fin.central.lib.error.Error error} of type NavigationHandler.INVALID_INPUT"},{"name":"raiseErrorOnUndefined","visibility":"public","static":true,"type":"undefined","description":"Semantic attributes with an <code>undefined</code> value lead to an {@link sap.fin.central.lib.error.Error error} of type NavigationHandler.INVALID_INPUT"},{"name":"standard","visibility":"public","static":true,"type":"undefined","description":"Standard suppression behavior: semantic attributes with a <code>null</code> or an <code>undefined</code> value are ignored, the remaining attributes are mixed in to the selection variant"}]}]}
+{"$schema-ref":"http://schemas.sap.com/sapui5/designtime/api.json/1.0","version":"1.98.0","library":"sap.fe.navigation","symbols":[{"kind":"namespace","name":"sap.fe.navigation","basename":"navigation","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"","static":true,"visibility":"public","since":"1.83.0","description":"Common library for all cross-application navigation functions."},{"kind":"enum","name":"sap.fe.navigation.Mode","basename":"Mode","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"Mode","static":true,"visibility":"public","since":"1.83.0","description":"A static enumeration type which indicates the Odata version used for runnning the Navigation Handler.","properties":[{"name":"ODataV2","visibility":"public","static":true,"type":"undefined","description":"This is used for ODataV2 services to do some internal tasks like creation of appstate, removal of sensitive data etc.,"},{"name":"ODataV4","visibility":"public","static":true,"type":"undefined","description":"This is used for ODataV4 services to do some internal tasks like creation of appstate, removal of sensitive data etc.,"}]},{"kind":"class","name":"sap.fe.navigation.NavError","basename":"NavError","resource":"sap/fe/navigation/NavError.js","module":"sap/fe/navigation/NavError","export":"","static":true,"visibility":"public","since":"1.83.0","extends":"sap.ui.base.Object","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.NavError}.<br> An object that provides error handling information during runtime.","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"sErrorCode","type":"string","optional":false,"description":"The code for an internal error of a consumer that allows you to track the source locations"}],"description":"Accepts an object literal <code>mSettings</code> that defines initial property values, aggregated and associated objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.\n\nThis class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.Object#constructor sap.ui.base.Object} can be used."},"methods":[{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.navigation.NavError with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.base.Object.extend}."},{"name":"getErrorCode","visibility":"public","returnValue":{"type":"string","description":"The error code of the error"},"description":"Returns the error code with which the instance has been created."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.navigation.NavError."}]},{"kind":"class","name":"sap.fe.navigation.NavigationHandler","basename":"NavigationHandler","resource":"sap/fe/navigation/NavigationHandler.js","module":"sap/fe/navigation/NavigationHandler","export":"","static":true,"visibility":"public","since":"1.83.0","extends":"sap.ui.base.Object","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.NavigationHandler}.<br> Creates a new NavigationHandler class by providing the required environment. <br> The <code>NavigationHandler</code> supports the verification of sensitive information. All properties that are part of <code>selectionVariant</code> and <code>valueTexts</code> will be verified if they are annotated as <code>com.sap.vocabularies.PersonalData.v1.IsPotentiallySensitive</code> or <code>com.sap.vocabularies.UI.v1.ExcludeFromNavigationContext</code> and will be removed before the data is persisted as the app state.<br> Also, all properties annotated as <code>com.sap.vocabularies.Analytics.v1.Measure</code> will be removed from the data stored as the xapp state.<br> To verify the information to be removed, the <code>NavigationHandler</code> requires an unnamed model of type {@link sap.ui.model.odata.v2.ODataModel} on component level. It is possible to set such a model using the <code>setModel</code> method.<br> <b>Note:</b> The check for excluded data requires that the OData metadata has already been loaded completely.<br> If the OData metadata model has not been loaded completely, all properties are removed from the application context.<br> <b>Note:</b> This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation} is available and initialized.","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"oController","type":"object","optional":false,"description":"UI5 controller that contains a router and a component; typically the main controller of your application, for example, a subclass of the sap.ca.scfld.md.controller.BaseFullscreenController if scaffolding is used"},{"name":"sMode","type":"string","optional":true,"defaultValue":"sap.fe.navigation.Mode.ODataV4","description":"Mode to be used to indicates the Odata version used for runnning the Navigation Handler, see {@link sap.fe.navigation.Mode}.<br> Note: Mode has to be sap.fe.navigation.Mode.ODataV2 whenever this constructor is used to initialize a OData V2 based service."},{"name":"sParamHandlingMode","type":"string","optional":true,"defaultValue":"SelVarWins","description":"Mode to be used to handle conflicts when merging URL parameters and the SelectionVariant class, see {@link sap.fe.navigation.ParamHandlingMode}"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr> <th align=\"left\">NavError code</th> <th align=\"left\">Description</th> </tr> <tr> <td>NavigationHandler.INVALID_INPUT</td> <td>Indicates that the input parameter is invalid</td> </tr> </table>","type":"undefined"}]},"methods":[{"name":"_getAppStateKeyAndUrlParameters","visibility":"restricted","static":true,"returnValue":{"type":"object","description":"A Promise object to monitor when all actions of the function have been executed; if the execution is successful, the semanticAttributes as well as the appStateKey are returned; if an error occurs, an error object of type {@link sap.fe.navigation.NavError} is returned <br>"},"parameters":[{"name":"sSelectionVariant","type":"string","optional":false,"description":"Stringified JSON object"}],"description":"Processes selectionVariant string and returns a Promise object (semanticAttributes and AppStateKey).","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\", \"sap/fe/navigation/SelectionVariant\"], function (NavigationHandler, SelectionVariant) {\n\t\tvar oSelectionVariant = new SelectionVariant();\n\t\toSelectionVariant.addSelectOption(\"CompanyCode\", \"I\", \"EQ\", \"0001\");\n\t\toSelectionVariant.addSelectOption(\"Customer\", \"I\", \"EQ\", \"C0001\");\n\t\tvar sSelectionVariant= oSelectionVariant.toJSONString();\n\n\t\tvar oNavigationHandler = new NavigationHandler(oController);\n\t\tvar oPromiseObject = oNavigationHandler._getAppStateKeyAndUrlParameters(sSelectionVariant);\n\n\t\toPromiseObject.done(function(oSemanticAttributes, sAppStateKey){\n\t\t\t// here you can add coding that should run after all app state and the semantic attributes have been returned.\n\t\t});\n\n\t\toPromiseObject.fail(function(oError){\n\t\t\t//some error handling\n\t\t});\n\t});\n</code>"}]},{"name":"constructContextUrl","visibility":"protected","static":true,"returnValue":{"type":"string","description":"The context url for the given entities"},"parameters":[{"name":"sEntitySetName","type":"string","optional":false,"description":"Used for url determination"},{"name":"oModel","type":"sap.ui.model.odata.v2.ODataModel","optional":true,"description":"Used for url determination. If omitted, the NavigationHandler model is used."}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of missing or wrong passed parameters","type":"undefined"}],"description":"The method creates a context url based on provided data. This context url can either be used as {@link sap.fe.navigation.NavigationHandler#setParameterContextUrl ParameterContextUrl} or {@link sap.fe.navigation.NavigationHandler#setFilterContextUrl FilterContextUrl}."},{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.navigation.NavigationHandler with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.base.Object.extend}."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.navigation.NavigationHandler."},{"name":"getTechnicalParameters","visibility":"public","static":true,"returnValue":{"type":"Array","description":"Containing the technical parameters."},"description":"Gets the application specific technical parameters. Technical parameters will not be added to the selection variant passed to the application. As a default the following values are considered as technical parameters: <ul> <li><code>sap-system</code></li> <li><code>sap-ushell-defaultedParameterNames</code></li> <li><code>\"hcpApplicationId\"</code></li> </ul>."},{"name":"mixAttributesAndSelectionVariant","visibility":"public","static":true,"returnValue":{"type":"object","description":"Instance of {@link sap.fe.navigation.SelectionVariant}"},"parameters":[{"name":"vSemanticAttributes","type":"object|Array","optional":false,"description":"Object/(Array of Objects) containing key/value pairs"},{"name":"sSelectionVariant","type":"string","optional":false,"description":"The selection variant in string format as provided by the SmartFilterBar control"},{"name":"iSuppressionBehavior","type":"int","optional":true,"defaultValue":"sap.fe.navigation.SuppressionBehavior.standard","description":"Indicates whether semantic attributes with special values (see {@link sap.fe.navigation.SuppressionBehavior suppression behavior}) must be suppressed before they are combined with the selection variant; several {@link sap.fe.navigation.SuppressionBehavior suppression behaviors} can be combined with the bitwise OR operator (|)"}],"description":"Combines the given parameters and selection variant into a new selection variant containing properties from both, with the parameters overriding existing properties in the selection variant. The new selection variant does not contain any parameters. All parameters are merged into select options. The output of this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate} method.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\", \"sap/fe/navigation/SelectionVariant\"], function (NavigationHandler, SelectionVariant) {\n\tvar vSemanticAttributes = { \"Customer\" : \"C0001\" };\n\tor\n\tvar vSemanticAttributes = [{ \"Customer\" : \"C0001\" },{ \"Customer\" : \"C0002\" }];\n\tvar sSelectionVariant = oSmartFilterBar.getDataSuiteFormat();\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar sNavigationSelectionVariant = oNavigationHandler.mixAttributesAndSelectionVariant(vSemanticAttributes, sSelectionVariant).toJSONString();\n\t// In case of an vSemanticAttributes being an array, the semanticAttributes are merged to a single SV and compared against the sSelectionVariant(second agrument).\n\t// Optionally, you can specify one or several suppression behaviors. Several suppression behaviors are combined with the bitwise OR operator, e.g.\n\t// var iSuppressionBehavior = sap.fe.navigation.SuppressionBehavior.raiseErrorOnNull | sap.fe.navigation.SuppressionBehavior.raiseErrorOnUndefined;\n\t// var sNavigationSelectionVariant = oNavigationHandler.mixAttributesAndSelectionVariant(mSemanticAttributes, sSelectionVariant, iSuppressionBehavior).toJSONString();\n\n\toNavigationHandler.navigate(\"SalesOrder\", \"create\", sNavigationSelectionVariant);\n});\n</code>"}]},{"name":"navigate","visibility":"public","static":true,"parameters":[{"name":"sSemanticObject","type":"string","optional":false,"description":"Name of the semantic object of the target app"},{"name":"sActionName","type":"string","optional":false,"description":"Name of the action of the target app"},{"name":"vNavigationParameters","type":"object|string","optional":true,"description":"Navigation parameters as an object with key/value pairs or as a string representation of such an object. If passed as an object, the properties are not checked against the <code>IsPotentialSensitive</code> or <code>Measure</code> type."},{"name":"oInnerAppData","type":"object","optional":true,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"string","optional":true,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control"},"tableVariantId":{"name":"tableVariantId","type":"string","optional":true,"description":"ID of the SmartTable variant"},"customData":{"name":"customData","type":"object","optional":true,"description":"Object that can be used to store arbitrary data"},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui state of the app"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions"},"semanticDates":{"name":"semanticDates","type":"object","optional":true,"description":"Object containing semanticDates filter information"}},"description":"Object for storing current state of the app"},{"name":"fnOnError","type":"function","optional":true,"description":"Callback that is called if an error occurs during navigation <br>"},{"name":"oExternalAppData","type":"object","optional":false,"parameterProperties":{"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui state of the app which will be forwarded to the target component."},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions which will be forwarded to the target component."},"selectionVariant":{"name":"selectionVariant","type":"object","optional":true,"description":"Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant will be constructed based on the vNavigationParameters."}},"description":"Object for storing the state which will be forwarded to the target component."},{"name":"sNavMode","type":"string","optional":true,"description":"Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the <code>explace</code> or <code>inplace</code> values are allowed. Any other value will lead to an exception <code>NavigationHandler.INVALID_NAV_MODE</code>."}],"description":"Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode based on <code>sap-ushell-next-navmode</code> is taken into account. If set to <code>explace</code> the inner app state will not be changed. <b>Note:</b> The <code>sNavMode</code> argument can be used to overwrite the SAP Fiori launchpad default navigation for opening a URL in-place or ex-place.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\", \"sap/fe/navigation/SelectionVariant\"], function (NavigationHandler, SelectionVariant) {\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar sSemanticObject = \"SalesOrder\";\n\tvar sActionName = \"create\";\n\n\t//simple parameters as Object\n\tvar vNavigationParameters = {\n\t\tCompanyCode : \"0001\",\n\t\tCustomer : \"C0001\"\n\t};\n\n\t//or as selection variant\n\tvar oSelectionVariant = new SelectionVariant();\n\t oSelectionVariant.addSelectOption(\"CompanyCode\", \"I\", \"EQ\", \"0001\");\n\toSelectionVariant.addSelectOption(\"Customer\", \"I\", \"EQ\", \"C0001\");\n\tvNavigationParameters = oSelectionVariant.toJSONString();\n\n\t//or directly from SmartFilterBar\n\tvNavigationParameters = oSmartFilterBar.getDataSuiteFormat();\n\n\t//app state for back navigation\n\t var oInnerAppData = {\n\t\tselectionVariant : oSmartFilterBar.getDataSuiteFormat(),\n\t\ttableVariantId : oSmartTable.getCurrentVariantId(),\n\t\tcustomData : oMyCustomData\n\t};\n\n\t// callback function in case of errors\n\tvar fnOnError = function(oError){\n\t\tvar oi18n = oController.getView().getModel(\"i18n\").getResourceBundle();\n\t\toError.setUIText({oi18n : oi18n, sTextKey : \"OUTBOUND_NAV_ERROR\"});\n\t\toError.showMessageBox();\n\t};\n\n\toNavigationHandler.navigate(sSemanticObject, sActionName, vNavigationParameters, oInnerAppData, fnOnError);\n});\n</code>"}]},{"name":"parseNavigation","visibility":"public","static":true,"returnValue":{"type":"object","description":"A Promise object to monitor when all the actions of the function have been executed. If the execution is successful, the extracted app state, the startup parameters, and the type of navigation are returned, see also the example above. The app state is an object that contains the following information: <ul> <li><code>oAppData.oSelectionVariant</code>: An instance of {@link sap.fe.navigation.SelectionVariant} containing only parameters/select options that are related to navigation</li> <li><code>oAppData.selectionVariant</code>: The navigation-related selection variant as a JSON-formatted string</li> <li><code>oAppData.oDefaultedSelectionVariant</code>: An instance of {@link sap.fe.navigation.SelectionVariant} containing only the parameters/select options that are set by user default data</li> <li><code>oAppData.bNavSelVarHasDefaultsOnly</code>: A Boolean flag that indicates whether only defaulted parameters and no navigation parameters are present.<br> <b>Note:</b> If no navigation parameters are available, <code>bNavSelVarHasDefaultsOnly</code> is set to <code>true</code>, even though parameters without default might be available as well.</li> </ul> If the navigation-related selection variant is empty, it is replaced by a copy of the defaulted selection variant.<br> The navigation type is an enumeration type of type {@link sap.fe.navigation.NavType} (possible values are initial, URLParams, xAppState, and iAppState).<br> <b>Note:</b> If the navigation type is {@link sap.fe.navigation.NavType.iAppState} oAppData has two additional properties <ul> <li><code>oAppData.tableVariantId</code></li> <li><code>oAppData.customData</code></li> </ul> which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppState storeInnerAppState}. <code>oAppData.oDefaultedSelectionVariant</code> is an empty selection variant and <code>oAppData.bNavSelVarHasDefaultsOnly</code> is <code>false</code> in this case.<br> <b>Note:</b> If the navigation type is {@link sap.fe.navigation.NavType.initial} oAppData is an empty object!<br> If an error occurs, an error object of type {@link sap.fe.navigation.NavError}, URL parameters (if available) and the type of navigation are returned."},"description":"Parses the incoming URL and returns a Promise. If this method detects a back navigation, the inner app state is returned in the resolved Promise. Otherwise startup parameters will be merged into the app state provided by cross app navigation, and a combined app state will be returned. The conflict resolution can be influenced with sParamHandlingMode defined in the constructor.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\"], function (NavigationHandler) {\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar oParseNavigationPromise = oNavigationHandler.parseNavigation();\n\n\toParseNavigationPromise.done(function(oAppData, oStartupParameters, sNavType){\n\t\t\toSmartFilterBar.setDataSuiteFormat(oAppData.selectionVariant);\n\t\t\t// oAppData.oSelectionVariant can be used to manipulate the selection variant\n\t\t\t// oAppData.oDefaultedSelectionVariant contains the parameters which are set by user defaults\n\t\t\t// oAppData.bNavSelVarHasDefaultsOnly indicates whether only defaulted parameters and no navigation parameters are present\n\t});\n\toParseNavigationPromise.fail(function(oError, oURLParameters, sNavType){\n\t\t// if e.g. the xapp state could not be loaded, nevertheless there may be URL parameters available\n\t\t//some error handling\n\t});\n});\n</code>"}]},{"name":"processBeforeSmartLinkPopoverOpens","visibility":"public","static":true,"returnValue":{"type":"object","description":"A Promise object to monitor when all actions of the function have been executed; if the execution is successful, the modified oTableEventParameters is returned; if an error occurs, an error object of type {@link sap.fe.navigation.NavError} is returned"},"parameters":[{"name":"oTableEventParameters","type":"object","optional":false,"description":"The parameters made available by the SmartTable control when the SmartLink control has been clicked, an instance of a PopOver object"},{"name":"sSelectionVariant","type":"string","optional":false,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control"},{"name":"mInnerAppData","type":"object","optional":true,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"string","optional":true,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the the SmartFilterBar control; if provided, the selection is merged into the semantic attributes"},"tableVariantId":{"name":"tableVariantId","type":"string","optional":true,"description":"ID of the SmartTable variant"},"customData":{"name":"customData","type":"object","optional":true,"description":"Object that can be used to store additional app-specific data"},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui presentationVariantof the app"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions"},"semanticDates":{"name":"semanticDates","type":"object","optional":true,"description":"Object containing semanticDates filter information"}},"description":"Object containing the current state of the app. If provided, opening the Popover is deferred until the inner app data is saved in a consistent way."},{"name":"oExternalAppData","type":"object","optional":true,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"object","optional":true,"description":"Object containing selectionVariant, which will be passed to the target screen. If not set the sSelectionVariant will be used."},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui presentationVariant of the app, which will be passed to the target screen"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions, which will be passed to the target screen"}},"description":"Object containing the state which will be passed to the target screen."}],"description":"Processes navigation-related tasks related to beforePopoverOpens event handling for the SmartLink control and returns a Promise object. In particular, the following tasks are performed before the SmartLink popover can be opened: <ul> <li>If <code>mInnerAppData</code> is provided, this inner app state is saved for back navigation at a later time.</li> <li>The table event parameters (semantic attributes) and the selection variant data are combined by calling the method {@link #.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant}.</li> <li>The combined data is saved as the cross app state to be handed over to the target app, and the corresponding sap-xapp-state key is set in the URL.</li> <li>All single selections (\"including equal\") of the combined selection data are passed to the SmartLink popover as semantic attributes.</li> <li>The method <code>oTableEventParameters.open()</code> is called. Note that this does not really open the popover, but the SmartLink control proceeds with firing the event <code>navigationTargetsObtained</code>.</li> </ul>.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\", \"sap/fe/navigation/SelectionVariant\"], function (NavigationHandler, SelectionVariant) {\n\t//event handler for the smart link event \"beforePopoverOpens\"\n\t\tonBeforePopoverOpens: function(oEvent) {\n\t\t\tvar oTableEventParameters = oEvent.getParameters();\n\n\t\t\tvar mInnerAppData = {\n\t\t\t\tselectionVariant : oSmartFilterBar.getDataSuiteFormat(),\n\t\t\t\ttableVariantId : oSmartTable.getCurrentVariantId(),\n\t\t\t\tcustomData : oMyCustomData\n\t\t\t};\n\n\t\t\tvar oSelectionVariant = new SelectionVariant();\n\t\t\toSelectionVariant.addSelectOption(\"CompanyCode\", \"I\", \"EQ\", \"0001\");\n\t\t\toSelectionVariant.addSelectOption(\"Customer\", \"I\", \"EQ\", \"C0001\");\n\t\t\tvar sSelectionVariant= oSelectionVariant.toJSONString();\n\n\t\t\tvar oNavigationHandler = new NavigationHandler(oController);\n\t\t\tvar oSmartLinkPromise = oNavigationHandler.processBeforeSmartLinkPopoverOpens(oTableEventParameters, sSelectionVariant, mInnerAppData);\n\n\t\t\toSmartLinkPromise.done(function(oTableEventParameters){\n\t\t\t\t// here you can add coding that should run after all app states are saved and the semantic attributes are set\n\t\t\t});\n\n\t\t\toSmartLinkPromise.fail(function(oError){\n\t\t\t//some error handling\n\t\t\t});\n\t\t};\n\t});\n</code>"}]},{"name":"replaceHash","visibility":"public","static":true,"parameters":[{"name":"sAppStateKey","type":"string","optional":false,"description":"The new app state key."}],"description":"Changes the URL according to the current sAppStateKey. As an reaction route change event will be triggered."},{"name":"setModel","visibility":"public","static":true,"parameters":[{"name":"oModel","type":"sap.ui.model.odata.v2.ODataModel","optional":false,"description":"For checking sensitive information"}],"description":"Sets the model that is used for verification of sensitive information. If the model is not set, the unnamed component model is used for the verification of sensitive information."},{"name":"setTechnicalParameters","visibility":"public","static":true,"parameters":[{"name":"aTechnicalParameters","type":"Array","optional":false,"description":"List of parameter names to be considered as technical parameters. <code>null</code> or <code>undefined</code> may be used to reset the complete list."}],"description":"Sets the application specific technical parameters. Technical parameters will not be added to the selection variant passed to the application. As a default the following values are considered as technical parameters: <ul> <li><code>sap-system</code></li> <li><code>sap-ushell-defaultedParameterNames</code></li> <li><code>\"hcpApplicationId\"</code></li> </ul>."},{"name":"storeInnerAppState","visibility":"public","static":true,"returnValue":{"type":"object","description":"A Promise object to monitor when all the actions of the function have been executed; if the execution is successful, the app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError} is returned"},"parameters":[{"name":"mInnerAppData","type":"object","optional":false,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"string","optional":false,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control"},"tableVariantId":{"name":"tableVariantId","type":"string","optional":true,"description":"ID of the SmartTable variant"},"customData":{"name":"customData","type":"object","optional":true,"description":"Object that can be used to store additional app-specific data"},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui state of the app"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions"},"semanticDates":{"name":"semanticDates","type":"object","optional":true,"description":"Object containing semanticDates filter information"}},"description":"Object containing the current state of the app"},{"name":"bImmediateHashReplace","type":"boolean","optional":true,"defaultValue":true,"description":"If set to false, the inner app hash will not be replaced until storing is successful; do not set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed event"}],"description":"Changes the URL according to the current app state and stores the app state for later retrieval.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\"], function (NavigationHandler) {\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar mInnerAppData = {\n\t\tselectionVariant : oSmartFilterBar.getDataSuiteFormat(),\n\t\ttableVariantId : oSmartTable.getCurrentVariantId(),\n\t\tcustomData : oMyCustomData\n\t};\n\n\tvar oStoreInnerAppStatePromise = oNavigationHandler.storeInnerAppState(mInnerAppData);\n\n\toStoreInnerAppStatePromise.done(function(sAppStateKey){\n\t\t//your inner app state is saved now, sAppStateKey was added to URL\n\t\t//perform actions that must run after save\n\t});\n\n\toStoreInnerAppStatePromise.fail(function(oError){\n\t\t//some error handling\n\t});\n});\n</code>"}]},{"name":"storeInnerAppStateWithImmediateReturn","visibility":"public","static":true,"returnValue":{"type":"object","description":"An object containing the appStateId and a promise object to monitor when all the actions of the function have been executed; Please note that the appStateKey may be undefined or empty."},"parameters":[{"name":"mInnerAppData","type":"object","optional":false,"parameterProperties":{"selectionVariant":{"name":"selectionVariant","type":"string","optional":false,"description":"Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control"},"tableVariantId":{"name":"tableVariantId","type":"string","optional":true,"description":"ID of the SmartTable variant"},"customData":{"name":"customData","type":"object","optional":true,"description":"Object that can be used to store additional app-specific data"},"presentationVariant":{"name":"presentationVariant","type":"object","optional":true,"description":"Object containing the current ui state of the app"},"valueTexts":{"name":"valueTexts","type":"object","optional":true,"description":"Object containing value descriptions"},"semanticDates":{"name":"semanticDates","type":"object","optional":true,"description":"Object containing semanticDates filter information"}},"description":"Object containing the current state of the app"},{"name":"bImmediateHashReplace","type":"boolean","optional":true,"defaultValue":false,"description":"If set to false, the inner app hash will not be replaced until storing is successful; do not set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed event. <b>Note:</b>If not provided it will be treated as set to false. <b>Note:</b>If set to true, the calling instance has to ensure that a follow-on call to <code>replaceHash</code> will take place!"}],"description":"Changes the URL according to the current app state and stores the app state for later retrieval.","examples":[{"text":"<code>\nsap.ui.define([\"sap/fe/navigation/NavigationHandler\"], function (NavigationHandler) {\n\tvar oNavigationHandler = new NavigationHandler(oController);\n\tvar mInnerAppData = {\n\t\tselectionVariant : oSmartFilterBar.getDataSuiteFormat(),\n\t\ttableVariantId : oSmartTable.getCurrentVariantId(),\n\t\tcustomData : oMyCustomData\n\t};\n\n\tvar oStoreInnerAppState = storeInnerAppStateWithNonDelayedReturn(mInnerAppData);\n\tvar sAppStateKey = oStoreInnerAppState.appStateKey;\n\tif (!sAppStateKey) {\n   // no appStateKey obtained...\n\t};\n\tvar oStoreInnerAppStatePromise = oStoreInnerAppState.promise;\n\n\toStoreInnerAppStatePromise.done(function(sAppStateKey){\n\t\t//your inner app state is saved now, sAppStateKey was added to URL\n\t\t//perform actions that must run after save\n\t});\n\n\toStoreInnerAppStatePromise.fail(function(oError){\n\t\t//some error handling\n\t});\n});\n</code>"}]}]},{"kind":"enum","name":"sap.fe.navigation.NavType","basename":"NavType","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"NavType","static":true,"visibility":"public","since":"1.83.0","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.NavType}.<br> A static enumeration type which indicates the type of inbound navigation.","properties":[{"name":"iAppState","visibility":"public","static":true,"type":"undefined","description":"Back navigation with sap-iapp-state parameter"},{"name":"initial","visibility":"public","static":true,"type":"undefined","description":"Initial startup without any navigation or default parameters"},{"name":"URLParams","visibility":"public","static":true,"type":"undefined","description":"Basic cross-app navigation with URL parameters only (without sap-xapp-state) or initial start with default parameters"},{"name":"xAppState","visibility":"public","static":true,"type":"undefined","description":"Cross-app navigation with sap-xapp-state parameter (and URL parameters), defaulted parameters may be added"}]},{"kind":"enum","name":"sap.fe.navigation.ParamHandlingMode","basename":"ParamHandlingMode","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"ParamHandlingMode","static":true,"visibility":"public","since":"1.83.0","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.ParamHandlingMode}.<br> A static enumeration type which indicates the conflict resolution method when merging URL parameters into select options.","properties":[{"name":"InsertInSelOpt","visibility":"public","static":true,"type":"undefined","description":"The conflict resolution adds URL parameters to the SelectionVariant"},{"name":"SelVarWins","visibility":"public","static":true,"type":"undefined","description":"The conflict resolution favors the SelectionVariant over URL parameters"},{"name":"URLParamWins","visibility":"public","static":true,"type":"undefined","description":"The conflict resolution favors the URL parameters over the SelectionVariant. Caution: In case of cross-app navigation a navigation parameter value from the source app is overwritten by a default, if a default is maintained in the launchpad designer for this parameter in the target app!"}]},{"kind":"class","name":"sap.fe.navigation.PresentationVariant","basename":"PresentationVariant","resource":"sap/fe/navigation/PresentationVariant.js","module":"sap/fe/navigation/PresentationVariant","export":"","static":true,"visibility":"public","since":"1.83.0","extends":"sap.ui.base.Object","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.PresentationVariant}.<br> Creates a new instance of a PresentationVariant class. If no parameter is passed, an new empty instance is created whose ID has been set to <code>\"\"</code>. Passing a JSON-serialized string complying to the Selection Variant Specification will parse it, and the newly created instance will contain the same information.","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"vPresentationVariant","type":"string|object","optional":true,"description":"If of type <code>string</code>, the selection variant is JSON-formatted; if of type <code>object</code>, the object represents a selection variant"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>PresentationVariant.INVALID_INPUT_TYPE</td><td>Indicates that the data format of the selection variant provided is inconsistent</td></tr> <tr><td>PresentationVariant.UNABLE_TO_PARSE_INPUT</td><td>Indicates that the provided string is not a JSON-formatted string</td></tr> <tr><td>PresentationVariant.INPUT_DOES_NOT_CONTAIN_SELECTIONVARIANT_ID</td><td>Indicates that the PresentationVariantID cannot be retrieved</td></tr> <tr><td>PresentationVariant.PARAMETER_WITHOUT_VALUE</td><td>Indicates that there was an attempt to specify a parameter, but without providing any value (not even an empty value)</td></tr> <tr><td>PresentationVariant.SELECT_OPTION_WITHOUT_PROPERTY_NAME</td><td>Indicates that a selection option has been defined, but the Ranges definition is missing</td></tr> <tr><td>PresentationVariant.SELECT_OPTION_RANGES_NOT_ARRAY</td><td>Indicates that the Ranges definition is not an array</td></tr> </table> These exceptions can only be thrown if the parameter <code>vPresentationVariant</code> has been provided.","type":"undefined"}]},"methods":[{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.navigation.PresentationVariant with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.base.Object.extend}."},{"name":"getChartVisualization","visibility":"public","static":true,"returnValue":{"type":"Object<string,any>","description":"An object containing the properties to be used for the chart visualization."},"description":"Gets the chart visualization property."},{"name":"getContextUrl","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current context URL for the query"},"description":"Gets the current context URL intended for the query."},{"name":"getID","visibility":"public","static":true,"returnValue":{"type":"string","description":"The identification of the selection variant as made available during construction"},"description":"Returns the identification of the selection variant."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.navigation.PresentationVariant."},{"name":"getProperties","visibility":"public","static":true,"returnValue":{"type":"Object<string,any>","description":"The current properties."},"description":"Gets the more trivial properties. Basically all properties with the exception of the Visualization."},{"name":"getTableVisualization","visibility":"public","static":true,"returnValue":{"type":"Object<string,any>","description":"An object containing the properties to be used for the table visualization."},"description":"Gets the table visualization property."},{"name":"getText","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current description of this selection variant."},"description":"Returns the current text / description of this selection variant."},{"name":"isEmpty","visibility":"public","static":true,"returnValue":{"type":"boolean","description":"If set to <code>true</code> there are no current properties set; <code>false</code> otherwise."},"description":"Returns <code>true</code> if the presentation variant does not contain any properties. nor ranges."},{"name":"setChartVisualization","visibility":"public","static":true,"parameters":[{"name":"mProperties","type":"Object<string,any>","optional":false,"description":"An object containing the properties to be used for the chart visualization."}],"description":"Sets the chart visualization property."},{"name":"setContextUrl","visibility":"public","static":true,"parameters":[{"name":"sURL","type":"string","optional":false,"description":"The URL of the context"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>PresentationVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the context URL."},{"name":"setID","visibility":"public","static":true,"parameters":[{"name":"sId","type":"string","optional":false,"description":"The new identification of the selection variant"}],"description":"Sets the identification of the selection variant."},{"name":"setProperties","visibility":"public","static":true,"parameters":[{"name":"mProperties","type":"Object<string,any>","optional":false,"description":"The properties to be used."}],"description":"Sets the more trivial properties. Basically all properties with the exception of the Visualization."},{"name":"setTableVisualization","visibility":"public","static":true,"parameters":[{"name":"mProperties","type":"Object<string,any>","optional":false,"description":"An object containing the properties to be used for the table visualization."}],"description":"Sets the table visualization property."},{"name":"setText","visibility":"public","static":true,"parameters":[{"name":"sNewText","type":"string","optional":false,"description":"The new description to be used"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>PresentationVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the text / description of the selection variant."},{"name":"toJSONObject","visibility":"public","static":true,"returnValue":{"type":"object","description":"The external representation of this instance as a JSON object"},"description":"Returns the external representation of the selection variant as JSON object."},{"name":"toJSONString","visibility":"public","static":true,"returnValue":{"type":"string","description":"The JSON-formatted representation of this instance in stringified format"},"description":"Serializes this instance into a JSON-formatted string."}]},{"kind":"class","name":"sap.fe.navigation.SelectionVariant","basename":"SelectionVariant","resource":"sap/fe/navigation/SelectionVariant.js","module":"sap/fe/navigation/SelectionVariant","export":"","static":true,"visibility":"public","since":"1.83.0","extends":"sap.ui.base.Object","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.SelectionVariant}.<br> Creates a new instance of a SelectionVariant class. If no parameter is passed, an new empty instance is created whose ID has been set to <code>\"\"</code>. Passing a JSON-serialized string complying to the Selection Variant Specification will parse it, and the newly created instance will contain the same information.","ui5-metadata":{"stereotype":"object"},"constructor":{"visibility":"public","parameters":[{"name":"vSelectionVariant","type":"string|object","optional":true,"description":"If of type <code>string</code>, the selection variant is JSON-formatted; if of type <code>object</code>, the object represents a selection variant"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that the data format of the selection variant provided is inconsistent</td></tr> <tr><td>SelectionVariant.UNABLE_TO_PARSE_INPUT</td><td>Indicates that the provided string is not a JSON-formatted string</td></tr> <tr><td>SelectionVariant.INPUT_DOES_NOT_CONTAIN_SELECTIONVARIANT_ID</td><td>Indicates that the SelectionVariantID cannot be retrieved</td></tr> <tr><td>SelectionVariant.PARAMETER_WITHOUT_VALUE</td><td>Indicates that there was an attempt to specify a parameter, but without providing any value (not even an empty value)</td></tr> <tr><td>SelectionVariant.SELECT_OPTION_WITHOUT_PROPERTY_NAME</td><td>Indicates that a selection option has been defined, but the Ranges definition is missing</td></tr> <tr><td>SelectionVariant.SELECT_OPTION_RANGES_NOT_ARRAY</td><td>Indicates that the Ranges definition is not an array</td></tr> </table> These exceptions can only be thrown if the parameter <code>vSelectionVariant</code> has been provided.","type":"undefined"}]},"methods":[{"name":"addParameter","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the parameter to be set; the <code>null</code> value is not allowed"},{"name":"sValue","type":"string","optional":false,"description":"The value of the parameter to be set"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.PARAMETER_WITHOUT_NAME</td><td>Indicates that the name of the parameter has not been specified</td></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type or the value is set to <code>null</code></td></tr> <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another SelectOption with the same name as the parameter already exists</td></tr> </table>","type":"undefined"}],"description":"Sets the value of a parameter called <code>sName</code> to the new value <code>sValue</code>. If the parameter has already been set before, its value is overwritten."},{"name":"addSelectOption","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining."},"parameters":[{"name":"sPropertyName","type":"string","optional":false,"description":"The name of the property for which the selection range is added"},{"name":"sSign","type":"string","optional":false,"description":"The sign of the range (<b>I</b>nclude or <b>E</b>xclude)"},{"name":"sOption","type":"string","optional":false,"description":"The option of the range (<b>EQ</b> for \"equals\", <b>NE</b> for \"not equals\", <b>LE</b> for \"less or equals\", <b>GE</b> for \"greater or equals\", <b>LT</b> for \"less than\" (and not equals), <b>GT</b> for \"greater than\" (and not equals), <b>BT</b> for \"between\", or <b>CP</b> for \"contains pattern\" (ABAP-styled pattern matching with the asterisk as wildcard)"},{"name":"sLow","type":"string","optional":false,"description":"The single value or the lower boundary of the interval; the <code>null</code> value is not allowed"},{"name":"sHigh","type":"string","optional":true,"description":"Set only if sOption is <b>BT</b>: the upper boundary of the interval; must be <code>undefined</code> or <code>null</code> in all other cases"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_SIGN</td><td>Indicates that the sign is an invalid expression</td></tr> <tr><td>SelectionVariant.INVALID_OPTION</td><td>Indicates that the option is an invalid expression</td></tr> <tr><td>SelectionVariant.HIGH_PROVIDED_THOUGH_NOT_ALLOWED</td><td>Indicates that the upper boundary has been specified, even though the option is not 'BT'</td></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type or the value is set to <code>null</code></td></tr> <tr><td>SelectionVariant.INVALID_PROPERTY_NAME</td><td>Indicates that the property name is invalid, for example, it has not been specified</td></tr> <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another parameter with the same name as the property name already exists</td></tr> </table>","type":"undefined"}],"description":"Adds a new range to the list of select options for a given parameter."},{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.navigation.SelectionVariant with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.base.Object.extend}."},{"name":"getFilterContextUrl","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current context URL for the filters"},"description":"Gets the current context URL intended for the filters."},{"name":"getID","visibility":"public","static":true,"returnValue":{"type":"string","description":"The identification of the selection variant as made available during construction"},"description":"Returns the identification of the selection variant."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.navigation.SelectionVariant."},{"name":"getParameter","visibility":"public","static":true,"returnValue":{"type":"string","description":"The value of parameter <code>sName</code>; returning the value <code>null</code> not possible"},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the parameter to be returned"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Returns the value of the parameter called <code>sName</code> if it has been set. If the parameter has never been set or has been removed, <code>undefined</code> is returned."},{"name":"getParameterContextUrl","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current context URL for the parameters"},"description":"Gets the current context URL intended for the parameters."},{"name":"getParameterNames","visibility":"public","static":true,"returnValue":{"type":"Array","description":"The list of parameter names which are valid"},"description":"Returns the set of parameter names available in this selection variant."},{"name":"getPropertyNames","visibility":"public","static":true,"returnValue":{"type":"Array","description":"The list of parameter and select option property names available for this instance"},"description":"Returns the names of the parameter and select option properties available for this instance."},{"name":"getSelectOption","visibility":"public","static":true,"returnValue":{"type":"Array","description":"If <code>sPropertyName</code> is an invalid name of a property or no range exists, <code>undefined</code> is returned; otherwise, an immutable array of ranges is returned. Each entry of the array is an object with the following properties: <ul> <li><code>Sign</code>: The sign of the range</li> <li><code>Option</code>: The option of the range</li> <li><code>Low</code>: The low value of the range; returning value <code>null</code> is not possible</li> <li><code>High</code>: The high value of the range; if this value is not necessary, <code>null</code> is used</li> </ul> For further information about the meaning of the attributes, refer to method <code>addSelectOption</code>."},"parameters":[{"name":"sPropertyName","type":"string","optional":false,"description":"The name of the property for which the set of select options/ranges is returned"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> <tr><td>SelectionVariant.INVALID_PROPERTY_NAME</td><td>Indicates that the property name is invalid, for example, it has not been specified</td></tr> </table>","type":"undefined"}],"description":"Returns the set of select options/ranges available for a given property name."},{"name":"getSelectOptionsPropertyNames","visibility":"public","static":true,"returnValue":{"type":"Array","description":"The list of property names available for this instance"},"description":"Returns the names of the properties available for this instance."},{"name":"getText","visibility":"public","static":true,"returnValue":{"type":"string","description":"The current description of this selection variant."},"description":"Returns the current text / description of this selection variant."},{"name":"getValue","visibility":"public","static":true,"returnValue":{"type":"Array","description":"The ranges in the select options for the specified property or a range-converted representation of a parameter is returned. If both lookups fail, <code>undefined</code> is returned. <br /> The returned ranges have the format: <ul> <li><code>Sign</code>: The sign of the range</li> <li><code>Option</code>: The option of the range</li> <li><code>Low</code>: The low value of the range; returning the value <code>null</code> is not possible</li> <li><code>High</code>: The high value of the range; if this value is not necessary, <code>null</code> (but does exist)</li> </ul> For further information on the meaning of the attributes, refer to method {@link #.addSelectOption addSelectOption}."},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the attribute for which the value is retrieved"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> <tr><td>SelectionVariant.INVALID_PROPERTY_NAME</td><td>Indicates that the property name is invalid, for example, it has not been specified</td></tr> </table>","type":"undefined"}],"description":"First tries to retrieve the set of select options/ranges available for <code>sName</code> as property name. If successful, this array of selections is being returned. If it fails, an attempt to find a parameter, whose name is <code>sName</code>, is made. If the latter succeeds, the single value is converted to fit into an array of selections to make it type compatible with ranges. This array is then returned. <br /> If neither a select option nor a parameter could be found, <code>undefined</code> is returned."},{"name":"isEmpty","visibility":"public","static":true,"returnValue":{"type":"boolean","description":"If set to <code>true</code> there are no parameters and no select options available in the selection variant; <code>false</code> otherwise."},"description":"Returns <code>true</code> if the selection variant does neither contain parameters nor ranges."},{"name":"massAddSelectOption","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sPropertyName","type":"string","optional":false,"description":"The name of the property for which the set of select options is added"},{"name":"aSelectOptions","type":"Array","optional":false,"description":"Set of select options to be added"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Adds a set of select options to the list of select options for a given parameter."},{"name":"removeParameter","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the parameter to be removed"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.PARAMETER_WITHOUT_NAME</td><td>Indicates that name of the parameter has not been specified</td></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Removes a parameter called <code>sName</code> from the selection variant."},{"name":"removeSelectOption","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining."},"parameters":[{"name":"sName","type":"string","optional":false,"description":"The name of the select option to be removed"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.SELOPT_WITHOUT_NAME</td><td>Indicates that name of the select option has not been specified</td></tr> <tr><td>SelectionVariant.SELOPT_WRONG_TYPE</td><td>Indicates that the name of the parameter <code>sName</code> has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Removes a select option called <code>sName</code> from the selection variant."},{"name":"renameParameter","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sNameOld","type":"string","optional":false,"description":"The current name of the parameter to be renamed"},{"name":"sNameNew","type":"string","optional":false,"description":"The new name of the parameter"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.PARAMETER_WITHOUT_NAME</td><td>Indicates that the name of a parameter has not been specified</td></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another select option with the same new name already exists</td></tr> <tr><td>SelectionVariant.PARAMETER_COLLISION</td><td>Indicates that another parameter with the same new name already exists</td></tr> </table>","type":"undefined"}],"description":"Renames a parameter called <code>sNameOld</code> to <code>sNameNew</code>. If a parameter or a select option with the name <code>sNameNew</code> already exist, an error is thrown. If a parameter with the name <code>sNameOld</code> does not exist, nothing is changed."},{"name":"renameSelectOption","visibility":"public","static":true,"returnValue":{"type":"object","description":"This instance to allow method chaining"},"parameters":[{"name":"sNameOld","type":"string","optional":false,"description":"The current name of the select option property to be renamed"},{"name":"sNameNew","type":"string","optional":false,"description":"The new name of the select option property"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.SELOPT_WITHOUT_NAME</td><td>Indicates that the name of a select option has not been specified</td></tr> <tr><td>SelectionVariant.SELOPT_WRONG_TYPE</td><td>Indicates that a select option has an invalid type</td></tr> <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another parameter with the same new name already exists</td></tr> <tr><td>SelectionVariant.SELOPT_COLLISION</td><td>Indicates that another select option with the same new name already exists</td></tr> </table>","type":"undefined"}],"description":"Renames a select option called <code>sNameOld</code> to <code>sNameNew</code>. If a select option or a parameter with the name <code>sNameNew</code> already exist, an error is thrown. If a select option with the name <code>sNameOld</code> does not exist, nothing is changed."},{"name":"setFilterContextUrl","visibility":"public","static":true,"parameters":[{"name":"sURL","type":"string","optional":false,"description":"The URL of the filters"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the context URL intended for the filters."},{"name":"setID","visibility":"public","static":true,"parameters":[{"name":"sId","type":"string","optional":false,"description":"The new identification of the selection variant"}],"description":"Sets the identification of the selection variant."},{"name":"setParameterContextUrl","visibility":"public","static":true,"parameters":[{"name":"sURL","type":"string","optional":false,"description":"The URL of the parameter context"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the context URL intended for the parameters."},{"name":"setText","visibility":"public","static":true,"parameters":[{"name":"sNewText","type":"string","optional":false,"description":"The new description to be used"}],"throws":[{"description":"An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are: <table> <tr><th>NavError code</th><th>Description</th></tr> <tr><td>SelectionVariant.INVALID_INPUT_TYPE</td><td>Indicates that an input parameter has an invalid type</td></tr> </table>","type":"undefined"}],"description":"Sets the text / description of the selection variant."},{"name":"toJSONObject","visibility":"public","static":true,"returnValue":{"type":"object","description":"The external representation of this instance as a JSON object"},"description":"Returns the external representation of the selection variant as JSON object."},{"name":"toJSONString","visibility":"public","static":true,"returnValue":{"type":"string","description":"The JSON-formatted representation of this instance in stringified format"},"description":"Serializes this instance into a JSON-formatted string."}]},{"kind":"enum","name":"sap.fe.navigation.SuppressionBehavior","basename":"SuppressionBehavior","resource":"sap/fe/navigation/library.js","module":"sap/fe/navigation/library","export":"SuppressionBehavior","static":true,"visibility":"public","since":"1.83.0","description":"This is the successor of {@link sap.ui.generic.app.navigation.service.SuppressionBehavior}.<br> A static enumeration type which indicates whether semantic attributes with values <code>null</code>, <code>undefined</code> or <code>\"\"</code> (empty string) shall be suppressed, before they are mixed in to the selection variant in the method {@link sap.fe.navigation.NavigationHandler.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant} of the {@link sap.fe.navigation.NavigationHandler NavigationHandler}.","properties":[{"name":"ignoreEmptyString","visibility":"public","static":true,"type":"undefined","description":"Semantic attributes with an empty string are ignored, the remaining attributes are mixed in to the selection variant. Warning! Consider the impact on Boolean variable values!"},{"name":"raiseErrorOnNull","visibility":"public","static":true,"type":"undefined","description":"Semantic attributes with a <code>null</code> value lead to an {@link sap.fin.central.lib.error.Error error} of type NavigationHandler.INVALID_INPUT"},{"name":"raiseErrorOnUndefined","visibility":"public","static":true,"type":"undefined","description":"Semantic attributes with an <code>undefined</code> value lead to an {@link sap.fin.central.lib.error.Error error} of type NavigationHandler.INVALID_INPUT"},{"name":"standard","visibility":"public","static":true,"type":"undefined","description":"Standard suppression behavior: semantic attributes with a <code>null</code> or an <code>undefined</code> value are ignored, the remaining attributes are mixed in to the selection variant"}]}]}