Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MsdAssociation

In version 9.0.2: deleted

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "AppServices$MsdAssociation"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

associationKind

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

associationOwner

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

associationType

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

childDeleteBehavior

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

childEntityName

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

childX

  • get childX(): number
  • set childX(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

childY

  • get childY(): number
  • set childY(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

container

  • get container(): TContainer

  • Returns TContainer

containerAsDataAssociation

containerAsMsdDomainModel

guid

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

  • Returns string

  • Parameters

    • newValue: string

    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

model

  • get model(): TModel

  • Returns TModel

name

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

parentDeleteBehavior

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

parentEntityName

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

parentX

  • get parentX(): number
  • set parentX(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

parentY

  • get parentY(): number
  • set parentY(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    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 MsdAssociation

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

  • Deletes this element from the model.

    Returns void

detach

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

    Returns MsdAssociation

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

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

Static createInDataAssociationUnderAssociationByContract

  • Creates and returns a new MsdAssociation instance in the SDK and on the server. The new MsdAssociation will be automatically stored in the 'associationByContract' property of the parent webservices.DataAssociation element passed as argument.

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

    Parameters

    Returns MsdAssociation

Static createInMsdDomainModelUnderAssociations

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

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

    Parameters

    Returns MsdAssociation

Generated using TypeDoc