Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

__childMembers: PartListProperty<DataMember> = ...
internal
internal
__exposedItemName: PrimitiveProperty<string> = ...
internal
__exposedName: PrimitiveProperty<string> = ...
internal
__isKey: PrimitiveProperty<boolean> = ...
internal
__isLockedByContract: PrimitiveProperty<boolean> = ...
internal
__isNillable: PrimitiveProperty<boolean> = ...
internal
__isNillableByContract: PrimitiveProperty<boolean> = ...
internal
__isOptional: PrimitiveProperty<boolean> = ...
internal
__isOptionalByContract: PrimitiveProperty<boolean> = ...
internal
_container: null | IContainer
internal
_declaredAsNamespace: boolean = false
internal
_isDoingDelete: boolean = false
internal
_isPartial: boolean
internal
_isReverting: boolean = false

Indicates that the internal data of this element is being reverted to its previous value, so some validation check could be skipped

internal
_isUpdating: boolean = true

Indicates that the internal data of this element is being updated, as a result of data received from the server, so no storage events should be send

internal
internal
_registeredQualifiedName: null | string = null

used by qualified names cache to determine old name after a rename

internal
_state: StructureState = "attached"

The current state of the structure: (new|attached|detached|deleted).

internal
internal
id: string
structureTypeName: string
structureTypeName: string = "WebServices$DataEntity"
versionInfo: StructureVersionInfo = ...

Accessors

  • get _isAttached(): boolean
  • This structure is attached somewhere in the model. This is the "normal" state for an structure.

    internal

    Returns boolean

  • get _isDeleted(): boolean
  • This structure has been deleted and should no longer be used.

    internal

    Returns boolean

  • get _isDetached(): boolean
  • This structure is detached, so that it can be attached somewhere else in the model.

    internal

    Returns boolean

  • get _isNew(): boolean
  • This structure was just constructed and has not been added to the model yet.

    internal

    Returns boolean

  • get container(): TContainer
  • Returns TContainer

  • Returns DataEntityBase

  • get entity(): null | IEntity
  • set entity(newValue: null | IEntity): void
  • Returns null | IEntity

  • Parameters

    Returns void

  • get entityQualifiedName(): null | string
  • Returns null | string

  • get exposedItemName(): string
  • set exposedItemName(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get exposedName(): string
  • set exposedName(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get isKey(): boolean
  • set isKey(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

  • get isLockedByContract(): boolean
  • set isLockedByContract(newValue: boolean): void
  • In version 9.0.2: deleted

    Returns boolean

  • In version 9.0.2: deleted

    Parameters

    • newValue: boolean

    Returns void

  • get isNillable(): boolean
  • set isNillable(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get isNillableByContract(): boolean
  • set isNillableByContract(newValue: boolean): void
  • In version 9.0.2: deleted

    Returns boolean

  • In version 9.0.2: deleted

    Parameters

    • newValue: boolean

    Returns void

  • get isOptional(): boolean
  • set isOptional(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get isOptionalByContract(): boolean
  • set isOptionalByContract(newValue: boolean): void
  • In version 9.0.2: deleted

    Returns boolean

  • In version 9.0.2: deleted

    Parameters

    • newValue: boolean

    Returns void

  • get model(): TModel
  • Returns TModel

Methods

  • Finds the given child among the properties of this structure, returning a handle to detach it later when appropriate based on in which property is was found.

    internal

    Parameters

    Returns null | IChildHandle

  • _deleteInternal(): void
  • _dispose(): void
  • This model element is no longer part of the model, and can be cleaned up.

    internal

    Returns void

  • _getQualifiedName(): null | string
  • _initializeDefaultProperties(): void
  • _initializeNewInstance(): void
  • _isByNameReferrable(): boolean
  • Return true if this is an abstractElement that might be referred to by some other element. If true, this element is maintained in the qualifiedNamesCache

    internal

    Returns boolean

  • _markCurrentValuesAsDefaults(): void
  • _processLocalNameChange(previousName: null | string): void
  • _processNameChange(): void
  • If the name of a model element changes, this might effect currently broken references-by-name, so let's process those.

    internal

    Returns void

  • _registerProperty(prop: AbstractProperty<any, any>, declaredOn: IStructureClass): void
  • _scheduleDeltaAfterCreate(delta: Delta): void
  • _sendChangeDelta(propertyName: string, newValue: any, changeType?: "CHANGE" | "ADD" | "REMOVE", index?: number): void
  • Sends the change delta in case a simple property has changed.

    internal

    Parameters

    • propertyName: string
    • newValue: any
    • changeType: "CHANGE" | "ADD" | "REMOVE" = "CHANGE"
    • index: number = -1

    Returns void

  • _sendDeleteDelta(): void
  • _sendDetachDelta(): void
  • 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 DataEntity

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • load(callback: (elem: DataEntity) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<DataEntity>
  • 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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<DataEntity>

  • resolveByIdReferences(): void
  • Should be called after deserialization / remote updates, to make sure all references are bound to their actual value.

    internal

    Returns void

  • 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(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<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(visit: (structure: IStructure) => void): void
  • Creates and returns a new DataEntity 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 DataEntity

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

    Parameters

    Returns DataEntity

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

    Parameters

    Returns DataEntity

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

    Parameters

    Returns DataEntity

Generated using TypeDoc