Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImportMapping

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

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

  • get container(): TContainer

  • The parent unit of this unit.

    Returns TContainer

containerAsFolderBase

containerAsModule

  • get containerAsModule(): Module

documentation

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

  • In version 9.10.0: added public

    Returns string

  • In version 9.10.0: added public

    Parameters

    • newValue: string

    Returns void

excluded

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

  • In version 9.11.0: added public

    Returns boolean

  • In version 9.11.0: added public

    Parameters

    • newValue: boolean

    Returns void

exportLevel

  • In version 9.3.0: introduced

    Returns ExportLevel

  • In version 9.3.0: introduced

    Parameters

    Returns void

importedWebService

  • Returns null | IImportedWebService

  • Parameters

    Returns void

importedWebServiceQualifiedName

  • get importedWebServiceQualifiedName(): null | string

  • Returns null | string

isLoadable

  • get isLoadable(): boolean

  • Whether this unit and all of its children (recursively) can be loaded.

    Returns boolean

isLoaded

  • get isLoaded(): boolean

  • Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

    Returns boolean

isReadOnly

  • get isReadOnly(): boolean

  • Whether this unit and all of its children (recursively) are editable.

    Returns boolean

jsonStructure

  • In version 6.4.0: introduced

    Returns null | IJsonStructure

  • In version 6.4.0: introduced

    Parameters

    Returns void

jsonStructureQualifiedName

  • get jsonStructureQualifiedName(): null | string

  • Returns null | string

mappingSourceReference

messageDefinition

  • In version 7.6.0: introduced

    Returns null | IMessageDefinition

  • In version 7.6.0: introduced

    Parameters

    Returns void

messageDefinitionQualifiedName

  • get messageDefinitionQualifiedName(): null | string

  • Returns null | string

model

  • get model(): TModel

  • Returns TModel

name

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

operationName

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

parameter

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

  • In version 7.16.0: deleted

    Returns null | IEntity

  • In version 7.16.0: deleted

    Parameters

    Returns void

parameterQualifiedName

  • get parameterQualifiedName(): null | string

  • Returns null | string

parameterType

  • In version 7.16.0: introduced

    Returns DataType

  • In version 7.16.0: introduced

    Parameters

    Returns void

publicName

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

  • In version 7.14.0: introduced

    Returns string

  • In version 7.14.0: introduced

    Parameters

    • newValue: string

    Returns void

qualifiedName

  • get qualifiedName(): null | string

  • Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

    Returns null | string

rootElementName

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

rootMappingElements

serviceName

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

unit

  • get unit(): this

  • Unit that owns/contains this thing.

    Returns this

useSubtransactionsForMicroflows

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

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

xmlSchema

  • Returns null | IXmlSchema

  • Parameters

    Returns void

xmlSchemaQualifiedName

  • get xmlSchemaQualifiedName(): null | string

  • Returns null | string

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 ImportMapping

delete

  • delete(): void

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

loadedProperties

publicProperties

toJSON

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

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 createIn

  • Creates a new ImportMapping unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

    Parameters

    Returns ImportMapping

Generated using TypeDoc