Class Activity

Hierarchy (view full)

Constructors

constructor

Properties

$ bpmn:incoming bpmn:outgoing context? key? process token?

Accessors

id incoming name outgoing

Methods

goOut isEnd isStart takeOutgoing takeOutgoings build

Constructors

constructor

Properties

$

$: {
    id: string;
    name?: string;
}

Type declaration

  • id: string
  • Optional name?: string

Private Readonly bpmn:incoming

bpmn:incoming: string[]

Private Readonly bpmn:outgoing

bpmn:outgoing: string[]

Optional context

context?: Context<any>

Protected Optional Readonly key

key?: string

Protected process

process: BPMNProcess

Optional token

token?: Token

Accessors

id

  • get id(): string

  • The function returns the value of the id property of the object that is stored in the $ property of the current object

    Returns string

    The id property of the object.

incoming

  • get incoming(): Sequence[]

  • The incoming property returns an array of Sequence objects that are incoming to the current Activity

    Returns Sequence[]

    An array of Sequence objects.

name

  • get name(): undefined | string

  • The function returns the value of the name property of the object that is stored in the $ property of the current object

    Returns undefined | string

    The name property of the object.

outgoing

Methods

Protected goOut

  • goOut(outgoing): void

  • The function handles outgoing transitions for a token in a workflow system.

    Parameters

    • outgoing: GoOutInterface[]

      outgoing is an array of objects of type GoOutInterface. Each object represents an outgoing transition from a current activity to a new activity.

    Returns void

isEnd

  • isEnd(): undefined | boolean

  • If the key property of the current node is not null and includes the string 'endEvent', return true

    Returns undefined | boolean

    The key of the current node.

isStart

  • isStart(): undefined | boolean

  • If the key property exists and includes the string 'startEvent', return true. Otherwise, return false

    Returns undefined | boolean

    A boolean value.

takeOutgoing

  • takeOutgoing(identity?, options?): void

  • It takes the outgoing sequence flows from the current activity and creates a new token for each one

    Parameters

    • Optional identity: IdentityOptions

      IdentityOptions

    • Optional options: {
          pause: string | boolean;
      }

      pause: boolean | string

      • pause: string | boolean

    Returns void

    The outgoing activity

takeOutgoings

  • takeOutgoings(options): void

  • The function takes an array of options, retrieves corresponding activities from an outgoing array, and passes them to another function.

    Parameters

    • options: TakeOutgoingInterface[]

      An array of objects with two properties: "identity" and "pause". "identity" is a string representing the identity of the outgoing activity to be taken out, and "pause" is a boolean indicating whether the activity should be paused or not.

    Returns void

    If the outgoing property is falsy or an empty array, nothing is returned.

Static build

  • build(el, process, key?): Activity

  • It creates a new Activity object.

    Parameters

    • el: BPMNActivity

      BPMNActivity - the element from the BPMN file

    • process: BPMNProcess

      The process that the activity belongs to.

    • Optional key: string

      The key of the element.

    Returns Activity

    A new instance of the Activity class.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc