Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataAssociation

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

association

associationByContract

associationQualifiedName

  • get (): string | null

  • Returns string | null

childMembers

container

containerAsDataEntityBase

containerAsPublishedParameter

containerAsPublishedResource

description

  • get (): string
  • set (newValue: string): any

  • In version 8.5.0: introduced

    Returns string

  • In version 8.5.0: introduced

    Parameters

    • newValue: string

    Returns any

entity

entityQualifiedName

  • get (): string | null

exposedAssociationName

  • get (): string
  • set (newValue: string): any

  • In version 8.0.0: introduced

    Returns string

  • In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns any

exposedItemName

  • get (): string
  • set (newValue: string): any

exposedName

  • get (): string
  • set (newValue: string): any

isKey

  • get (): boolean
  • set (newValue: boolean): any

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

isLockedByContract

  • get (): boolean
  • set (newValue: boolean): any

isNillable

  • get (): boolean
  • set (newValue: boolean): any

isNillableByContract

  • get (): boolean
  • set (newValue: boolean): any

isOptional

  • get (): boolean
  • set (newValue: boolean): any

isOptionalByContract

  • get (): boolean
  • set (newValue: boolean): any

model

summary

  • get (): string
  • set (newValue: string): any

  • In version 8.5.0: introduced

    Returns string

  • In version 8.5.0: introduced

    Parameters

    • newValue: string

    Returns any

unit

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

  • 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

    • callback: function
        • (elem: this): void

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new DataAssociation 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

    Returns DataAssociation

Static createIn

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

    Parameters

    Returns DataAssociation

Generated using TypeDoc