Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IndirectEntityRef

In version 9.6.0: added public In version 7.11.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

container

containerAsCreateObjectClientAction

containerAsEntityPathSource

containerAsEntityWidget

containerAsMemberRef

containerAsNewButton

containerAsParameter

containerAsReferenceSetSelector

containerAsSelectorXPathSource

containerAsWidgetValue

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

model

steps

unit

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

  • 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

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

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

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

Static createInCreateObjectClientActionUnderEntityRef

  • Creates and returns a new IndirectEntityRef instance in the SDK and on the server. The new IndirectEntityRef will be automatically stored in the 'entityRef' property of the parent pages.CreateObjectClientAction element passed as argument.

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

    Parameters

    Returns IndirectEntityRef

Static createInEntityPathSourceUnderEntityRef

  • Creates and returns a new IndirectEntityRef instance in the SDK and on the server. The new IndirectEntityRef will be automatically stored in the 'entityRef' property of the parent pages.EntityPathSource element passed as argument.

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

    Parameters

    Returns IndirectEntityRef

Static createInEntityWidgetUnderEntityRef

  • Creates and returns a new IndirectEntityRef instance in the SDK and on the server. The new IndirectEntityRef will be automatically stored in the 'entityRef' property of the parent documenttemplates.EntityWidget element passed as argument.

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

    Parameters

    Returns IndirectEntityRef

Static createInMemberRefUnderEntityRef

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

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

    Parameters

    Returns IndirectEntityRef

Static createInNewButtonUnderEntityRef

  • Creates and returns a new IndirectEntityRef instance in the SDK and on the server. The new IndirectEntityRef will be automatically stored in the 'entityRef' property of the parent pages.NewButton element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.11.0 to 7.16.0

    Parameters

    Returns IndirectEntityRef

Static createInParameterUnderEntityRef

  • Creates and returns a new IndirectEntityRef instance in the SDK and on the server. The new IndirectEntityRef will be automatically stored in the 'entityRef' property of the parent workflows.Parameter element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 9.6.0 to 9.9.0

    Parameters

    Returns IndirectEntityRef

Static createInReferenceSetSelectorUnderConstrainedByRefs

  • Creates and returns a new IndirectEntityRef instance in the SDK and on the server. The new IndirectEntityRef will be automatically stored in the 'constrainedByRefs' property of the parent pages.ReferenceSetSelector element passed as argument.

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

    Parameters

    Returns IndirectEntityRef

Static createInSelectorXPathSourceUnderConstrainedByRefs

  • Creates and returns a new IndirectEntityRef instance in the SDK and on the server. The new IndirectEntityRef will be automatically stored in the 'constrainedByRefs' property of the parent pages.SelectorXPathSource element passed as argument.

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

    Parameters

    Returns IndirectEntityRef

Static createInWidgetValueUnderEntityRef

  • Creates and returns a new IndirectEntityRef instance in the SDK and on the server. The new IndirectEntityRef will be automatically stored in the 'entityRef' property of the parent customwidgets.WidgetValue element passed as argument.

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

    Parameters

    Returns IndirectEntityRef

Generated using TypeDoc