Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MappingDocument

See: relevant section in reference guide

Warning: this class represents an abstract and non-instantiable concept in the meta model. You should not try to instantiate this class directly, but instantiate one of its concrete/non-abstract sub classes instead. Instantiating this class is possible in pure JavaScript, but there's no guarantee the result will be at all useful.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___importedWebService

___importedWebService: any

Private ___jsonStructure

___jsonStructure: any

Private ___operationName

___operationName: any

Private ___rootElementName

___rootElementName: any

Private ___rootMappingElements

___rootMappingElements: any

Private ___serviceName

___serviceName: any

Private ___xmlSchema

___xmlSchema: any

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsModule

containerAsModule: Module

documentation

documentation: string

excluded

excluded: boolean

id

id: string

importedWebService

importedWebService: IImportedWebService

importedWebServiceQualifiedName

importedWebServiceQualifiedName: string

isLoaded

isLoaded: boolean

jsonStructure

jsonStructure: IJsonStructure

In version 6.4.0: introduced

jsonStructureQualifiedName

jsonStructureQualifiedName: string

model

model: IModel

moduleName

moduleName: string

Returns the module name of the model unit, which is the first section of the qualified name.

name

name: string

operationName

operationName: string

qualifiedName

qualifiedName: string

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

rootElementName

rootElementName: string

rootMappingElements

rootMappingElements: IList<ObjectMappingElement>

serviceName

serviceName: string

typeName

typeName: string

unit

unit:

versionInfo

versionInfo: StructureVersionInfo

xmlSchema

xmlSchema: IXmlSchema

xmlSchemaQualifiedName

xmlSchemaQualifiedName: string

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

findElementById

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

Generated using TypeDoc