bpmn-server / INode

Interface: INode

Hierarchy

• IElement

↳ INode

Table of contents

Properties

• id
• type
• lane
• behaviours
• name
• processId
• def
• outbounds
• inbounds

Methods

• describe
• restored
• hasBehaviour
• getBehaviour
• addBehaviour
• doEvent
• enter
• requiresWait
• canBeInvoked
• execute
• continue
• start
• run
• end
• resume
• init
• getOutbounds

Properties

id

• id: any

Inherited from

IElement.id

Defined in

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

---

type

• type: any

Inherited from

IElement.type

Defined in

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

---

lane

• lane: any

Inherited from

IElement.lane

Defined in

packages/bpmn-server/src/interfaces/elements.ts:25

---

behaviours

• behaviours: Map\<any, any>

Inherited from

IElement.behaviours

Defined in

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

---

name

• name: any

Overrides

IElement.name

Defined in

packages/bpmn-server/src/interfaces/elements.ts:43

---

processId

• processId: any

Defined in

packages/bpmn-server/src/interfaces/elements.ts:44

---

def

• def: any

Defined in

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

---

outbounds

• outbounds: any[]

Defined in

packages/bpmn-server/src/interfaces/elements.ts:46

---

inbounds

• inbounds: any[]

Defined in

packages/bpmn-server/src/interfaces/elements.ts:47

Methods

describe

▸ describe(): string[][]

Returns

string[][]

Inherited from

IElement.describe

Defined in

packages/bpmn-server/src/interfaces/elements.ts:28

---

restored

▸ restored(item): void

Parameters

Name	Type
item	IItem

Returns

void

Inherited from

IElement.restored

Defined in

packages/bpmn-server/src/interfaces/elements.ts:29

---

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

Inherited from

IElement.hasBehaviour

Defined in

packages/bpmn-server/src/interfaces/elements.ts:35

---

getBehaviour

▸ getBehaviour(name): any

Parameters

Name	Type
name	any

Returns

any

Inherited from

IElement.getBehaviour

Defined in

packages/bpmn-server/src/interfaces/elements.ts:36

---

addBehaviour

▸ addBehaviour(nane, behavriour): void

Parameters

Name	Type
nane	any
behavriour	any

Returns

void

Inherited from

IElement.addBehaviour

Defined in

packages/bpmn-server/src/interfaces/elements.ts:37

---

doEvent

▸ doEvent(item, event, newStatus): Promise\<void>

Parameters

Name	Type
item	IItem
event	EXECUTION_EVENT
newStatus	ITEM_STATUS

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/interfaces/elements.ts:48

---

enter

▸ enter(item): void

Parameters

Name	Type
item	IItem

Returns

void

Defined in

packages/bpmn-server/src/interfaces/elements.ts:49

---

requiresWait

▸ requiresWait(): boolean

Returns

boolean

Defined in

packages/bpmn-server/src/interfaces/elements.ts:50

---

canBeInvoked

▸ canBeInvoked(): boolean

Returns

boolean

Defined in

packages/bpmn-server/src/interfaces/elements.ts:51

---

execute

▸ execute(item): Promise\<void | wait | error | abort>

this is the primary exectuion method for a node

considerations: the following are handled by Token 1. Loops we are inside a loop already (if any) 2. Gatways 3. Subprocess the parent node is fired as normal run method will fire the subprocess invoking a new token and will go into wait

Parameters

Name	Type
item	IItem

Returns

Promise\<void | wait | error | abort>

Defined in

packages/bpmn-server/src/interfaces/elements.ts:61

---

continue

▸ continue(item): Promise\<void>

Parameters

Name	Type
item	IItem

Returns

Promise\<void>

Overrides

IElement.continue

Defined in

packages/bpmn-server/src/interfaces/elements.ts:62

---

start

▸ start(item): Promise\<NODE_ACTION>

Parameters

Name	Type
item	IItem

Returns

Promise\<NODE_ACTION>

Defined in

packages/bpmn-server/src/interfaces/elements.ts:63

---

run

▸ run(item): Promise\<NODE_ACTION>

Parameters

Name	Type
item	IItem

Returns

Promise\<NODE_ACTION>

Defined in

packages/bpmn-server/src/interfaces/elements.ts:64

---

end

▸ end(item): Promise\<void>

Parameters

Name	Type
item	IItem

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/interfaces/elements.ts:65

---

resume

▸ resume(item): void

is called by the token after an execution resume for every active (in wait) item different than init, which is called for all items

Parameters

Name	Type
item	IItem

Returns

void

Overrides

IElement.resume

Defined in

packages/bpmn-server/src/interfaces/elements.ts:71

---

init

▸ init(item): void

Parameters

Name	Type
item	IItem

Returns

void

Defined in

packages/bpmn-server/src/interfaces/elements.ts:72

---

getOutbounds

▸ getOutbounds(item): IItem[]

Parameters

Name	Type
item	IItem

Returns

IItem[]

Defined in

packages/bpmn-server/src/interfaces/elements.ts:73

Comments