Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExposedAssociation

In version 7.6.0: introduced

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "MessageDefinitions$ExposedAssociation"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

association

associationQualifiedName

  • get associationQualifiedName(): string

  • Returns string

children

container

  • get container(): TContainer

  • Returns TContainer

containerAsCSVSheet

  • get containerAsCSVSheet(): CSVSheet

  • Returns CSVSheet

containerAsElement

containerAsEntityMessageDefinition

containerAsExcelSheet

  • get containerAsExcelSheet(): ExcelSheet

  • Returns ExcelSheet

containerAsJsonStructure

  • Returns JsonStructure

documentation

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

  • In version 7.15.0: introduced

    Returns string

  • In version 7.15.0: introduced

    Parameters

    • newValue: string

    Returns void

elementType

  • Returns ElementType

  • Parameters

    Returns void

entity

  • Returns IEntity

  • Parameters

    Returns void

entityQualifiedName

  • get entityQualifiedName(): string

  • Returns string

errorMessage

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

example

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

  • In version 7.15.0: introduced

    Returns string

  • In version 7.15.0: introduced

    Parameters

    • newValue: string

    Returns void

exposedItemName

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

  • In version 7.6.0: introduced

    Returns string

  • In version 7.6.0: introduced

    Parameters

    • newValue: string

    Returns void

exposedName

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

fractionDigits

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

  • Returns number

  • Parameters

    • newValue: number

    Returns void

isDefaultType

  • get isDefaultType(): boolean
  • set isDefaultType(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

maxLength

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

  • Returns number

  • Parameters

    • newValue: number

    Returns void

maxOccurs

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

  • Returns number

  • Parameters

    • newValue: number

    Returns void

minOccurs

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

  • Returns number

  • Parameters

    • newValue: number

    Returns void

model

  • get model(): TModel

  • Returns TModel

nillable

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

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

originalName

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

path

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

  • The value of this property is conceptually of type mappings.ElementPath.

    Returns string

  • The value of this property is conceptually of type mappings.ElementPath.

    Parameters

    • newValue: string

    Returns void

primitiveType

  • Returns XmlPrimitiveType

  • Parameters

    Returns void

totalDigits

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

  • Returns number

  • Parameters

    • newValue: number

    Returns void

unit

warningMessage

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

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 ExposedAssociation

deepCopy

deepCopyWithIdMap

delete

  • delete(): 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<ExposedAssociation>

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

traversePublicParts

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

Static create

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

Static createInElementUnderChildren

  • Creates and returns a new ExposedAssociation instance in the SDK and on the server. The new ExposedAssociation will be automatically stored in the 'children' property of the parent mappings.Element element passed as argument.

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

    Parameters

    Returns ExposedAssociation

Static createInJsonStructureUnderElements

  • Creates and returns a new ExposedAssociation instance in the SDK and on the server. The new ExposedAssociation will be automatically stored in the 'elements' property of the parent jsonstructures.JsonStructure element passed as argument.

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

    Parameters

    Returns ExposedAssociation

Generated using TypeDoc