Class EventActivity

Hierarchy (view full)

Constructors

constructor

Properties

$ context? key? process token?

Accessors

attachedToRef eventDefinitionType id incoming intermediateType name outgoing type

Methods

goOut isEnd isStart takeOutgoing takeOutgoings build

Constructors

constructor

Properties

$

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

Type declaration

  • Optional attachedToRef?: 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

attachedToRef

eventDefinitionType

  • get eventDefinitionType(): undefined | EventDefinitionType

  • If the event definition is a link event definition, return the link event definition type, otherwise if it's a timer event definition, return the timer event definition type, otherwise if it's an error event definition, return the error event definition type, otherwise if it's a signal event definition, return the signal event definition type, otherwise if it's a message event definition, return the message event definition type, otherwise if it's an escalation event definition, return the escalation event definition type, otherwise if it's a conditional event definition, return the conditional event definition type, otherwise if it's a compensation event definition, return the compensation event definition type

    Returns undefined | EventDefinitionType

    The type of the event definition.

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.

intermediateType

  • get intermediateType(): undefined | Throw | Catch

  • If the key contains the word "throw", return "Throw", otherwise if the key contains the word "catch", return "Catch"

    Returns undefined | Throw | Catch

    The intermediateType property is being returned.

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 | End | Start | Boundary | Intermediate

  • If the event is attached to a reference, it's a boundary event. If the event's key contains the word "end", it's an end event. If the event's key contains the word "start", it's a start event. If the event's key contains the word "intermediate", it's an intermediate event. If none of the above are true, it's a start event

    Returns undefined | End | Start | Boundary | Intermediate

    The type of the event.

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc