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

associationQualifiedName

associationQualifiedName: string

children

children: IList<MappingElement>

container

container: AbstractElement

containerAsMappingDocument

containerAsMappingDocument: MappingDocument

containerAsObjectMappingElement

containerAsObjectMappingElement: ObjectMappingElement

documentation

documentation: string

elementType

elementType: ElementType

entity

entity: IEntity

entityQualifiedName

entityQualifiedName: string

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.

mappingMicroflowCall

mappingMicroflowCall: MappingMicroflowCall

maxOccurs

maxOccurs: number

minOccurs

minOccurs: number

model

model: IModel

nillable

nillable: boolean

objectHandling

objectHandling: ObjectHandlingEnum

objectHandlingBackup

objectHandlingBackup: ObjectHandlingBackupEnum

path

path: string

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

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

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

    Type parameters

    Parameters

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

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

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