Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataEntityBase

Warning: this class represents an abstract and non-instantiable concept in the meta model. You should not try to instantiate this class directly, but instantiate one of its concrete/non-abstract sub classes instead. Instantiating this class is possible in pure JavaScript, but there's no guarantee the result will be at all useful.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private ___childMembers

___childMembers: any

Private ___entity

___entity: any

Private ___exposedItemName

___exposedItemName: any

childMembers

childMembers: IList<DataMember>

container

container: AbstractElement

containerAsDataEntityBase

containerAsDataEntityBase: DataEntityBase

containerAsPublishedParameter

containerAsPublishedParameter: PublishedParameter

containerAsPublishedResource

containerAsPublishedResource: PublishedResource

entity

entity: IEntity

entityQualifiedName

entityQualifiedName: string

exposedItemName

exposedItemName: string

exposedName

exposedName: string

id

id: string

isKey

isKey: boolean

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

isLockedByContract

isLockedByContract: boolean

isNillable

isNillable: boolean

isNillableByContract

isNillableByContract: boolean

isOptional

isOptional: boolean

isOptionalByContract

isOptionalByContract: boolean

model

model: IModel

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

versionInfo

Static typeName

typeName: string

Static versionInfo

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

Generated using TypeDoc