Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SystemIdDataAttribute

In version 6.7.0: introduced

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "WebServices$SystemIdDataAttribute"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

  • get container(): TContainer

  • Returns TContainer

containerAsDataEntityBase

containerAsPublishedParameter

containerAsPublishedResource

description

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

  • In version 8.5.0: introduced

    Returns string

  • In version 8.5.0: introduced

    Parameters

    • newValue: string

    Returns void

entity

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

entityQualifiedName

  • get entityQualifiedName(): null | string

  • Returns null | string

exposedName

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

isKey

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

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

isLoaded

  • get isLoaded(): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

isLockedByContract

  • 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

isNillable

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

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

isNillableByContract

  • 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

isOptional

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

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

isOptionalByContract

  • 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

model

  • get model(): TModel

  • Returns TModel

summary

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

  • In version 8.5.0: introduced

    Returns string

  • In version 8.5.0: introduced

    Parameters

    • newValue: string

    Returns void

unit

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 SystemIdDataAttribute

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

  • Deletes this element from the model.

    Returns void

detach

findElementById

Protected getContainerAs

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

load

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

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

  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

traversePublicParts

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

Static create

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

Static createIn

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.7.0 and higher

    Parameters

    Returns SystemIdDataAttribute

Generated using TypeDoc