itoken

bpmn-server › IToken

Interface: IToken

Hierarchy

• IToken

Implemented by

• Token

Index

Properties

• branchNode
• currentItem
• currentNode
• data
• dataPath
• execution
• id
• lastItem
• parentToken
• path
• processId
• startNodeId
• status

Methods

• applyInput
• end
• execute
• getChildrenTokens
• goNext
• log
• preExecute
• preNext
• restored
• resume
• save
• signal
• terminate

Properties

Optional branchNode

• branchNode? : any

Defined in src/interfaces/engine.ts:13

---

currentItem

• currentItem: IItem

Defined in src/interfaces/engine.ts:19

---

currentNode

• currentNode: any

Defined in src/interfaces/engine.ts:15

---

data

• data: any

Defined in src/interfaces/engine.ts:18

---

dataPath

• dataPath: string

Defined in src/interfaces/engine.ts:10

---

execution

• execution: IExecution

Defined in src/interfaces/engine.ts:9

---

id

• id: any

Defined in src/interfaces/engine.ts:8

---

lastItem

• lastItem: IItem

Defined in src/interfaces/engine.ts:20

---

Optional parentToken

• parentToken? : IToken

Defined in src/interfaces/engine.ts:12

---

path

• path: IItem[]

Defined in src/interfaces/engine.ts:14

---

processId

• processId: any

Defined in src/interfaces/engine.ts:16

---

startNodeId

• startNodeId: any

Defined in src/interfaces/engine.ts:11

---

status

• status: TOKEN_STATUS

Defined in src/interfaces/engine.ts:17

Methods

applyInput

▸ applyInput(inputData: any): void

Defined in src/interfaces/engine.ts:40

Parameters:

Name	Type
inputData	any

Returns: void

---

end

▸ end(): Promise‹void›

Defined in src/interfaces/engine.ts:47

Returns: Promise‹void›

---

execute

▸ execute(inputData: any): Promise‹any›

Defined in src/interfaces/engine.ts:39

this is the primary exectuion method for a token

Parameters:

Name	Type
inputData	any

Returns: Promise‹any›

---

getChildrenTokens

▸ getChildrenTokens(): any[]

Defined in src/interfaces/engine.ts:33

Returns: any[]

---

goNext

▸ goNext(): Promise‹void›

Defined in src/interfaces/engine.ts:48

Returns: Promise‹void›

---

log

▸ log(msg: any): void

Defined in src/interfaces/engine.ts:49

Parameters:

Name	Type
msg	any

Returns: void

---

preExecute

▸ preExecute(): Promise‹boolean›

Defined in src/interfaces/engine.ts:34

Returns: Promise‹boolean›

---

preNext

▸ preNext(): Promise‹boolean›

Defined in src/interfaces/engine.ts:35

Returns: Promise‹boolean›

---

restored

▸ restored(): void

Defined in src/interfaces/engine.ts:32

Returns: void

---

resume

▸ resume(): void

Defined in src/interfaces/engine.ts:31

Returns: void

---

save

▸ save(): object

Defined in src/interfaces/engine.ts:21

Returns: object

• branchNode: any

• currentNode: any

• dataPath: string

• id: any

• loopId: any

• parentToken: any

• startNodeId: any

• status: TOKEN_STATUS

---

signal

▸ signal(data: any): Promise‹any›

Defined in src/interfaces/engine.ts:46

Parameters:

Name	Type
data	any

Returns: Promise‹any›

---

terminate

▸ terminate(): void

Defined in src/interfaces/engine.ts:45

is called by Gateways to cancel current token

Returns: void