bpmn-server / IToken
Interface: IToken#
Implemented by#
Table of contents#
Properties#
- id
- type
- execution
- dataPath
- startNodeId
- parentToken
- originItem
- path
- loop
- currentNode
- processId
- status
- data
- currentItem
- lastItem
- firstItem
- childrenTokens
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#
type#
• type: any
Defined in#
execution#
• execution: IExecution
Defined in#
dataPath#
• dataPath: string
Defined in#
startNodeId#
• startNodeId: any
Defined in#
parentToken#
• Optional parentToken: IToken
Defined in#
originItem#
• originItem: IItem
Defined in#
path#
• path: IItem[]
Defined in#
loop#
• loop: any
Defined in#
currentNode#
• currentNode: any
Defined in#
processId#
• processId: any
Defined in#
status#
• status: TOKEN_STATUS
Defined in#
data#
• data: any
Defined in#
currentItem#
• currentItem: IItem
Defined in#
lastItem#
• lastItem: IItem
Defined in#
firstItem#
• firstItem: Item
Defined in#
childrenTokens#
• childrenTokens: Token[]
Defined in#
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#
resume#
▸ resume(): void
Returns#
void
Defined in#
stop#
▸ stop(): void
Returns#
void
Defined in#
processError#
▸ processError(errorCode, callingEvent): any
Parameters#
| Name | Type |
|---|---|
errorCode |
any |
callingEvent |
any |
Returns#
any
Defined in#
processEscalation#
▸ processEscalation(escalationCode, callingEvent): any
Parameters#
| Name | Type |
|---|---|
escalationCode |
any |
callingEvent |
any |
Returns#
any
Defined in#
processCancel#
▸ processCancel(callingEvent): any
Parameters#
| Name | Type |
|---|---|
callingEvent |
any |
Returns#
any
Defined in#
restored#
▸ restored(): void
Returns#
void
Defined in#
getChildrenTokens#
▸ getChildrenTokens(): any[]
Returns#
any[]
Defined in#
preExecute#
▸ preExecute(): Promise\<boolean>
Returns#
Promise\<boolean>
Defined in#
preNext#
▸ preNext(): Promise\<boolean>
Returns#
Promise\<boolean>
Defined in#
execute#
▸ execute(inputData): Promise\<any>
this is the primary exectuion method for a token
Parameters#
| Name | Type |
|---|---|
inputData |
any |
Returns#
Promise\<any>
Defined in#
appendData#
▸ appendData(inputData, item): void
Parameters#
| Name | Type |
|---|---|
inputData |
any |
item |
IItem |
Returns#
void
Defined in#
terminate#
▸ terminate(): void
is called by Gateways to cancel current token
Returns#
void
Defined in#
signal#
▸ signal(data): Promise\<any>
Parameters#
| Name | Type |
|---|---|
data |
any |
Returns#
Promise\<any>
Defined in#
getFullPath#
▸ getFullPath(fullPath?): Item[]
Parameters#
| Name | Type |
|---|---|
fullPath? |
any |
Returns#
Item[]
Defined in#
end#
▸ end(): Promise\<void>
Returns#
Promise\<void>
Defined in#
goNext#
▸ goNext(): Promise\<void>
Returns#
Promise\<void>
Defined in#
getSubProcessToken#
▸ getSubProcessToken(): IToken
Returns#
Defined in#
log#
▸ log(...msg): void
Parameters#
| Name | Type |
|---|---|
...msg |
any |
Returns#
void
Defined in#
info#
▸ info(...msg): void
Parameters#
| Name | Type |
|---|---|
...msg |
any |
Returns#
void
Defined in#
error#
▸ error(msg): void
Parameters#
| Name | Type |
|---|---|
msg |
any |
Returns#
void