Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExportObjectMappingElement

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

association

associationQualifiedName

  • get (): string | null

children

container

containerAsMappingDocument

containerAsObjectMappingElement

documentation

  • get (): string
  • set (newValue: string): any

elementType

entity

entityQualifiedName

  • get (): string | null

exposedName

  • get (): string
  • set (newValue: string): any

isDefaultType

  • get (): boolean
  • set (newValue: boolean): any

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

jsonPath

  • get (): string
  • set (newValue: string): any

  • 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 any

mappingMicroflowCall

maxOccurs

  • get (): number
  • set (newValue: number): any

minOccurs

  • get (): number
  • set (newValue: number): any

model

nillable

  • get (): boolean
  • set (newValue: boolean): any

objectHandling

objectHandlingBackup

objectHandlingBackupAllowOverride

  • get (): boolean
  • set (newValue: boolean): any

path

  • get (): string
  • set (newValue: string): any

  • 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 any

unit

xmlPath

  • get (): string
  • set (newValue: string): any

  • 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 any

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this

  • 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 this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

  • 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

    • callback: function
        • (elem: this): void

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new ExportObjectMappingElement 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

    Returns ExportObjectMappingElement

Static createInMappingDocumentUnderRootMappingElements

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

    Parameters

    Returns ExportObjectMappingElement

Static createInObjectMappingElementUnderChildren

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

    Parameters

    Returns ExportObjectMappingElement

Generated using TypeDoc