Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MsdMicroflow

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___description

___description: any

Private ___documentation

___documentation: any

Private ___image

___image: any

Private ___name

___name: any

Private ___parameters

___parameters: any

Private ___returnType

___returnType: any

Private ___returnTypeCanBeEmpty

___returnTypeCanBeEmpty: any

Private ___returnTypeSpecification

___returnTypeSpecification: any

Private ___systemEntityType

___systemEntityType: any

container

container: AbstractElement

containerAsMsdMetadata

containerAsMsdMetadata: MsdMetadata

description

description: string

documentation

documentation: string

id

id: string

image

image: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

model

model: IModel

name

name: string

parameters

parameters: IList<MsdMicroflowParameter>

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

returnType

returnType: string

returnTypeCanBeEmpty

returnTypeCanBeEmpty: boolean

returnTypeSpecification

returnTypeSpecification: string

systemEntityType

systemEntityType: string

In version 6.1.0: deleted

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

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

    Type parameters

    Parameters

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

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

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

Static createIn

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

    Parameters

    Returns MsdMicroflow

Generated using TypeDoc