Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entity

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "DomainModels$Entity"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

accessRules

attributes

capabilities

container

  • get container(): TContainer

  • Returns TContainer

containerAsDomainModel

dataStorageGuid

  • get dataStorageGuid(): string
  • set dataStorageGuid(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

documentation

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

eventHandlers

exportLevel

  • In version 9.3.0: introduced

    Returns ExportLevel

  • In version 9.3.0: introduced

    Parameters

    Returns void

generalization

image

  • get image(): null | IImage
  • set image(newValue: null | IImage): void

  • Returns null | IImage

  • Parameters

    Returns void

imageData

  • get imageData(): null | string
  • set imageData(newValue: null | string): void

  • In version 9.17.0: introduced

    Returns null | string

  • In version 9.17.0: introduced

    Parameters

    • newValue: null | string

    Returns void

imageQualifiedName

  • get imageQualifiedName(): null | string

  • Returns null | string

indexes

isLoaded

  • get isLoaded(): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

isRemote

  • get isRemote(): boolean
  • set isRemote(newValue: boolean): void

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

    Returns boolean

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

    Parameters

    • newValue: boolean

    Returns void

location

model

  • get model(): TModel

  • Returns TModel

name

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

qualifiedName

  • 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

remoteSource

  • get remoteSource(): string
  • set remoteSource(newValue: string): void

  • In version 8.10.0: deleted In version 7.17.0: introduced

    Returns string

  • In version 8.10.0: deleted In version 7.17.0: introduced

    Parameters

    • newValue: string

    Returns void

remoteSourceDocumentQualifiedName

  • get remoteSourceDocumentQualifiedName(): null | string

source

unit

validationRules

Methods

allProperties

asLoaded

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

  • Deletes this element from the model.

    Returns void

detach

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

    Returns Entity

findElementById

Protected getContainerAs

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

load

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

  • 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: (elem: Entity) => void
    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<Entity>

loadedProperties

publicProperties

toJSON

  • 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

  • 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

traversePublicParts

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

Static create

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

Static createIn

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

    Parameters

    Returns Entity

Generated using TypeDoc