messageflow

bpmn-server › MessageFlow

Class: MessageFlow

MessageFlow: can only be sent to active node in waiting or to a start event

Hierarchy

↳ Flow

↳ MessageFlow

Implements

• IElement
• IFlow

Index

Constructors

• constructor

Properties

• behaviours
• def
• from
• id
• isMessageFlow
• name
• to
• type

Methods

• addBehaviour
• continue
• describe
• execute
• getBehaviour
• hasBehaviour
• restored
• resume
• run

Constructors

constructor

+ new MessageFlow(id: any, type: any, from: any, to: any, def: any): MessageFlow

Inherited from Flow.constructor

Defined in src/elements/Flow.ts:14

Parameters:

Name	Type
id	any
type	any
from	any
to	any
def	any

Returns: MessageFlow

Properties

behaviours

• behaviours: Map‹any, any› = new Map()

Implementation of IFlow.behaviours

Inherited from Element.behaviours

Defined in src/elements/Element.ts:16

---

def

• def: any

Inherited from Flow.def

Defined in src/elements/Flow.ts:13

---

from

• from: Node

Inherited from Flow.from

Defined in src/elements/Flow.ts:11

---

id

• id: any

Implementation of IFlow.id

Inherited from Element.id

Defined in src/elements/Element.ts:13

---

isMessageFlow

• isMessageFlow: boolean = true

Overrides Flow.isMessageFlow

Defined in src/elements/Flow.ts:70

---

name

• name: any

Implementation of IFlow.name

Inherited from Element.name

Defined in src/elements/Element.ts:15

---

to

• to: Node

Inherited from Flow.to

Defined in src/elements/Flow.ts:12

---

type

• type: any

Implementation of IFlow.type

Inherited from Element.type

Defined in src/elements/Element.ts:14

Methods

addBehaviour

▸ addBehaviour(nane: any, behavriour: any): void

Implementation of IFlow

Inherited from Element.addBehaviour

Defined in src/elements/Element.ts:38

Parameters:

Name	Type
nane	any
behavriour	any

Returns: void

---

continue

▸ continue(item: Item): void

Inherited from Element.continue

Defined in src/elements/Element.ts:19

Parameters:

Name	Type
item	Item

Returns: void

---

describe

▸ describe(): any[][]

Implementation of IFlow

Inherited from Flow.describe

Overrides Element.describe

Defined in src/elements/Flow.ts:24

Returns: any[][]

---

execute

▸ execute(item: Item): Promise‹void›

Overrides Flow.execute

Defined in src/elements/Flow.ts:72

Parameters:

Name	Type
item	Item

Returns: Promise‹void›

---

getBehaviour

▸ getBehaviour(name: any): any

Implementation of IFlow

Inherited from Element.getBehaviour

Defined in src/elements/Element.ts:35

Parameters:

Name	Type
name	any

Returns: any

---

hasBehaviour

▸ hasBehaviour(name: any): boolean

Implementation of IFlow

Inherited from Element.hasBehaviour

Defined in src/elements/Element.ts:31

respond by providing behaviour attributes beyond item and node information ex: timer due , input/outupt , fields

Parameters:

Name	Type
name	any

Returns: boolean

---

restored

▸ restored(item: Item): void

Inherited from Element.restored

Defined in src/elements/Element.ts:21

Parameters:

Name	Type
item	Item

Returns: void

---

resume

▸ resume(item: Item): void

Inherited from Element.resume

Defined in src/elements/Element.ts:24

Parameters:

Name	Type
item	Item

Returns: void

---

run

▸ run(item: Item): FLOW_ACTION

Inherited from Flow.run

Defined in src/elements/Flow.ts:41

if flow has a condition, it must be evaluated and if result is true flow will continue otherwise, flow will be discarded.

Parameters:

Name	Type	Description
item	Item

Returns: FLOW_ACTION