bpmn-server / IToken

Interface: IToken#

Implemented by#

Token

Table of contents#

Properties#

Methods#

Properties#

id#

• id: any

Defined in#

interfaces/engine.ts:10

type#

• type: any

Defined in#

interfaces/engine.ts:11

execution#

• execution: IExecution

Defined in#

interfaces/engine.ts:12

dataPath#

• dataPath: string

Defined in#

interfaces/engine.ts:13

startNodeId#

• startNodeId: any

Defined in#

interfaces/engine.ts:14

parentToken#

• Optional parentToken: IToken

Defined in#

interfaces/engine.ts:15

originItem#

• originItem: IItem

Defined in#

interfaces/engine.ts:17

path#

• path: IItem[]

Defined in#

interfaces/engine.ts:18

loop#

• loop: any

Defined in#

interfaces/engine.ts:19

currentNode#

• currentNode: any

Defined in#

interfaces/engine.ts:20

processId#

• processId: any

Defined in#

interfaces/engine.ts:21

status#

• status: TOKEN_STATUS

Defined in#

interfaces/engine.ts:22

data#

• data: any

Defined in#

interfaces/engine.ts:23

currentItem#

• currentItem: IItem

Defined in#

interfaces/engine.ts:24

lastItem#

• lastItem: IItem

Defined in#

interfaces/engine.ts:25

firstItem#

• firstItem: Item

Defined in#

interfaces/engine.ts:26

childrenTokens#

• childrenTokens: Token[]

Defined in#

interfaces/engine.ts:27

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#

interfaces/engine.ts:29

resume#

▸ resume(): void

Returns#

void

Defined in#

interfaces/engine.ts:40

stop#

▸ stop(): void

Returns#

void

Defined in#

interfaces/engine.ts:41

processError#

▸ processError(): any

Returns#

any

Defined in#

interfaces/engine.ts:42

restored#

▸ restored(): void

Returns#

void

Defined in#

interfaces/engine.ts:43

getChildrenTokens#

▸ getChildrenTokens(): any[]

Returns#

any[]

Defined in#

interfaces/engine.ts:44

preExecute#

▸ preExecute(): Promise\<boolean>

Returns#

Promise\<boolean>

Defined in#

interfaces/engine.ts:45

preNext#

▸ preNext(): Promise\<boolean>

Returns#

Promise\<boolean>

Defined in#

interfaces/engine.ts:46

execute#

▸ execute(inputData): Promise\<any>

this is the primary exectuion method for a token

Parameters#

Name	Type
`inputData`	`any`

Returns#

Promise\<any>

Defined in#

interfaces/engine.ts:50

appendData#

▸ appendData(inputData, item): void

Parameters#

Name	Type
`inputData`	`any`
`item`	`IItem`

Returns#

void

Defined in#

interfaces/engine.ts:51

terminate#

▸ terminate(): void

is called by Gateways to cancel current token

Returns#

void

Defined in#

interfaces/engine.ts:56

signal#

▸ signal(data): Promise\<any>

Parameters#

Name	Type
`data`	`any`

Returns#

Promise\<any>

Defined in#

interfaces/engine.ts:57

getFullPath#

▸ getFullPath(fullPath?): Item[]

Parameters#

Name	Type
`fullPath?`	`any`

Returns#

Item[]

Defined in#

interfaces/engine.ts:58

end#

▸ end(): Promise\<void>

Returns#

Promise\<void>

Defined in#

interfaces/engine.ts:59

goNext#

▸ goNext(): Promise\<void>

Returns#

Promise\<void>

Defined in#

interfaces/engine.ts:60

getSubProcessToken#

▸ getSubProcessToken(): IToken

Returns#

IToken

Defined in#

interfaces/engine.ts:61

log#

▸ log(...msg): void

Parameters#

Name	Type
`...msg`	`any`

Returns#

void

Defined in#

interfaces/engine.ts:62

info#

▸ info(...msg): void

Parameters#

Name	Type
`...msg`	`any`

Returns#

void

Defined in#

interfaces/engine.ts:63

error#

▸ error(msg): void

Parameters#

Name	Type
`msg`	`any`

Returns#

void

Defined in#

interfaces/engine.ts:64