Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

Properties

__actionParameterType: PartProperty<codeactions.ParameterType> = ...
internal
__category: PrimitiveProperty<string> = ...
internal
__description: PrimitiveProperty<string> = ...
internal
__isRequired: PrimitiveProperty<boolean> = ...
internal
__javaType: PartProperty<javaactions.Type> = ...
internal
__name: PrimitiveProperty<string> = ...
internal
__parameterType: PartProperty<javaactions.ParameterType> = ...
internal
__type: PrimitiveProperty<string> = ...
internal
_container: null | IContainer
internal
_declaredAsNamespace: boolean = false
internal
_isDoingDelete: boolean = false
internal
_isPartial: boolean
internal
_isReverting: boolean = false

Indicates that the internal data of this element is being reverted to its previous value, so some validation check could be skipped

internal
_isUpdating: boolean = true

Indicates that the internal data of this element is being updated, as a result of data received from the server, so no storage events should be send

internal
internal
_registeredQualifiedName: null | string = null

used by qualified names cache to determine old name after a rename

internal
_state: StructureState = "attached"

The current state of the structure: (new|attached|detached|deleted).

internal
internal
id: string
structureTypeName: string
structureTypeName: string = "JavaActions$JavaActionParameter"
versionInfo: StructureVersionInfo = ...

Accessors

  • get _isAttached(): boolean
  • This structure is attached somewhere in the model. This is the "normal" state for an structure.

    internal

    Returns boolean

  • get _isDeleted(): boolean
  • This structure has been deleted and should no longer be used.

    internal

    Returns boolean

  • get _isDetached(): boolean
  • This structure is detached, so that it can be attached somewhere else in the model.

    internal

    Returns boolean

  • get _isNew(): boolean
  • This structure was just constructed and has not been added to the model yet.

    internal

    Returns boolean

  • get category(): string
  • set category(newValue: string): void
  • In version 7.18.0: introduced

    Returns string

  • In version 7.18.0: introduced

    Parameters

    • newValue: string

    Returns void

  • get container(): TContainer
  • get description(): string
  • set description(newValue: string): void
  • In version 6.10.0: introduced

    Returns string

  • In version 6.10.0: introduced

    Parameters

    • newValue: string

    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 isRequired(): boolean
  • set isRequired(newValue: boolean): void
  • In version 9.17.0: introduced

    Returns boolean

  • In version 9.17.0: introduced

    Parameters

    • newValue: boolean

    Returns void

  • get model(): TModel
  • get name(): string
  • set name(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get qualifiedName(): null | string
  • Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

    Returns null | string

  • get type(): string
  • set type(newValue: string): void
  • The value of this property is conceptually of type dataTypes.LegacyDataType.

    In version 6.6.0: deleted

    Returns string

  • The value of this property is conceptually of type dataTypes.LegacyDataType.

    In version 6.6.0: deleted

    Parameters

    • newValue: string

    Returns void

Methods

  • _deleteInternal(): void
  • _dispose(): void
  • This model element is no longer part of the model, and can be cleaned up.

    internal

    Returns void

  • _getQualifiedName(): null | string
  • _initializeDefaultProperties(): void
  • _initializeNewInstance(): void
  • _isByNameReferrable(): boolean
  • _markCurrentValuesAsDefaults(): void
  • _processLocalNameChange(previousName: null | string): void
  • _processNameChange(): void
  • If the name of a model element changes, this might effect currently broken references-by-name, so let's process those.

    internal

    Returns void

  • _registerProperty(prop: AbstractProperty<any, any>, declaredOn: IStructureClass): void
  • _scheduleDeltaAfterCreate(delta: Delta): void
  • _sendChangeDelta(propertyName: string, newValue: any, changeType?: "CHANGE" | "ADD" | "REMOVE", index?: number): void
  • Sends the change delta in case a simple property has changed.

    internal

    Parameters

    • propertyName: string
    • newValue: any
    • changeType: "CHANGE" | "ADD" | "REMOVE" = "CHANGE"
    • index: number = -1

    Returns void

  • _sendDeleteDelta(): void
  • _sendDetachDelta(): void
  • 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 JavaActionParameter

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • resolveByIdReferences(): void
  • 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
  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates and returns a new JavaActionParameter 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 JavaActionParameter

  • Creates and returns a new JavaActionParameter instance in the SDK and on the server. The new JavaActionParameter will be automatically stored in the 'actionParameters' property of the parent codeactions.CodeAction element passed as argument.

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

    Parameters

    Returns JavaActionParameter

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

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

    Parameters

    Returns JavaActionParameter

Generated using TypeDoc