Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JavaActionParameter

Hierarchy

Implements

Index

Constructors

constructor

Properties

actionParameterType

actionParameterType: ParameterType

In version 7.21.0: introduced

category

category: string

In version 7.18.0: introduced

container

container: AbstractElement

containerAsCodeAction

containerAsCodeAction: CodeAction

containerAsJavaAction

containerAsJavaAction: JavaAction

description

description: string

In version 6.10.0: introduced

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

javaType

javaType: Type

In version 6.7.0: deleted In version 6.6.0: introduced

model

model: IModel

name

name: string

parameterType

parameterType: ParameterType

In version 7.21.0: deleted In version 6.7.0: introduced

qualifiedName

qualifiedName: string | null

structureTypeName

structureTypeName: string

type

type: string

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

In version 6.6.0: deleted

unit

unit: ModelUnit

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

asLoaded

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

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

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise
  • 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: ): void
        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

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

    Returns JavaActionParameter

Static createInCodeActionUnderActionParameters

  • 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

Static createInJavaActionUnderParameters

  • 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