bpmn-server / IExecution
Interface: IExecution#
Hierarchy#
↳ IExecution
Implemented by#
Table of contents#
Properties#
- instance
- server
- tokens
- definition
- appDelegate
- logger
- process
- promises
- listener
- isLocked
- errors
- item
- messageMatchingKey
- worker
- userName
- id
- status
- options
- name
- uids
- configuration
- cron
- cache
- engine
- dataStore
- definitions
Methods#
- getNodeById
- getToken
- tokenEnded
- getItemsData
- save
- end
- stop
- terminate
- execute
- signalItem
- signalEvent
- signalRepeatTimerEvent
- getItems
- getState
- restored
- resume
- report
- getNewId
- getUUID
- doExecutionEvent
- doItemEvent
- log
- logS
- logE
- info
- error
- appendData
- getData
Properties#
instance#
• instance: IInstanceData
Defined in#
server#
• server: IBPMNServer
Overrides#
Defined in#
tokens#
• tokens: Map\<any, IToken>
Defined in#
definition#
• definition: IDefinition
Defined in#
appDelegate#
• appDelegate: IAppDelegate
Overrides#
Defined in#
logger#
• logger: ILogger
Overrides#
Defined in#
process#
• process: any
Defined in#
promises#
• promises: any
Defined in#
listener#
• listener: any
Defined in#
isLocked#
• isLocked: boolean
Defined in#
errors#
• errors: any
Defined in#
item#
• item: any
Defined in#
messageMatchingKey#
• messageMatchingKey: any
Defined in#
worker#
• worker: any
Defined in#
userName#
• userName: any
Defined in#
id#
• id: any
Defined in#
status#
• status: any
Defined in#
options#
• options: any
Defined in#
name#
• name: any
Defined in#
uids#
• uids: Object
Defined in#
configuration#
• configuration: IConfiguration
Inherited from#
IServerComponent.configuration
Defined in#
cron#
• cron: any
Inherited from#
Defined in#
cache#
• cache: any
Inherited from#
Defined in#
engine#
• engine: any
Inherited from#
Defined in#
dataStore#
• dataStore: IDataStore
Inherited from#
Defined in#
definitions#
• definitions: any
Inherited from#
Defined in#
Methods#
getNodeById#
▸ getNodeById(id): Node
Parameters#
| Name | Type |
|---|---|
id |
any |
Returns#
Defined in#
getToken#
▸ getToken(id): IToken
Parameters#
| Name | Type |
|---|---|
id |
number |
Returns#
Defined in#
tokenEnded#
▸ tokenEnded(token): void
Parameters#
| Name | Type |
|---|---|
token |
IToken |
Returns#
void
Defined in#
getItemsData#
▸ getItemsData(): IItemData[]
Returns#
Defined in#
save#
▸ save(): Promise\<void>
Returns#
Promise\<void>
Defined in#
end#
▸ end(): Promise\<void>
Returns#
Promise\<void>
Defined in#
stop#
▸ stop(): void
causes the execution to stop from running any further
Returns#
void
Defined in#
terminate#
▸ terminate(): void
Returns#
void
Defined in#
execute#
▸ execute(startNodeId?, inputData?): Promise\<void>
Parameters#
| Name | Type |
|---|---|
startNodeId? |
any |
inputData? |
Object |
Returns#
Promise\<void>
Defined in#
signalItem#
▸ signalItem(executionId, inputData, options?): Promise\<IExecution>
invoke scenarios: itemId elementId - but only one is active elementId - for a startEvent in a secondary process
Parameters#
| Name | Type |
|---|---|
executionId |
any |
inputData |
any |
options? |
Object |
Returns#
Promise\<IExecution>
Defined in#
signalEvent#
▸ signalEvent(executionId, inputData, options?): Promise\<IExecution>
Parameters#
| Name | Type |
|---|---|
executionId |
any |
inputData |
any |
options? |
Object |
Returns#
Promise\<IExecution>
Defined in#
signalRepeatTimerEvent#
▸ signalRepeatTimerEvent(executionId, prevItem, inputData, options?): Promise\<IExecution>
Parameters#
| Name | Type |
|---|---|
executionId |
any |
prevItem |
any |
inputData |
any |
options? |
Object |
Returns#
Promise\<IExecution>
Defined in#
getItems#
▸ getItems(query?): IItem[]
Parameters#
| Name | Type |
|---|---|
query? |
any |
Returns#
IItem[]
Defined in#
getState#
▸ getState(): IInstanceData
Returns#
Defined in#
restored#
▸ restored(): void
Returns#
void
Defined in#
resume#
▸ resume(): void
Returns#
void
Defined in#
report#
▸ report(): void
Returns#
void
Defined in#
getNewId#
▸ getNewId(scope): number
Parameters#
| Name | Type |
|---|---|
scope |
string |
Returns#
number
Defined in#
getUUID#
▸ getUUID(): any
Returns#
any
Defined in#
doExecutionEvent#
▸ doExecutionEvent(process, event, eventDetails?): Promise\<any>
Parameters#
| Name | Type |
|---|---|
process |
any |
event |
any |
eventDetails? |
any |
Returns#
Promise\<any>
Defined in#
doItemEvent#
▸ doItemEvent(item, event, eventDetails?): Promise\<any>
Parameters#
| Name | Type |
|---|---|
item |
any |
event |
any |
eventDetails? |
any |
Returns#
Promise\<any>
Defined in#
log#
▸ log(...msg): void
Parameters#
| Name | Type |
|---|---|
...msg |
any |
Returns#
void
Defined in#
logS#
▸ logS(...msg): void
Parameters#
| Name | Type |
|---|---|
...msg |
any |
Returns#
void
Defined in#
logE#
▸ logE(...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
Defined in#
appendData#
▸ appendData(inputData, item, dataPath?, assignment?): void
Parameters#
| Name | Type |
|---|---|
inputData |
any |
item |
IItem |
dataPath? |
any |
assignment? |
any |
Returns#
void
Defined in#
getData#
▸ getData(dataPath): any
Parameters#
| Name | Type |
|---|---|
dataPath |
any |
Returns#
any