bpmn-server / IToken

Interface: IToken

Implemented by

• Token

Table of contents

Properties

• id
• type
• execution
• dataPath
• startNodeId
• parentToken
• originItem
• path
• loop
• currentNode
• processId
• status
• data
• currentItem
• lastItem
• firstItem
• childrenTokens
• itemsKey

Methods

• save
• resume
• stop
• processError
• processEscalation
• processCancel
• restored
• getChildrenTokens
• preExecute
• preNext
• execute
• appendData
• terminate
• signal
• getFullPath
• end
• goNext
• getSubProcessToken
• log
• info
• error

Properties

id

• id: any

Defined in

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

---

type

• type: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:24

---

execution

• execution: IExecution

Defined in

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

---

dataPath

• dataPath: string

Defined in

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

---

startNodeId

• startNodeId: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:27

---

parentToken

• Optional parentToken: IToken

Defined in

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

---

originItem

• originItem: IItem

Defined in

packages/bpmn-server/src/interfaces/engine.ts:30

---

path

• path: IItem[]

Defined in

packages/bpmn-server/src/interfaces/engine.ts:31

---

loop

• loop: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:32

---

currentNode

• currentNode: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:33

---

processId

• processId: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:34

---

status

• status: TOKEN_STATUS

Defined in

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

---

data

• data: any

Defined in

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

---

currentItem

• currentItem: IItem

Defined in

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

---

lastItem

• lastItem: IItem

Defined in

packages/bpmn-server/src/interfaces/engine.ts:38

---

firstItem

• firstItem: Item

Defined in

packages/bpmn-server/src/interfaces/engine.ts:39

---

childrenTokens

• childrenTokens: Token[]

Defined in

packages/bpmn-server/src/interfaces/engine.ts:40

---

itemsKey

• itemsKey: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:41

Methods

save

▸ save(): Object

Returns

Object

Name	Type
id	any
type	any
status	TOKEN_STATUS
dataPath	string
loopId	any
parentToken	any
originItem	any
startNodeId	any
currentNode	any

Defined in

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

---

resume

▸ resume(): void

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:54

---

stop

▸ stop(): void

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:55

---

processError

▸ processError(errorCode, callingEvent): any

Parameters

Name	Type
errorCode	any
callingEvent	any

Returns

any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:57

---

processEscalation

▸ processEscalation(escalationCode, callingEvent): any

Parameters

Name	Type
escalationCode	any
callingEvent	any

Returns

any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:58

---

processCancel

▸ processCancel(callingEvent): any

Parameters

Name	Type
callingEvent	any

Returns

any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:59

---

restored

▸ restored(): void

Returns

void

Defined in

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

---

getChildrenTokens

▸ getChildrenTokens(): any[]

Returns

any[]

Defined in

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

---

preExecute

▸ preExecute(): Promise\<boolean>

Returns

Promise\<boolean>

Defined in

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

---

preNext

▸ preNext(): Promise\<boolean>

Returns

Promise\<boolean>

Defined in

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

---

execute

▸ execute(inputData): Promise\<any>

this is the primary exectuion method for a token

Parameters

Name	Type
inputData	any

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:69

---

appendData

▸ appendData(inputData, item): void

Parameters

Name	Type
inputData	any
item	IItem

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:70

---

terminate

▸ terminate(): void

is called by Gateways to cancel current token

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:75

---

signal

▸ signal(data): Promise\<any>

Parameters

Name	Type
data	any

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:76

---

getFullPath

▸ getFullPath(fullPath?): Item[]

Parameters

Name	Type
fullPath?	any

Returns

Item[]

Defined in

packages/bpmn-server/src/interfaces/engine.ts:77

---

end

▸ end(): Promise\<void>

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:78

---

goNext

▸ goNext(): Promise\<void>

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:79

---

getSubProcessToken

▸ getSubProcessToken(): IToken

Returns

IToken

Defined in

packages/bpmn-server/src/interfaces/engine.ts:80

---

log

▸ log(...msg): void

Parameters

Name	Type
...msg	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:81

---

info

▸ info(...msg): void

Parameters

Name	Type
...msg	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:82

---

error

▸ error(msg): void

Parameters

Name	Type
msg	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:83

Comments