Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "DomainModels$Association"
versionInfo: StructureVersionInfo = ...

Accessors

  • This property is required and cannot be set to null.

    Returns Entity

  • This property is required and cannot be set to null.

    Parameters

    Returns void

  • get childConnection(): IPoint
  • set childConnection(newValue: IPoint): void
  • get container(): TContainer
  • get dataStorageGuid(): string
  • set dataStorageGuid(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • 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

  • In version 9.3.0: introduced

    Returns ExportLevel

  • In version 9.3.0: introduced

    Parameters

    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 model(): TModel
  • Returns TModel

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

  • Parameters

    • newValue: string

    Returns void

  • This property is required and cannot be set to null.

    Returns Entity

  • This property is required and cannot be set to null.

    Parameters

    Returns void

  • get parentConnection(): IPoint
  • set parentConnection(newValue: IPoint): void
  • 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

  • get remoteSourceDocumentQualifiedName(): null | string

Methods

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

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • load(callback: (elem: Association) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<Association>
  • 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<Association>

  • 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
  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates and returns a new Association 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 Association

  • Creates and returns a new Association instance in the SDK and on the server. The new Association will be automatically stored in the 'associations' property of the parent DomainModel element passed as argument.

    Parameters

    Returns Association

Generated using TypeDoc