Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImportObjectMappingElement

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 = "ImportMappings$ImportObjectMappingElement"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

association

  • Returns null | IAssociationBase

  • Parameters

    Returns void

associationQualifiedName

  • get associationQualifiedName(): null | string

  • Returns null | string

children

container

  • get container(): TContainer

  • Returns TContainer

containerAsImplicitMappingBody

  • Returns ImplicitMappingBody

containerAsImplicitMappingResponseHandling

containerAsMappingDocument

  • Returns MappingDocument

containerAsObjectMappingElement

documentation

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

elementType

  • Returns ElementType

  • Parameters

    Returns void

entity

  • get entity(): null | IEntity
  • set entity(newValue: null | IEntity): void

  • Returns null | IEntity

  • Parameters

    Returns void

entityQualifiedName

  • get entityQualifiedName(): null | string

  • Returns null | string

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

isDefaultType

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

  • In version 6.4.0: introduced

    Returns boolean

  • In version 6.4.0: introduced

    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

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

mappingMicroflowCall

  • Returns null | MappingMicroflowCall

  • Parameters

    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

objectHandling

  • Returns ObjectHandlingEnum

  • Parameters

    Returns void

objectHandlingBackup

objectHandlingBackupAllowOverride

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

  • In version 7.17.0: introduced

    Returns boolean

  • In version 7.17.0: introduced

    Parameters

    • newValue: boolean

    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

unit

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

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 ImportObjectMappingElement

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

findElementById

Protected getContainerAs

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

load

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 ImportObjectMappingElement 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 ImportObjectMappingElement

Static createInImplicitMappingResponseHandlingUnderRootMappingElement

  • Creates and returns a new ImportObjectMappingElement instance in the SDK and on the server. The new ImportObjectMappingElement will be automatically stored in the 'rootMappingElement' property of the parent rest.ImplicitMappingResponseHandling element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 10.3.0 and higher

    Parameters

    Returns ImportObjectMappingElement

Static createInMappingDocumentUnderRootMappingElements

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

    Parameters

    Returns ImportObjectMappingElement

Static createInObjectMappingElementUnderChildren

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

    Parameters

    Returns ImportObjectMappingElement

Generated using TypeDoc