Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAssociationBase

Hierarchy

Implemented by

Index

Properties

capabilities

This property is required and cannot be set to null.

In version 8.11.0: introduced

container

container: IAbstractElement

containerAsDomainModel

containerAsDomainModel: IDomainModel

id

id: string

isLoaded

isLoaded: boolean

model

model: IModel

name

name: string

owner

parent

parent: IEntity

This property is required and cannot be set to null.

qualifiedName

qualifiedName: string | null

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.

remoteSourceDocument

remoteSourceDocument: IRemoteEntitySourceDocument | null

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

In version 8.10.0: deleted In version 8.3.0: introduced

remoteSourceDocumentQualifiedName

remoteSourceDocumentQualifiedName: string | null

source

source: IAssociationSource | null

In version 8.10.0: introduced

structureTypeName

structureTypeName: string

type

unit

Unit that owns/contains this thing.

Methods

allProperties

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

asLoaded

load

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

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]
  • Returns all properties when this structure is loaded, otherwise just the public properties.

    Returns AbstractProperty<any, any>[]

publicProperties

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

toJSON

  • toJSON(): object
  • 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 object

traverse

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

    Type parameters

    • T

    Parameters

    Returns T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Generated using TypeDoc