bpmn-server / Process

Class: Process

Table of contents

Constructors

• constructor

Properties

• id
• name
• isExecutable
• def
• parent
• childrenNodes
• eventSubProcesses
• subProcessEvents
• scripts
• candidateStarterGroups
• candidateStarterUsers
• historyTimeToLive
• isStartableInTasklist

Methods

• init
• start
• end
• getStartNode
• getStartNodes
• getEventSubProcessStart
• doEvent
• describe

Constructors

constructor

• new Process(definition, parent?): Process

Parameters

Name	Type	Default value
definition	any	undefined
parent	any	null

Returns

Process

Defined in

packages/bpmn-server/src/elements/Process.ts:26

Properties

id

• id: any

Defined in

packages/bpmn-server/src/elements/Process.ts:12

---

name

• name: any

Defined in

packages/bpmn-server/src/elements/Process.ts:13

---

isExecutable

• isExecutable: any

Defined in

packages/bpmn-server/src/elements/Process.ts:14

---

def

• def: Definition

Defined in

packages/bpmn-server/src/elements/Process.ts:15

---

parent

• parent: Process

Defined in

packages/bpmn-server/src/elements/Process.ts:16

---

childrenNodes

• childrenNodes: Node[]

Defined in

packages/bpmn-server/src/elements/Process.ts:17

---

eventSubProcesses

• eventSubProcesses: any[]

Defined in

packages/bpmn-server/src/elements/Process.ts:18

---

subProcessEvents

• subProcessEvents: any[]

Defined in

packages/bpmn-server/src/elements/Process.ts:19

---

scripts

• scripts: Map\<any, any>

Defined in

packages/bpmn-server/src/elements/Process.ts:20

---

candidateStarterGroups

• candidateStarterGroups: any

Defined in

packages/bpmn-server/src/elements/Process.ts:21

---

candidateStarterUsers

• candidateStarterUsers: any

Defined in

packages/bpmn-server/src/elements/Process.ts:22

---

historyTimeToLive

• historyTimeToLive: any

Defined in

packages/bpmn-server/src/elements/Process.ts:23

---

isStartableInTasklist

• isStartableInTasklist: any

Defined in

packages/bpmn-server/src/elements/Process.ts:24

Methods

init

▸ init(children, eventSubProcesses): void

Parameters

Name	Type
children	any
eventSubProcesses	any

Returns

void

Defined in

packages/bpmn-server/src/elements/Process.ts:38

---

start

▸ start(execution, parentToken): Promise\<void>

Notify process that it started

Parameters

Name	Type
execution	Execution
parentToken	any

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/elements/Process.ts:45

---

end

▸ end(execution): Promise\<void>

Notify process that it ended

Parameters

Name	Type
execution	IExecution

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/elements/Process.ts:68

---

getStartNode

▸ getStartNode(userInvokable?): any

Parameters

Name	Type	Default value
userInvokable	boolean	false

Returns

any

Defined in

packages/bpmn-server/src/elements/Process.ts:89

---

getStartNodes

▸ getStartNodes(userInvokable?): any[]

Parameters

Name	Type	Default value
userInvokable	boolean	false

Returns

any[]

Defined in

packages/bpmn-server/src/elements/Process.ts:92

---

getEventSubProcessStart

▸ getEventSubProcessStart(): Node[]

Returns

Node[]

Defined in

packages/bpmn-server/src/elements/Process.ts:109

---

doEvent

▸ doEvent(execution, event, eventDetails?): Promise\<void>

Parameters

Name	Type
execution	any
event	any
eventDetails	Object

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/elements/Process.ts:122

---

describe

▸ describe(): any[]

Returns

any[]

Defined in

packages/bpmn-server/src/elements/Process.ts:134

Comments