flow

bpmn-server / Flow

Class: Flow

Hierarchy

• Element

  ↳ Flow

  ↳↳ MessageFlow

Implements

• IFlow

Table of contents

Constructors

• constructor

Properties

• behaviours
• def
• from
• id
• isFlow
• isMessageFlow
• lane
• name
• subType
• to
• type

Methods

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

Constructors

constructor

• new Flow(id, type, from, to, def): Flow

Parameters

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

Returns

Flow

Overrides

Element.constructor

Defined in

elements/Flow.ts:16

Properties

behaviours

• behaviours: Map<any, any>

Implementation of

IFlow.behaviours

Inherited from

Element.behaviours

Defined in

elements/Element.ts:17

---

def

• def: any

Defined in

elements/Flow.ts:14

---

from

• from: Node

Defined in

elements/Flow.ts:12

---

id

• id: any

Implementation of

IFlow.id

Inherited from

Element.id

Defined in

elements/Element.ts:13

---

isFlow

• isFlow: boolean = false

Inherited from

Element.isFlow

Defined in

elements/Element.ts:18

---

isMessageFlow

• isMessageFlow: boolean = false

Defined in

elements/Flow.ts:15

---

lane

• lane: any

Implementation of

IFlow.lane

Inherited from

Element.lane

Defined in

elements/Element.ts:19

---

name

• name: any

Implementation of

IFlow.name

Inherited from

Element.name

Defined in

elements/Element.ts:16

---

subType

• subType: any

Inherited from

Element.subType

Defined in

elements/Element.ts:15

---

to

• to: Node

Defined in

elements/Flow.ts:13

---

type

• type: any

Implementation of

IFlow.type

Inherited from

Element.type

Defined in

elements/Element.ts:14

Methods

addBehaviour

▸ addBehaviour(nane, behavriour): void

Parameters

Name	Type
nane	any
behavriour	any

Returns

void

Implementation of

IFlow.addBehaviour

Inherited from

Element.addBehaviour

Defined in

elements/Element.ts:39

---

continue

▸ continue(item): void

Parameters

Name	Type
item	Item

Returns

void

Implementation of

IFlow.continue

Inherited from

Element.continue

Defined in

elements/Element.ts:20

---

describe

▸ describe(): any[][]

Returns

any[][]

Implementation of

IFlow.describe

Overrides

Element.describe

Defined in

elements/Flow.ts:26

---

evaluateCondition

▸ evaluateCondition(item): any

Parameters

Name	Type
item	any

Returns

any

Defined in

elements/Flow.ts:53

---

execute

▸ execute(item): Promise<void>

Parameters

Name	Type
item	any

Returns

Promise<void>

Defined in

elements/Flow.ts:66

---

getBehaviour

▸ getBehaviour(name): any

Parameters

Name	Type
name	any

Returns

any

Implementation of

IFlow.getBehaviour

Inherited from

Element.getBehaviour

Defined in

elements/Element.ts:36

---

hasBehaviour

▸ hasBehaviour(name): boolean

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

Parameters

Name	Type
name	any

Returns

boolean

Implementation of

IFlow.hasBehaviour

Inherited from

Element.hasBehaviour

Defined in

elements/Element.ts:32

---

restored

▸ restored(item): void

Parameters

Name	Type
item	Item

Returns

void

Implementation of

IFlow.restored

Inherited from

Element.restored

Defined in

elements/Element.ts:22

---

resume

▸ resume(item): void

Parameters

Name	Type
item	Item

Returns

void

Implementation of

IFlow.resume

Inherited from

Element.resume

Defined in

elements/Element.ts:25

---

run

▸ run(item): FLOW_ACTION

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
item	Item

Returns

FLOW_ACTION

Defined in

elements/Flow.ts:43