bpmn-server / Token

Class: Token

Implements

• IToken

Table of contents

Constructors

• constructor

Properties

• id
• type
• execution
• dataPath
• startNodeId
• parentToken
• originItem
• path
• loop
• _currentNode
• processId
• status
• input
• output
• messageMatchingKey
• itemsKey

Accessors

• currentNode
• data
• currentItem
• firstItem
• lastItem
• childrenTokens

Methods

• hasNode
• getFullPath
• startNewToken
• save
• load
• stop
• resume
• restored
• getSubProcessToken
• getChildrenTokens
• preExecute
• preNext
• execute
• retry
• addItemToPath
• processError
• getScopeCatchEvent
• checkTokensForError
• processCancel
• processEscalation
• appendData
• terminate
• continue
• signal
• signal2
• end
• setCurrentNode
• goNext
• log
• logS
• logE
• info
• decision
• error

Constructors

constructor

• new Token(type, execution, startNode, dataPath?, parentToken?, originItem?): Token

Parameters

Name	Type
type	TOKEN_TYPE
execution	Execution
startNode	Node
dataPath?	any
parentToken?	Token
originItem?	Item

Returns

Token

Defined in

packages/bpmn-server/src/engine/Token.ts:114

Properties

id

• id: any

Implementation of

IToken.id

Defined in

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

---

type

• type: TOKEN_TYPE

Implementation of

IToken.type

Defined in

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

---

execution

• execution: IExecution

Implementation of

IToken.execution

Defined in

packages/bpmn-server/src/engine/Token.ts:56

---

dataPath

• dataPath: string

Implementation of

IToken.dataPath

Defined in

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

---

startNodeId

• startNodeId: any

Implementation of

IToken.startNodeId

Defined in

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

---

parentToken

• Optional parentToken: Token

Implementation of

IToken.parentToken

Defined in

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

---

originItem

• originItem: Item

Implementation of

IToken.originItem

Defined in

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

---

path

• path: Item[]

Implementation of

IToken.path

Defined in

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

---

loop

• loop: Loop

Implementation of

IToken.loop

Defined in

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

---

_currentNode

• _currentNode: Node

Defined in

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

---

processId

• processId: any

Implementation of

IToken.processId

Defined in

packages/bpmn-server/src/engine/Token.ts:67

---

status

• status: TOKEN_STATUS

Implementation of

IToken.status

Defined in

packages/bpmn-server/src/engine/Token.ts:68

---

input

• input: Object

Defined in

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

---

output

• output: Object

Defined in

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

---

messageMatchingKey

• messageMatchingKey: Object

Defined in

packages/bpmn-server/src/engine/Token.ts:71

---

itemsKey

• itemsKey: any = null

Implementation of

IToken.itemsKey

Defined in

packages/bpmn-server/src/engine/Token.ts:72

Accessors

currentNode

• get currentNode(): Node

Returns

Node

Implementation of

IToken.currentNode

Defined in

packages/bpmn-server/src/engine/Token.ts:66

---

data

• get data(): any

Returns

any

Implementation of

IToken.data

Defined in

packages/bpmn-server/src/engine/Token.ts:74

---

currentItem

• get currentItem(): Item

Returns

Item

Implementation of

IToken.currentItem

Defined in

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

---

firstItem

• get firstItem(): Item

Returns

Item

Implementation of

IToken.firstItem

Defined in

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

---

lastItem

• get lastItem(): Item

Returns

Item

Implementation of

IToken.lastItem

Defined in

packages/bpmn-server/src/engine/Token.ts:92

---

childrenTokens

• get childrenTokens(): Token[]

Returns

Token[]

Implementation of

IToken.childrenTokens

Defined in

packages/bpmn-server/src/engine/Token.ts:102

Methods

hasNode

▸ hasNode(nodeId): Boolean

Parameters

Name	Type
nodeId	any

Returns

Boolean

Defined in

packages/bpmn-server/src/engine/Token.ts:84

---

getFullPath

▸ getFullPath(path?): Item[]

Parameters

Name	Type	Default value
path	any[]	[]

Returns

Item[]

Implementation of

IToken.getFullPath

Defined in

packages/bpmn-server/src/engine/Token.ts:108

---

startNewToken

▸ startNewToken(type, execution, startNode, dataPath, parentToken, originItem, loop, data?, noExecute?, itemsKey?): Promise\<Token>

Parameters

Name	Type	Default value
type	TOKEN_TYPE	undefined
execution	any	undefined
startNode	any	undefined
dataPath	any	undefined
parentToken	Token	undefined
originItem	Item	undefined
loop	Loop	undefined
data	any	null
noExecute	boolean	false
itemsKey	any	null

Returns

Promise\<Token>

Defined in

packages/bpmn-server/src/engine/Token.ts:146

---

save

▸ save(): Object

Returns

Object

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

Implementation of

IToken.save

Defined in

packages/bpmn-server/src/engine/Token.ts:177

---

load

▸ load(execution, da): Token

Parameters

Name	Type
execution	Execution
da	any

Returns

Token

Defined in

packages/bpmn-server/src/engine/Token.ts:192

---

stop

▸ stop(): void

Returns

void

Implementation of

IToken.stop

Defined in

packages/bpmn-server/src/engine/Token.ts:206

---

resume

▸ resume(): void

Returns

void

Implementation of

IToken.resume

Defined in

packages/bpmn-server/src/engine/Token.ts:215

---

restored

▸ restored(): void

Returns

void

Implementation of

IToken.restored

Defined in

packages/bpmn-server/src/engine/Token.ts:219

---

getSubProcessToken

▸ getSubProcessToken(): Token

Returns

Token

Implementation of

IToken.getSubProcessToken

Defined in

packages/bpmn-server/src/engine/Token.ts:224

---

getChildrenTokens

▸ getChildrenTokens(): any[]

Returns

any[]

Implementation of

IToken.getChildrenTokens

Defined in

packages/bpmn-server/src/engine/Token.ts:233

---

preExecute

▸ preExecute(): Promise\<boolean>

Returns

Promise\<boolean>

Implementation of

IToken.preExecute

Defined in

packages/bpmn-server/src/engine/Token.ts:245

---

preNext

▸ preNext(): Promise\<boolean>

Returns

Promise\<boolean>

Implementation of

IToken.preNext

Defined in

packages/bpmn-server/src/engine/Token.ts:252

---

execute

▸ execute(input): Promise\<void>

this is the primary exectuion method for a token, it executes from current node till: a node hits a wait

Pre-Conditions: currentNode is set status!= end

Parameters

Name	Type
input	any

Returns

Promise\<void>

Implementation of

IToken.execute

Defined in

packages/bpmn-server/src/engine/Token.ts:265

---

retry

▸ retry(item): Promise\<void>

A failed item's work again (its status error): then on, as execute goes on after its node.

Parameters

Name	Type
item	Item

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/engine/Token.ts:336

---

addItemToPath

▸ addItemToPath(item): void

Parameters

Name	Type
item	any

Returns

void

Defined in

packages/bpmn-server/src/engine/Token.ts:359

---

processError

▸ processError(errorCode, callingEvent): Promise\<void>

Parameters

Name	Type
errorCode	any
callingEvent	any

Returns

Promise\<void>

Implementation of

IToken.processError

Defined in

packages/bpmn-server/src/engine/Token.ts:364

---

getScopeCatchEvent

▸ getScopeCatchEvent(type, code): any

Parameters

Name	Type
type	"error" | "escalation" | "cancel"
code	any

Returns

any

Defined in

packages/bpmn-server/src/engine/Token.ts:382

---

checkTokensForError

▸ checkTokensForError(tokens, bhName, propertyName, errorCode): any

Parameters

Name	Type
tokens	any
bhName	any
propertyName	any
errorCode	any

Returns

any

Defined in

packages/bpmn-server/src/engine/Token.ts:449

---

processCancel

▸ processCancel(callingEvent): Promise\<void>

Parameters

Name	Type
callingEvent	any

Returns

Promise\<void>

Implementation of

IToken.processCancel

Defined in

packages/bpmn-server/src/engine/Token.ts:476

---

processEscalation

▸ processEscalation(escalationCode, callingEvent): Promise\<void>

Parameters

Name	Type
escalationCode	any
callingEvent	any

Returns

Promise\<void>

Implementation of

IToken.processEscalation

Defined in

packages/bpmn-server/src/engine/Token.ts:484

---

appendData

▸ appendData(inputData, item): void

renamed from applyInput to appendData

Parameters

Name	Type
inputData	any
item	any

Returns

void

Implementation of

IToken.appendData

Defined in

packages/bpmn-server/src/engine/Token.ts:519

---

terminate

▸ terminate(): Promise\<void>

is called by Gateways to cancel current token

Returns

Promise\<void>

Implementation of

IToken.terminate

Defined in

packages/bpmn-server/src/engine/Token.ts:526

---

continue

▸ continue(): Promise\<void>

is called by events to cancel current token

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/engine/Token.ts:551

---

signal

▸ signal(data, options?): Promise\<void>

Parameters

Name	Type
data	any
options	Object

Returns

Promise\<void>

Implementation of

IToken.signal

Defined in

packages/bpmn-server/src/engine/Token.ts:560

---

signal2

▸ signal2(): Promise\<Token>

Returns

Promise\<Token>

Defined in

packages/bpmn-server/src/engine/Token.ts:608

---

end

▸ end(cancel?): Promise\<void>

Parameters

Name	Type	Default value
cancel	Boolean	false

Returns

Promise\<void>

Implementation of

IToken.end

Defined in

packages/bpmn-server/src/engine/Token.ts:636

---

setCurrentNode

▸ setCurrentNode(newCurrentNode): void

Parameters

Name	Type
newCurrentNode	Node

Returns

void

Defined in

packages/bpmn-server/src/engine/Token.ts:683

---

goNext

▸ goNext(): Promise\<void>

Returns

Promise\<void>

Implementation of

IToken.goNext

Defined in

packages/bpmn-server/src/engine/Token.ts:693

---

log

▸ log(...msg): void

Parameters

Name	Type
...msg	any[]

Returns

void

Implementation of

IToken.log

Defined in

packages/bpmn-server/src/engine/Token.ts:792

---

logS

▸ logS(...msg): void

Parameters

Name	Type
...msg	any[]

Returns

void

Defined in

packages/bpmn-server/src/engine/Token.ts:795

---

logE

▸ logE(...msg): void

Parameters

Name	Type
...msg	any[]

Returns

void

Defined in

packages/bpmn-server/src/engine/Token.ts:798

---

info

▸ info(msg): void

Parameters

Name	Type
msg	any

Returns

void

Implementation of

IToken.info

Defined in

packages/bpmn-server/src/engine/Token.ts:801

---

decision

▸ decision(msg): void

Parameters

Name	Type
msg	any

Returns

void

Defined in

packages/bpmn-server/src/engine/Token.ts:804

---

error

▸ error(msg): void

Parameters

Name	Type
msg	any

Returns

void

Implementation of

IToken.error

Defined in

packages/bpmn-server/src/engine/Token.ts:807

Comments