Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IEntity

See: relevant section in reference guide

Hierarchy

Implemented by

Index

Properties

Methods

Properties

_container

_container: null | IContainer
internal

_declaredAsNamespace

_declaredAsNamespace: boolean
internal

Readonly _isAttached

_isAttached: boolean
internal

Readonly _isDeleted

_isDeleted: boolean
internal

Readonly _isDetached

_isDetached: boolean
internal

Readonly _isNew

_isNew: boolean
internal

Readonly attributes

attributes: IList<IAttribute>

Readonly capabilities

capabilities: IEntityCapabilities

This property is required and cannot be set to null.

In version 9.0.1: deleted In version 8.12.0: introduced

Readonly container

container: IAbstractElement

Readonly containerAsDomainModel

containerAsDomainModel: IDomainModel

Readonly documentation

documentation: string

In version 9.10.0: added public

Readonly generalization

generalization: IGeneralizationBase

This property is required and cannot be set to null.

id

id: string

isLoaded

isLoaded: boolean

Readonly isRemote

isRemote: boolean

In version 8.10.0: deleted In version 8.2.0: added public In version 7.17.0: introduced

Readonly location

location: IPoint

In version 9.10.0: added public

Readonly model

model: IModel

Readonly name

name: string

Readonly qualifiedName

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.

Readonly remoteSourceDocumentQualifiedName

remoteSourceDocumentQualifiedName: null | string

Readonly source

source: null | IEntitySource

In version 8.10.0: introduced

structureTypeName

structureTypeName: string

unit

unit: IAbstractUnit

Unit that owns/contains this thing.

Readonly versionInfo

versionInfo: StructureVersionInfo
internal

Methods

_getQualifiedName

  • _getQualifiedName(): null | string

_updateWithJson

allProperties

asLoaded

findElementById

load

  • load(callback: (element: Entity) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<Entity>

  • Parameters

    • callback: (element: Entity) => void

        • Parameters

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<Entity>

loadedProperties

publicProperties

resolveByIdReferences

  • resolveByIdReferences(): void

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: (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

  • 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

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

Generated using TypeDoc