Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

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

Accessors

  • 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

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

  • 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