Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entity

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___accessRules

___accessRules: any

Private ___attributes

___attributes: any

Private ___dataStorageGuid

___dataStorageGuid: any

Private ___documentation

___documentation: any

Private ___eventHandlers

___eventHandlers: any

Private ___generalization

___generalization: any

Private ___image

___image: any

Private ___indexes

___indexes: any

Private ___location

___location: any

Private ___name

___name: any

Private ___validationRules

___validationRules: any

accessRules

accessRules: IList<AccessRule>

attributes

attributes: IList<Attribute>

container

container: AbstractElement

containerAsDomainModel

containerAsDomainModel: DomainModel

dataStorageGuid

dataStorageGuid: string

documentation

documentation: string

eventHandlers

eventHandlers: IList<EventHandler>

generalization

generalization: GeneralizationBase

id

id: string

image

image: IImage

imageQualifiedName

imageQualifiedName: string

indexes

indexes: IList<Index>

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

location

location: IPoint

model

model: IModel

name

name: string

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

typeName

typeName: string

unit

unit: ModelUnit

validationRules

validationRules: IList<ValidationRule>

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

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

    Type parameters

    Parameters

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

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): 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

    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