Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

internal
__children: PartListProperty<MappingElement> = ...
internal
__documentation: PrimitiveProperty<string> = ...
internal
__elementType: EnumProperty<ElementType> = ...
internal
internal
__exposedName: PrimitiveProperty<string> = ...
internal
__isDefaultType: PrimitiveProperty<boolean> = ...
internal
__jsonPath: PrimitiveProperty<string> = ...
internal
__mappingMicroflowCall: PartProperty<MappingMicroflowCall> = ...
internal
__maxOccurs: PrimitiveProperty<number> = ...
internal
__minOccurs: PrimitiveProperty<number> = ...
internal
__nillable: PrimitiveProperty<boolean> = ...
internal
__objectHandling: EnumProperty<ObjectHandlingEnum> = ...
internal
__objectHandlingBackup: EnumProperty<ObjectHandlingBackupEnum> = ...
internal
__objectHandlingBackupAllowOverride: PrimitiveProperty<boolean> = ...
internal
__path: PrimitiveProperty<string> = ...
internal
__xmlPath: PrimitiveProperty<string> = ...
internal
_container: null | IContainer
internal
_declaredAsNamespace: boolean = false
internal
_isDoingDelete: boolean = false
internal
_isPartial: boolean
internal
_isReverting: boolean = false

Indicates that the internal data of this element is being reverted to its previous value, so some validation check could be skipped

internal
_isUpdating: boolean = true

Indicates that the internal data of this element is being updated, as a result of data received from the server, so no storage events should be send

internal
internal
_registeredQualifiedName: null | string = null

used by qualified names cache to determine old name after a rename

internal
_state: StructureState = "attached"

The current state of the structure: (new|attached|detached|deleted).

internal
internal
id: string
structureTypeName: string
structureTypeName: string = "Mappings$ObjectMappingElement"
versionInfo: StructureVersionInfo = ...

Accessors

  • get _isAttached(): boolean
  • This structure is attached somewhere in the model. This is the "normal" state for an structure.

    internal

    Returns boolean

  • get _isDeleted(): boolean
  • This structure has been deleted and should no longer be used.

    internal

    Returns boolean

  • get _isDetached(): boolean
  • This structure is detached, so that it can be attached somewhere else in the model.

    internal

    Returns boolean

  • get _isNew(): boolean
  • This structure was just constructed and has not been added to the model yet.

    internal

    Returns boolean

  • get associationQualifiedName(): null | string
  • Returns null | string

  • get container(): TContainer
  • Returns TContainer

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

  • Parameters

    • newValue: string

    Returns void

  • Returns ElementType

  • Parameters

    Returns void

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

  • 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

  • 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

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

  • 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

  • get maxOccurs(): number
  • set maxOccurs(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get minOccurs(): number
  • set minOccurs(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get model(): TModel
  • Returns TModel

  • get nillable(): boolean
  • set nillable(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • 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

  • 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

  • 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

  • Finds the given child among the properties of this structure, returning a handle to detach it later when appropriate based on in which property is was found.

    internal

    Parameters

    Returns null | IChildHandle

  • _deleteInternal(): void
  • _dispose(): void
  • This model element is no longer part of the model, and can be cleaned up.

    internal

    Returns void

  • _getQualifiedName(): null | string
  • _initializeDefaultProperties(): void
  • _initializeNewInstance(): void
  • _isByNameReferrable(): boolean
  • Return true if this is an abstractElement that might be referred to by some other element. If true, this element is maintained in the qualifiedNamesCache

    internal

    Returns boolean

  • _markCurrentValuesAsDefaults(): void
  • _processLocalNameChange(previousName: null | string): void
  • _processNameChange(): void
  • If the name of a model element changes, this might effect currently broken references-by-name, so let's process those.

    internal

    Returns void

  • _registerProperty(prop: AbstractProperty<any, any>, declaredOn: IStructureClass): void
  • _scheduleDeltaAfterCreate(delta: Delta): void
  • _sendChangeDelta(propertyName: string, newValue: any, changeType?: "CHANGE" | "ADD" | "REMOVE", index?: number): void
  • Sends the change delta in case a simple property has changed.

    internal

    Parameters

    • propertyName: string
    • newValue: any
    • changeType: "CHANGE" | "ADD" | "REMOVE" = "CHANGE"
    • index: number = -1

    Returns void

  • _sendDeleteDelta(): void
  • _sendDetachDelta(): void
  • 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 ObjectMappingElement

  • delete(): void
  • getContainerAs<T>(containerType: any): 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.

    Parameters

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<ObjectMappingElement>

  • resolveByIdReferences(): void
  • Should be called after deserialization / remote updates, to make sure all references are bound to their actual value.

    internal

    Returns void

  • 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(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<T>(visit: (structure: IStructure) => T): null | T
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

  • traversePublicParts(visit: (structure: IStructure) => void): void

Generated using TypeDoc