Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExportObjectMappingElement

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

association

association: IAssociationBase | null

associationQualifiedName

associationQualifiedName: string | null

children

children: IList<MappingElement>

container

container: AbstractElement

containerAsMappingDocument

containerAsMappingDocument: MappingDocument

containerAsObjectMappingElement

containerAsObjectMappingElement: ObjectMappingElement

documentation

documentation: string

elementType

elementType: ElementType

entity

entity: IEntity | null

entityQualifiedName

entityQualifiedName: string | null

exposedName

exposedName: string

In version 6.6.0: introduced

id

id: string

isDefaultType

isDefaultType: boolean

In version 6.4.0: introduced

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

jsonPath

jsonPath: string

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

In version 7.6.0: introduced

mappingMicroflowCall

mappingMicroflowCall: MappingMicroflowCall | null

maxOccurs

maxOccurs: number

minOccurs

minOccurs: number

model

model: IModel

nillable

nillable: boolean

objectHandling

objectHandling: ObjectHandlingEnum

objectHandlingBackup

objectHandlingBackup: ObjectHandlingBackupEnum

objectHandlingBackupAllowOverride

objectHandlingBackupAllowOverride: boolean

In version 7.17.0: introduced

path

path: string

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

In version 7.6.0: deleted

structureTypeName

structureTypeName: string

unit

unit: ModelUnit

xmlPath

xmlPath: string

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

In version 7.6.0: introduced

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

allProperties

asLoaded

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach()

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

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise

  • 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: ): void

        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

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