namespace sap.ui.fl.write.api.SmartVariantManagementWriteAPI

Visiblity: restricted
Available since: N/A
Module: sap/ui/fl/write/api/SmartVariantManagementWriteAPI
Application Component: CA-UI5-FL

Provides an API to handle specific functionalities for sap.ui.comp.smartvariants.SmartVariantManagement.


Nodes Overview

Node Description

Methods Overview

Method Description
sap.ui.fl.write.api.SmartVariantManagementWriteAPI._getTransportSelection

Opens Transport Dialog for transport selection.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.addVariant

Adds a new variant and returns it. Either the mPropertyBag.changeSpecificData.layer or the mPropertyBag.changeSpecificData.isUserDependent should be provided for a proper layer determination.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.isVariantAdaptationEnabled

Checks whether adaptation at runtime or designtime should be enabled for comp variants

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.isVariantPersonalizationEnabled

Checks whether personalization of variants is enabled.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.isVariantSharingEnabled

Checks whether sharing of variants is enabled.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.removeVariant

Removes a variant; this may result in an deletion of the variant or the creation of a change.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.revertSetDefaultVariantId

Reverts the last setDefaultVariantId operation done on a variant management.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.save

Saves/flushes all current changes to the back end.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.setDefaultVariantId

Sets the default variant for the current control synchronously. A new change object is created or an existing change is updated. This change object is kept in memory and can be flushed using save. WARNING: The consumer has to make sure that the changes have already been retrieved with getChanges.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.updateVariant

Updates a variant; this may result in an update of the variant or the creation of a change. Either the mPropertyBag.layer or the mPropertyBag.isUserDependent should be provided for a proper layer determination. In case updates for different layers are done, the update must be called for each layer separately.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI._getTransportSelection

Opens Transport Dialog for transport selection.

Param Type DefaultValue Description

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.addVariant

Adds a new variant and returns it. Either the mPropertyBag.changeSpecificData.layer or the mPropertyBag.changeSpecificData.isUserDependent should be provided for a proper layer determination.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

control sap.ui.comp.smartvariants.SmartVariantManagement sap.ui.comp.smartfilterbar.SmartFilterBar sap.ui.comp.smarttable.SmartTable sap.ui.comp.smartchart.SmartChart

Variant management control for which the variant should be added

changeSpecificData object

Map of parameters, see below

layer sap.ui.fl.Layer

Layer to which the variant should be written

isUserDependent boolean

Flag if the variant is personalization only

id string

ID that should be used for the variant

type string

Type (filterVariant, tableVariant, etc.)

texts object

Map object with all referenced texts within the file; these texts will be connected to the translation process

content object

Content of the new change

favorite object

Indicates if the change is added as favorite

executeOnSelection object

Indicates if the executeOnSelection flag should be set

ODataService string

Name of the OData service --> can be null

contexts object

Map of contexts that restrict the visibility of the variant

role string[]

List of roles which are allowed to see the variant

command string

Name of the command creating the variant

support boolean

Information for support analysis

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.isVariantAdaptationEnabled

Checks whether adaptation at runtime or designtime should be enabled for comp variants

Param Type DefaultValue Description

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.isVariantPersonalizationEnabled

Checks whether personalization of variants is enabled.

Param Type DefaultValue Description

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.isVariantSharingEnabled

Checks whether sharing of variants is enabled.

Param Type DefaultValue Description

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.removeVariant

Removes a variant; this may result in an deletion of the variant or the creation of a change.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

reference string

Flex reference of the application

control sap.ui.comp.smartvariants.SmartVariantManagement sap.ui.comp.smartfilterbar.SmartFilterBar sap.ui.comp.smarttable.SmartTable sap.ui.comp.smartchart.SmartChart

Variant management control for which the variant should be removed

id string

ID of the variant

layer sap.ui.fl.Layer

Layer in which the variant removal takes place; this either removes the variant from the layer or writes a change to that layer.

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.revertSetDefaultVariantId

Reverts the last setDefaultVariantId operation done on a variant management.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

reference string

Flex reference of the application

control sap.ui.comp.smartvariants.SmartVariantManagement sap.ui.comp.smartfilterbar.SmartFilterBar sap.ui.comp.smarttable.SmartTable sap.ui.comp.smartchart.SmartChart

Variant management control for which the variants should be loaded

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.save

Saves/flushes all current changes to the back end.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

control sap.ui.comp.smartvariants.SmartVariantManagement sap.ui.comp.smartfilterbar.SmartFilterBar sap.ui.comp.smarttable.SmartTable sap.ui.comp.smartchart.SmartChart

Variant management control for which the flex objects should be saved

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.setDefaultVariantId

Sets the default variant for the current control synchronously. A new change object is created or an existing change is updated. This change object is kept in memory and can be flushed using save. WARNING: The consumer has to make sure that the changes have already been retrieved with getChanges.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

control sap.ui.comp.smartvariants.SmartVariantManagement sap.ui.comp.smartfilterbar.SmartFilterBar sap.ui.comp.smarttable.SmartTable sap.ui.comp.smartchart.SmartChart

Variant management control for which a variant should be set as 'Default'

defaultVariantId string

ID of the new default variant

generator string

ID for the creating class / use case of the setDefault

compositeCommand string

Name of the composite command triggering the setting of the default

layer sap.ui.fl.Layer Layer.USER

Enables setDefault for the given layer

sap.ui.fl.write.api.SmartVariantManagementWriteAPI.updateVariant

Updates a variant; this may result in an update of the variant or the creation of a change. Either the mPropertyBag.layer or the mPropertyBag.isUserDependent should be provided for a proper layer determination. In case updates for different layers are done, the update must be called for each layer separately.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

reference string

Flex reference of the application

control sap.ui.comp.smartvariants.SmartVariantManagement sap.ui.comp.smartfilterbar.SmartFilterBar sap.ui.comp.smarttable.SmartTable sap.ui.comp.smartchart.SmartChart

Variant management control for which the variant should be updated

id string

ID of the variant

packageName string

ID of the package in which the update should be transported - only valid for sap-ui-layer=VENDOR use case

transportId string

ID of the transport in which the update should be assigned

name object

Title of the variant

content object

Content of the new change

favorite object

Flag if the variant should be flagged as a favorite

executeOnSelection object

Flag if the variant should be executed on selection

layer sap.ui.fl.Layer

Layer in which the variant removal takes place