Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IWorkflow

In version 9.0.5: removed experimental In version 9.0.2: introduced

Hierarchy

Implemented by

Index

Properties

allowedModuleRoles

allowedModuleRoles: IList<IModuleRole>

In version 9.6.0: deleted

allowedModuleRolesQualifiedNames

allowedModuleRolesQualifiedNames: string[]

container

container: IStructuralUnit

containerAsFolderBase

containerAsFolderBase: IFolderBase

containerAsModule

containerAsModule: IModule

contextEntity

contextEntity: IEntity | null

In version 9.6.0: deleted

contextEntityQualifiedName

contextEntityQualifiedName: string | null

documentation

documentation: string

In version 9.10.0: added public

excluded

excluded: boolean

In version 9.11.0: added public

flow

flow: IFlow

This property is required and cannot be set to null.

id

id: string

isLoadable

isLoadable: boolean

Whether this unit and all of its children (recursively) can be loaded.

isLoaded

isLoaded: boolean

Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

isReadOnly

isReadOnly: boolean

Whether this unit and all of its children (recursively) are editable.

model

model: IModel

name

name: string

overviewPage

overviewPage: IPage | null

In version 9.11.0: deleted

overviewPageQualifiedName

overviewPageQualifiedName: string | null

parameter

parameter: IParameter

This property is required and cannot be set to null.

In version 9.6.0: introduced

qualifiedName

qualifiedName: string | null

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.

structureTypeName

structureTypeName: string

title

title: string

unit

Unit that owns/contains this thing.

workflowEntity

workflowEntity: IEntity | null

In version 9.7.0: deleted In version 9.6.0: introduced

workflowEntityQualifiedName

workflowEntityQualifiedName: string | null

workflowType

workflowType: IWorkflowType

This property is required and cannot be set to null.

In version 9.10.0: deleted In version 9.7.0: introduced

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

delete

  • delete(): void

findElementById

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<Workflow>
  • Parameters

    • callback: function
    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<Workflow>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]
  • Returns all properties when this structure is loaded, otherwise just the public properties.

    Returns AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

  • toJSON(): object
  • 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 object

traverse

  • traverse(visit: function): 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: function): T | null
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Generated using TypeDoc