class sap.ui.fl.write._internal.appVariant.AppVariant

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/fl/write/_internal/appVariant/AppVariant
Application Component: CA-UI5-FL

Constructor

App variant.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.fl.write._internal.appVariant.AppVariant(mPropertyBag)
Param Type Default Value Description
mPropertyBag object

Parameters

id string

ID of the app variant to be provided for a new app variant and for deleting an app variant

reference? string

Proposed referenced descriptor or app variant ID (might be overwritten by the back end) to be provided when creating a new app variant

transport? string

Transport with which the app variant should be transported

package? string

Package of the app variant

version? string

Version of the app variant

layer? string 'CUSTOMER'

Current working layer (might be overwritten by the back end) when creating a new app variant


Properties

Name Type Default Value Description
mode string Visibility: public

Methods Overview

Method Description
addDescriptorInlineChange

Adds a descriptor inline change to the app variant.

sap.ui.fl.write._internal.appVariant.AppVariant.extend

Creates a new subclass of class sap.ui.fl.write._internal.appVariant.AppVariant with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.ManagedObject.extend.

getDefinition

Gets the definition of the app variant in JSON format.

getJson

Returns a copy of the JSON object of the app variant.

sap.ui.fl.write._internal.appVariant.AppVariant.getMetadata

Returns a metadata object for class sap.ui.fl.write._internal.appVariant.AppVariant.

getMode

Gets current value of property mode.

setMode

Sets the operation mode.

setPackage

Sets the package (for the ABAP back end).

setReference

Sets the reference of app variant.

setTransportRequest

Sets the transport request (for ABAP back end).

submit

Submits the app variant to the back end.

addDescriptorInlineChange

Adds a descriptor inline change to the app variant.

Param Type DefaultValue Description
oDescriptorInlineChange sap.ui.fl.descriptorRelated.api.DescriptorInlineChange

Inline change

sap.ui.fl.write._internal.appVariant.AppVariant.extend

Creates a new subclass of class sap.ui.fl.write._internal.appVariant.AppVariant with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.ManagedObject.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getDefinition

Gets the definition of the app variant in JSON format.

getJson

Returns a copy of the JSON object of the app variant.

sap.ui.fl.write._internal.appVariant.AppVariant.getMetadata

Returns a metadata object for class sap.ui.fl.write._internal.appVariant.AppVariant.

getMode

Gets current value of property mode.

setMode

Sets the operation mode.

Param Type DefaultValue Description
sMode string

Operation mode

setPackage

Sets the package (for the ABAP back end).

Param Type DefaultValue Description
sPackage string

ABAP package

setReference

Sets the reference of app variant.

Param Type DefaultValue Description
sReference string

New reference

setTransportRequest

Sets the transport request (for ABAP back end).

Param Type DefaultValue Description
sTransportRequest string

ABAP transport request

submit

Submits the app variant to the back end.