Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExportValueMappingElement

See: relevant section in reference guide

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "ExportMappings$ExportValueMappingElement"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

attribute

  • Returns null | IAttribute

  • Parameters

    Returns void

attributeQualifiedName

  • get attributeQualifiedName(): null | string

  • Returns null | string

container

  • get container(): TContainer

  • Returns TContainer

containerAsImplicitMappingBody

  • Returns ImplicitMappingBody

containerAsImplicitMappingResponseHandling

containerAsMappingDocument

  • Returns MappingDocument

containerAsObjectMappingElement

converter

  • Returns null | IMicroflow

  • Parameters

    Returns void

converterQualifiedName

  • get converterQualifiedName(): null | string

  • Returns null | string

documentation

  • get documentation(): string
  • set documentation(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

elementType

  • Returns ElementType

  • Parameters

    Returns void

expectedContentTypes

  • get expectedContentTypes(): string
  • set expectedContentTypes(newValue: string): void

  • In version 6.4.1: deleted

    Returns string

  • In version 6.4.1: deleted

    Parameters

    • newValue: string

    Returns void

exposedName

  • get exposedName(): string
  • set exposedName(newValue: string): void

  • In version 6.6.0: introduced

    Returns string

  • In version 6.6.0: introduced

    Parameters

    • newValue: string

    Returns void

fractionDigits

  • get fractionDigits(): number
  • set fractionDigits(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

isContent

  • get isContent(): boolean
  • set isContent(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

isKey

  • get isKey(): boolean
  • set isKey(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

isLoaded

  • get isLoaded(): boolean

  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

isXmlAttribute

  • get isXmlAttribute(): boolean
  • set isXmlAttribute(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

jsonPath

  • get jsonPath(): string
  • set jsonPath(newValue: string): void

  • The value of this property is conceptually of type mappings.ElementPath.

    In version 7.6.0: introduced

    Returns string

  • The value of this property is conceptually of type mappings.ElementPath.

    In version 7.6.0: introduced

    Parameters

    • newValue: string

    Returns void

maxLength

  • get maxLength(): number
  • set maxLength(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

maxOccurs

  • get maxOccurs(): number
  • set maxOccurs(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

minOccurs

  • get minOccurs(): number
  • set minOccurs(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

model

  • get model(): TModel

  • Returns TModel

nillable

  • get nillable(): boolean
  • set nillable(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

originalValue

  • get originalValue(): string
  • set originalValue(newValue: string): void

  • In version 10.3.0: introduced

    Returns string

  • In version 10.3.0: introduced

    Parameters

    • newValue: string

    Returns void

path

  • get path(): string
  • set path(newValue: string): void

  • The value of this property is conceptually of type mappings.ElementPath.

    In version 7.6.0: deleted

    Returns string

  • The value of this property is conceptually of type mappings.ElementPath.

    In version 7.6.0: deleted

    Parameters

    • newValue: string

    Returns void

totalDigits

  • get totalDigits(): number
  • set totalDigits(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

type

  • In version 7.9.0: introduced

    Returns DataType

  • In version 7.9.0: introduced

    Parameters

    Returns void

unit

xmlDataType

  • get xmlDataType(): string
  • set xmlDataType(newValue: string): void

  • The value of this property is conceptually of type dataTypes.LegacyDataType.

    In version 7.9.0: deleted

    Returns string

  • The value of this property is conceptually of type dataTypes.LegacyDataType.

    In version 7.9.0: deleted

    Parameters

    • newValue: string

    Returns void

xmlPath

  • get xmlPath(): string
  • set xmlPath(newValue: string): void

  • The value of this property is conceptually of type mappings.ElementPath.

    In version 7.6.0: introduced

    Returns string

  • The value of this property is conceptually of type mappings.ElementPath.

    In version 7.6.0: introduced

    Parameters

    • newValue: string

    Returns void

xmlPrimitiveType

  • In version 6.1.0: introduced

    Returns XmlPrimitiveType

  • In version 6.1.0: introduced

    Parameters

    Returns void

Methods

allProperties

asLoaded

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Returns ExportValueMappingElement

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<ExportValueMappingElement>

loadedProperties

publicProperties

toJSON

  • toJSON(): IStructureJSON

  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

traverse

  • traverse(visit: (structure: IStructure) => void): void

  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): void

Static create

  • Creates and returns a new ExportValueMappingElement instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    • model: IModel

    Returns ExportValueMappingElement

Static createIn

  • Creates and returns a new ExportValueMappingElement instance in the SDK and on the server. The new ExportValueMappingElement will be automatically stored in the 'children' property of the parent mappings.ObjectMappingElement element passed as argument.

    Parameters

    Returns ExportValueMappingElement

Generated using TypeDoc