Skip to content

iexecution

ralphhanna edited this page Dec 18, 2023 · 3 revisions

bpmn-server / IExecution

Interface: IExecution

Hierarchy

Implemented by

Table of contents

Properties

Methods

Properties

appDelegate

appDelegate: IAppDelegate

Overrides

IServerComponent.appDelegate

Defined in

interfaces/engine.ts:71


cache

cache: any

Inherited from

IServerComponent.cache

Defined in

interfaces/server.ts:25


configuration

configuration: IConfiguration

Inherited from

IServerComponent.configuration

Defined in

interfaces/server.ts:22


cron

cron: any

Inherited from

IServerComponent.cron

Defined in

interfaces/server.ts:24


dataStore

dataStore: IDataStore

Inherited from

IServerComponent.dataStore

Defined in

interfaces/server.ts:28


definition

definition: IDefinition

Defined in

interfaces/engine.ts:70


definitions

definitions: any

Inherited from

IServerComponent.definitions

Defined in

interfaces/server.ts:29


engine

engine: any

Inherited from

IServerComponent.engine

Defined in

interfaces/server.ts:27


errors

errors: any

Defined in

interfaces/engine.ts:78


id

id: any

Defined in

interfaces/engine.ts:84


instance

instance: IInstanceData

Defined in

interfaces/engine.ts:67


isLocked

isLocked: boolean

Defined in

interfaces/engine.ts:76


item

item: any

Defined in

interfaces/engine.ts:79


listener

listener: any

Defined in

interfaces/engine.ts:75


logger

logger: ILogger

Overrides

IServerComponent.logger

Defined in

interfaces/engine.ts:72


messageMatchingKey

messageMatchingKey: any

Defined in

interfaces/engine.ts:80


name

name: any

Defined in

interfaces/engine.ts:87


options

options: any

Defined in

interfaces/engine.ts:86


process

process: any

Defined in

interfaces/engine.ts:73


promises

promises: any

Defined in

interfaces/engine.ts:74


server

server: IBPMNServer

Overrides

IServerComponent.server

Defined in

interfaces/engine.ts:68


status

status: any

Defined in

interfaces/engine.ts:85


tokens

tokens: Map<any, IToken>

Defined in

interfaces/engine.ts:69


uids

uids: Object

Defined in

interfaces/engine.ts:121


userName

userName: any

Defined in

interfaces/engine.ts:82


worker

worker: any

Defined in

interfaces/engine.ts:81

Methods

appendData

appendData(inputData, item, dataPath?, assignment?): void

Parameters

Name Type
inputData any
item IItem
dataPath? any
assignment? any

Returns

void

Defined in

interfaces/engine.ts:128


doExecutionEvent

doExecutionEvent(process, event): Promise<any>

Parameters

Name Type
process any
event any

Returns

Promise<any>

Defined in

interfaces/engine.ts:124


doItemEvent

doItemEvent(item, event): Promise<any>

Parameters

Name Type
item any
event any

Returns

Promise<any>

Defined in

interfaces/engine.ts:125


end

end(): Promise<void>

Returns

Promise<void>

Defined in

interfaces/engine.ts:94


error

error(msg): void

Parameters

Name Type
msg any

Returns

void

Defined in

interfaces/engine.ts:127


execute

execute(startNodeId?, inputData?): Promise<void>

Parameters

Name Type
startNodeId? any
inputData? Object

Returns

Promise<void>

Defined in

interfaces/engine.ts:101


getAndCreateData

getAndCreateData(dataPath, asArray?): any

Parameters

Name Type
dataPath any
asArray? boolean

Returns

any

Defined in

interfaces/engine.ts:130


getData

getData(dataPath): any

Parameters

Name Type
dataPath any

Returns

any

Defined in

interfaces/engine.ts:129


getItems

getItems(query?): IItem[]

Parameters

Name Type
query? any

Returns

IItem[]

Defined in

interfaces/engine.ts:116


getItemsData

getItemsData(): IItemData[]

Returns

IItemData[]

Defined in

interfaces/engine.ts:92


getNewId

getNewId(scope): number

Parameters

Name Type
scope string

Returns

number

Defined in

interfaces/engine.ts:122


getNodeById

getNodeById(id): Node

Parameters

Name Type
id any

Returns

Node

Defined in

interfaces/engine.ts:89


getState

getState(): IInstanceData

Returns

IInstanceData

Defined in

interfaces/engine.ts:117


getToken

getToken(id): IToken

Parameters

Name Type
id number

Returns

IToken

Defined in

interfaces/engine.ts:90


getUUID

getUUID(): any

Returns

any

Defined in

interfaces/engine.ts:123


log

log(...msg): void

Parameters

Name Type
...msg any

Returns

void

Defined in

interfaces/engine.ts:126


report

report(): void

Returns

void

Defined in

interfaces/engine.ts:120


restored

restored(): void

Returns

void

Defined in

interfaces/engine.ts:118


resume

resume(): void

Returns

void

Defined in

interfaces/engine.ts:119


save

save(): Promise<void>

Returns

Promise<void>

Defined in

interfaces/engine.ts:93


signalEvent

signalEvent(executionId, inputData, options?): Promise<IExecution>

Parameters

Name Type
executionId any
inputData any
options? Object

Returns

Promise<IExecution>

Defined in

interfaces/engine.ts:113


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

interfaces/engine.ts:112


signalRepeatTimerEvent

signalRepeatTimerEvent(executionId, prevItem, inputData, options?): Promise<IExecution>

Parameters

Name Type
executionId any
prevItem any
inputData any
options? Object

Returns

Promise<IExecution>

Defined in

interfaces/engine.ts:114


stop

stop(): void

causes the execution to stop from running any further

Returns

void

Defined in

interfaces/engine.ts:99


terminate

terminate(): void

Returns

void

Defined in

interfaces/engine.ts:100


tokenEnded

tokenEnded(token): void

Parameters

Name Type
token IToken

Returns

void

Defined in

interfaces/engine.ts:91

Clone this wiki locally