Skip to content
ralphhanna edited this page Dec 18, 2023 · 3 revisions

bpmn-server / IToken

Interface: IToken

Implemented by

Table of contents

Properties

Methods

Properties

childrenTokens

childrenTokens: Token[]

Defined in

interfaces/engine.ts:27


currentItem

currentItem: IItem

Defined in

interfaces/engine.ts:24


currentNode

currentNode: any

Defined in

interfaces/engine.ts:20


data

data: any

Defined in

interfaces/engine.ts:23


dataPath

dataPath: string

Defined in

interfaces/engine.ts:13


execution

execution: IExecution

Defined in

interfaces/engine.ts:12


firstItem

firstItem: Item

Defined in

interfaces/engine.ts:26


id

id: any

Defined in

interfaces/engine.ts:10


lastItem

lastItem: IItem

Defined in

interfaces/engine.ts:25


loop

loop: any

Defined in

interfaces/engine.ts:19


originItem

originItem: IItem

Defined in

interfaces/engine.ts:17


parentToken

Optional parentToken: IToken

Defined in

interfaces/engine.ts:15


path

path: IItem[]

Defined in

interfaces/engine.ts:18


processId

processId: any

Defined in

interfaces/engine.ts:21


startNodeId

startNodeId: any

Defined in

interfaces/engine.ts:14


status

status: TOKEN_STATUS

Defined in

interfaces/engine.ts:22


type

type: any

Defined in

interfaces/engine.ts:11

Methods

appendData

appendData(inputData, item): void

Parameters

Name Type
inputData any
item IItem

Returns

void

Defined in

interfaces/engine.ts:51


end

end(): Promise<void>

Returns

Promise<void>

Defined in

interfaces/engine.ts:59


error

error(msg): void

Parameters

Name Type
msg any

Returns

void

Defined in

interfaces/engine.ts:63


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


getChildrenTokens

getChildrenTokens(): any[]

Returns

any[]

Defined in

interfaces/engine.ts:44


getFullPath

getFullPath(fullPath?): Item[]

Parameters

Name Type
fullPath? any

Returns

Item[]

Defined in

interfaces/engine.ts:58


getSubProcessToken

getSubProcessToken(): IToken

Returns

IToken

Defined in

interfaces/engine.ts:61


goNext

goNext(): Promise<void>

Returns

Promise<void>

Defined in

interfaces/engine.ts:60


log

log(...msg): void

Parameters

Name Type
...msg any

Returns

void

Defined in

interfaces/engine.ts:62


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


processError

processError(): any

Returns

any

Defined in

interfaces/engine.ts:42


restored

restored(): void

Returns

void

Defined in

interfaces/engine.ts:43


resume

resume(): void

Returns

void

Defined in

interfaces/engine.ts:40


save

save(): Object

Returns

Object

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

Defined in

interfaces/engine.ts:29


signal

signal(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

interfaces/engine.ts:57


stop

stop(): void

Returns

void

Defined in

interfaces/engine.ts:41


terminate

terminate(): void

is called by Gateways to cancel current token

Returns

void

Defined in

interfaces/engine.ts:56

Clone this wiki locally