Class GatewayActivity

Hierarchy (view full)

Constructors

constructor

Properties

$ context? key? process token?

Accessors

default id incoming name outgoing type

Methods

goOut isEnd isStart takeGatewayOutgoing takeOutgoing takeOutgoings build

Constructors

constructor

Properties

$

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

Type declaration

  • Optional default?: string
  • id: string
  • Optional name?: string

Optional context

context?: Context<any>

Protected Optional Readonly key

key?: string

Protected process

process: BPMNProcess

Optional token

token?: Token

Accessors

default

  • get default(): undefined | Sequence

  • If the default property exists, get the BPMN activity with the id of the default property, and if that exists, return a new Sequence object with the activity and the process

    Returns undefined | Sequence

    The default sequence flow.

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

  • get outgoing(): Sequence[]

  • It returns an array of Sequence objects that are outgoing from the current activity

    Returns Sequence[]

    An array of Sequence objects

type

  • get type(): undefined | Complex | Parallel | Inclusive | Exclusive | EventBased

  • If the key contains the word "complex", return GatewayType.Complex, otherwise if the key contains the word "parallel", return GatewayType.Parallel, otherwise if the key contains the word "inclusive", return GatewayType.Inclusive, otherwise if the key contains the word "exclusive", return GatewayType.Exclusive, otherwise if the key contains the word "eventBased", return GatewayType.EventBased, otherwise return undefined

    Returns undefined | Complex | Parallel | Inclusive | Exclusive | EventBased

    The type of the gateway.

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.

Protected takeGatewayOutgoing

takeOutgoing

  • takeOutgoing(identity?, options?): void

  • This function takes the outgoing sequence flows of a gateway and returns the next activity to be executed

    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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc