From 637b6d1ba34ac7b3344cbf5ec315d3cd48a0cad8 Mon Sep 17 00:00:00 2001 From: ralphhanna Date: Sun, 24 Dec 2023 00:39:07 -0500 Subject: [PATCH] added docs/api --- .gitignore | 2 +- README.md | 34 +- docs/api/.nojekyll | 1 + docs/api/API.md | 214 ++++ docs/api/classes/APIData.md | 193 +++ docs/api/classes/APIEngine.md | 283 +++++ docs/api/classes/APIModel.md | 283 +++++ docs/api/classes/BPMNAPI.md | 76 ++ docs/api/classes/BPMNServer.md | 276 +++++ docs/api/classes/Behaviour.md | 355 ++++++ docs/api/classes/BehaviourLoader.md | 114 ++ docs/api/classes/BoundaryEvent.md | 1069 +++++++++++++++++ docs/api/classes/BpmnModelData.md | 154 +++ docs/api/classes/BusinessRuleTask.md | 1028 ++++++++++++++++ docs/api/classes/CacheManager.md | 360 ++++++ docs/api/classes/CallActivity.md | 1052 +++++++++++++++++ docs/api/classes/CamundaFormData.md | 375 ++++++ docs/api/classes/CatchEvent.md | 1058 +++++++++++++++++ docs/api/classes/Configuration.md | 292 +++++ docs/api/classes/Cron.md | 494 ++++++++ docs/api/classes/DataStore.md | 669 +++++++++++ docs/api/classes/DefaultAppDelegate.md | 353 ++++++ docs/api/classes/Definition.md | 356 ++++++ docs/api/classes/Element.md | 307 +++++ docs/api/classes/EndEvent.md | 1057 +++++++++++++++++ docs/api/classes/Engine.md | 602 ++++++++++ docs/api/classes/Event.md | 1056 +++++++++++++++++ docs/api/classes/EventBasedGateway.md | 1154 ++++++++++++++++++ docs/api/classes/EventData.md | 266 +++++ docs/api/classes/Execution.md | 1295 +++++++++++++++++++++ docs/api/classes/Flow.md | 494 ++++++++ docs/api/classes/Gateway.md | 1094 +++++++++++++++++ docs/api/classes/IOBehaviour.md | 381 ++++++ docs/api/classes/InstanceLocker.md | 167 +++ docs/api/classes/InstanceObject.md | 271 +++++ docs/api/classes/Item.md | 617 ++++++++++ docs/api/classes/ItemObject.md | 419 +++++++ docs/api/classes/Logger.md | 401 +++++++ docs/api/classes/Loop.md | 288 +++++ docs/api/classes/LoopBehaviour.md | 395 +++++++ docs/api/classes/LoopObject.md | 66 ++ docs/api/classes/MessageEventBehaviour.md | 364 ++++++ docs/api/classes/MessageFlow.md | 474 ++++++++ docs/api/classes/ModelsDatastore.md | 813 +++++++++++++ docs/api/classes/ModelsDatastoreDB.md | 662 +++++++++++ docs/api/classes/MongoDB.md | 266 +++++ docs/api/classes/NoCacheManager.md | 364 ++++++ docs/api/classes/Node.md | 887 ++++++++++++++ docs/api/classes/NodeLoader.md | 44 + docs/api/classes/Process.md | 298 +++++ docs/api/classes/ProcessData.md | 71 ++ docs/api/classes/Query.md | 440 +++++++ docs/api/classes/ReceiveTask.md | 999 ++++++++++++++++ docs/api/classes/ScriptBehaviour.md | 360 ++++++ docs/api/classes/ScriptHandler.md | 128 ++ docs/api/classes/ScriptTask.md | 999 ++++++++++++++++ docs/api/classes/SecureUser.md | 478 ++++++++ docs/api/classes/SendTask.md | 1028 ++++++++++++++++ docs/api/classes/ServerComponent.md | 201 ++++ docs/api/classes/ServiceTask.md | 1028 ++++++++++++++++ docs/api/classes/SignalEventBehaviour.md | 367 ++++++ docs/api/classes/StartEvent.md | 1058 +++++++++++++++++ docs/api/classes/SubProcess.md | 1012 ++++++++++++++++ docs/api/classes/TerminateBehaviour.md | 349 ++++++ docs/api/classes/ThrowEvent.md | 1060 +++++++++++++++++ docs/api/classes/TimerBehaviour.md | 469 ++++++++ docs/api/classes/Token.md | 912 +++++++++++++++ docs/api/classes/TokenObject.md | 110 ++ docs/api/classes/Transaction.md | 1125 ++++++++++++++++++ docs/api/classes/UserTask.md | 1021 ++++++++++++++++ docs/api/classes/XORGateway.md | 1110 ++++++++++++++++++ docs/api/enums/BPMN_TYPE.md | 217 ++++ docs/api/enums/EXECUTION_EVENT.md | 305 +++++ docs/api/enums/EXECUTION_STATUS.md | 52 + docs/api/enums/FLOW_ACTION.md | 30 + docs/api/enums/ITEM_STATUS.md | 85 ++ docs/api/enums/NODE_ACTION.md | 85 ++ docs/api/enums/NODE_SUBTYPE.md | 85 ++ docs/api/enums/TOKEN_STATUS.md | 52 + docs/api/enums/TOKEN_TYPE.md | 74 ++ docs/api/enums/USER_ROLE.md | 41 + docs/api/interfaces/IAPIData.md | 133 +++ docs/api/interfaces/IAPIEngine.md | 185 +++ docs/api/interfaces/IAPIModel.md | 233 ++++ docs/api/interfaces/IAppDelegate.md | 238 ++++ docs/api/interfaces/IBPMNServer.md | 122 ++ docs/api/interfaces/IBehaviour.md | 224 ++++ docs/api/interfaces/IBpmnModelData.md | 78 ++ docs/api/interfaces/ICacheManager.md | 85 ++ docs/api/interfaces/IConfiguration.md | 202 ++++ docs/api/interfaces/ICron.md | 63 + docs/api/interfaces/IDataStore.md | 225 ++++ docs/api/interfaces/IDefinition.md | 191 +++ docs/api/interfaces/IDefinitionData.md | 96 ++ docs/api/interfaces/IElement.md | 223 ++++ docs/api/interfaces/IElementData.md | 52 + docs/api/interfaces/IEngine.md | 234 ++++ docs/api/interfaces/IEventData.md | 188 +++ docs/api/interfaces/IExecution.md | 871 ++++++++++++++ docs/api/interfaces/IFlow.md | 269 +++++ docs/api/interfaces/IFlowData.md | 3 + docs/api/interfaces/IInstanceData.md | 166 +++ docs/api/interfaces/IItem.md | 407 +++++++ docs/api/interfaces/IItemData.md | 271 +++++ docs/api/interfaces/ILogger.md | 197 ++++ docs/api/interfaces/IModelsDatastore.md | 270 +++++ docs/api/interfaces/INode.md | 520 +++++++++ docs/api/interfaces/IProcessData.md | 45 + docs/api/interfaces/ISecureUser.md | 389 +++++++ docs/api/interfaces/IServerComponent.md | 113 ++ docs/api/interfaces/IToken.md | 546 +++++++++ docs/api/interfaces/IUserInfo.md | 58 + docs/api/interfaces/IUserService.md | 90 ++ docs/api/readme.md | 231 ++++ 114 files changed, 46144 insertions(+), 18 deletions(-) create mode 100644 docs/api/.nojekyll create mode 100644 docs/api/API.md create mode 100644 docs/api/classes/APIData.md create mode 100644 docs/api/classes/APIEngine.md create mode 100644 docs/api/classes/APIModel.md create mode 100644 docs/api/classes/BPMNAPI.md create mode 100644 docs/api/classes/BPMNServer.md create mode 100644 docs/api/classes/Behaviour.md create mode 100644 docs/api/classes/BehaviourLoader.md create mode 100644 docs/api/classes/BoundaryEvent.md create mode 100644 docs/api/classes/BpmnModelData.md create mode 100644 docs/api/classes/BusinessRuleTask.md create mode 100644 docs/api/classes/CacheManager.md create mode 100644 docs/api/classes/CallActivity.md create mode 100644 docs/api/classes/CamundaFormData.md create mode 100644 docs/api/classes/CatchEvent.md create mode 100644 docs/api/classes/Configuration.md create mode 100644 docs/api/classes/Cron.md create mode 100644 docs/api/classes/DataStore.md create mode 100644 docs/api/classes/DefaultAppDelegate.md create mode 100644 docs/api/classes/Definition.md create mode 100644 docs/api/classes/Element.md create mode 100644 docs/api/classes/EndEvent.md create mode 100644 docs/api/classes/Engine.md create mode 100644 docs/api/classes/Event.md create mode 100644 docs/api/classes/EventBasedGateway.md create mode 100644 docs/api/classes/EventData.md create mode 100644 docs/api/classes/Execution.md create mode 100644 docs/api/classes/Flow.md create mode 100644 docs/api/classes/Gateway.md create mode 100644 docs/api/classes/IOBehaviour.md create mode 100644 docs/api/classes/InstanceLocker.md create mode 100644 docs/api/classes/InstanceObject.md create mode 100644 docs/api/classes/Item.md create mode 100644 docs/api/classes/ItemObject.md create mode 100644 docs/api/classes/Logger.md create mode 100644 docs/api/classes/Loop.md create mode 100644 docs/api/classes/LoopBehaviour.md create mode 100644 docs/api/classes/LoopObject.md create mode 100644 docs/api/classes/MessageEventBehaviour.md create mode 100644 docs/api/classes/MessageFlow.md create mode 100644 docs/api/classes/ModelsDatastore.md create mode 100644 docs/api/classes/ModelsDatastoreDB.md create mode 100644 docs/api/classes/MongoDB.md create mode 100644 docs/api/classes/NoCacheManager.md create mode 100644 docs/api/classes/Node.md create mode 100644 docs/api/classes/NodeLoader.md create mode 100644 docs/api/classes/Process.md create mode 100644 docs/api/classes/ProcessData.md create mode 100644 docs/api/classes/Query.md create mode 100644 docs/api/classes/ReceiveTask.md create mode 100644 docs/api/classes/ScriptBehaviour.md create mode 100644 docs/api/classes/ScriptHandler.md create mode 100644 docs/api/classes/ScriptTask.md create mode 100644 docs/api/classes/SecureUser.md create mode 100644 docs/api/classes/SendTask.md create mode 100644 docs/api/classes/ServerComponent.md create mode 100644 docs/api/classes/ServiceTask.md create mode 100644 docs/api/classes/SignalEventBehaviour.md create mode 100644 docs/api/classes/StartEvent.md create mode 100644 docs/api/classes/SubProcess.md create mode 100644 docs/api/classes/TerminateBehaviour.md create mode 100644 docs/api/classes/ThrowEvent.md create mode 100644 docs/api/classes/TimerBehaviour.md create mode 100644 docs/api/classes/Token.md create mode 100644 docs/api/classes/TokenObject.md create mode 100644 docs/api/classes/Transaction.md create mode 100644 docs/api/classes/UserTask.md create mode 100644 docs/api/classes/XORGateway.md create mode 100644 docs/api/enums/BPMN_TYPE.md create mode 100644 docs/api/enums/EXECUTION_EVENT.md create mode 100644 docs/api/enums/EXECUTION_STATUS.md create mode 100644 docs/api/enums/FLOW_ACTION.md create mode 100644 docs/api/enums/ITEM_STATUS.md create mode 100644 docs/api/enums/NODE_ACTION.md create mode 100644 docs/api/enums/NODE_SUBTYPE.md create mode 100644 docs/api/enums/TOKEN_STATUS.md create mode 100644 docs/api/enums/TOKEN_TYPE.md create mode 100644 docs/api/enums/USER_ROLE.md create mode 100644 docs/api/interfaces/IAPIData.md create mode 100644 docs/api/interfaces/IAPIEngine.md create mode 100644 docs/api/interfaces/IAPIModel.md create mode 100644 docs/api/interfaces/IAppDelegate.md create mode 100644 docs/api/interfaces/IBPMNServer.md create mode 100644 docs/api/interfaces/IBehaviour.md create mode 100644 docs/api/interfaces/IBpmnModelData.md create mode 100644 docs/api/interfaces/ICacheManager.md create mode 100644 docs/api/interfaces/IConfiguration.md create mode 100644 docs/api/interfaces/ICron.md create mode 100644 docs/api/interfaces/IDataStore.md create mode 100644 docs/api/interfaces/IDefinition.md create mode 100644 docs/api/interfaces/IDefinitionData.md create mode 100644 docs/api/interfaces/IElement.md create mode 100644 docs/api/interfaces/IElementData.md create mode 100644 docs/api/interfaces/IEngine.md create mode 100644 docs/api/interfaces/IEventData.md create mode 100644 docs/api/interfaces/IExecution.md create mode 100644 docs/api/interfaces/IFlow.md create mode 100644 docs/api/interfaces/IFlowData.md create mode 100644 docs/api/interfaces/IInstanceData.md create mode 100644 docs/api/interfaces/IItem.md create mode 100644 docs/api/interfaces/IItemData.md create mode 100644 docs/api/interfaces/ILogger.md create mode 100644 docs/api/interfaces/IModelsDatastore.md create mode 100644 docs/api/interfaces/INode.md create mode 100644 docs/api/interfaces/IProcessData.md create mode 100644 docs/api/interfaces/ISecureUser.md create mode 100644 docs/api/interfaces/IServerComponent.md create mode 100644 docs/api/interfaces/IToken.md create mode 100644 docs/api/interfaces/IUserInfo.md create mode 100644 docs/api/interfaces/IUserService.md create mode 100644 docs/api/readme.md diff --git a/.gitignore b/.gitignore index f0817edf..b131aee7 100644 --- a/.gitignore +++ b/.gitignore @@ -13,7 +13,7 @@ /dist # generated docs /.docusaurus -/docs/api +#/docs/api - needs them for /README.md /build # Copied by scripts\copy-readme.ts docs/README.md diff --git a/README.md b/README.md index b3e3ab44..2fd0a100 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ Typically your application has multiple bpmn models, a model is represented in a Each Model is made of various elements, an `element` can be a `node` in the diagram (events/tasks/gateway) or a `flow` -Models are saved by `bpmn-server` and can be queried [see API.model](docs/api/interfaces/IAPIModel) +Models are saved by `bpmn-server` and can be queried [see API.model](docs/api/interfaces/IAPIModel.md) -`bpmn-server` support all bpmn 2.0 elements [see Modeling Support](docs/examples) +`bpmn-server` support all bpmn 2.0 elements [see Modeling Support](docs/examples.md) ## Execution `bpmn-server` is primiraly an execution engine for bpmn models. @@ -29,7 +29,7 @@ Execution is based on the model logic that is enhanced by various extensions tha During Execution, Model Listeners and Application Listeners are invoked. -The execution `engine` is availabe through an API [see API.engine](docs/api/interfaces/IAPIEngine). +The execution `engine` is availabe through an API [see API.engine](docs/api/interfaces/IAPIEngine.md). For more details about Invoking Execution Engine [see](docs/invokation.md) @@ -39,9 +39,9 @@ For more details about Execution behaviour [see](docs/execution.md) At various stages of execution, instance object with its parts is saved into a datastore (defaults to MongoDB) -Instances and Items can be queried through an API [see API.data](docs/api/interfaces/IAPIData) +Instances and Items can be queried through an API [see API.data](docs/api/interfaces/IAPIData.md) -For more details about data management [see Data](docs/data) +For more details about data management [see Data](docs/data.md) # Demo Web Application @@ -185,18 +185,18 @@ npm update bpmn-server # Documentation -- [Invoking Workflows](/docs/invokation) Ok -- [Execution](/docs/execution) OK -- [Scripting](/docs/scripting) OK -- [Security](/docs/security) Ok -- [Data](/docs/data) Needs Review - - [Input/Output](/docs/data#input-output-data) - - [Data Query](/docs/data#dataQuery) OK -- [Examples](/docs/examples) OK -- [API Summary](/docs/api-summary) -- [API](/docs/api/readme) OK -- [Setup](/docs/setup) Needs Review -- [Application Integration](/docs/customization) Needs work +- [Invoking Workflows](/docs/invokation.md) Ok +- [Execution](/docs/execution.md) OK +- [Scripting](/docs/scripting.md) OK +- [Security](/docs/security.md) Ok +- [Data](/docs/data.md) Needs Review + - [Input/Output](/docs/data#input-output-data.md) + - [Data Query](/docs/data#dataQuery.md) OK +- [Examples](/docs/examples.md) OK +- [API Summary](/docs/api-summary.md) +- [API](/docs/api/readme.md) OK +- [Setup](/docs/setup.md) Needs Review +- [Application Integration](/docs/customization.md) Needs work # License diff --git a/docs/api/.nojekyll b/docs/api/.nojekyll new file mode 100644 index 00000000..e2ac6616 --- /dev/null +++ b/docs/api/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/api/API.md b/docs/api/API.md new file mode 100644 index 00000000..f306ffeb --- /dev/null +++ b/docs/api/API.md @@ -0,0 +1,214 @@ +bpmn-server + +# bpmn-server + +## Table of contents + +### Enumerations + +- [USER\_ROLE](enums/USER_ROLE.md) +- [TOKEN\_TYPE](enums/TOKEN_TYPE.md) +- [BPMN\_TYPE](enums/BPMN_TYPE.md) +- [NODE\_SUBTYPE](enums/NODE_SUBTYPE.md) +- [EXECUTION\_EVENT](enums/EXECUTION_EVENT.md) +- [NODE\_ACTION](enums/NODE_ACTION.md) +- [ITEM\_STATUS](enums/ITEM_STATUS.md) +- [EXECUTION\_STATUS](enums/EXECUTION_STATUS.md) +- [TOKEN\_STATUS](enums/TOKEN_STATUS.md) +- [FLOW\_ACTION](enums/FLOW_ACTION.md) + +### Classes + +- [BPMNAPI](classes/BPMNAPI.md) +- [APIEngine](classes/APIEngine.md) +- [APIData](classes/APIData.md) +- [APIModel](classes/APIModel.md) +- [SecureUser](classes/SecureUser.md) +- [Configuration](classes/Configuration.md) +- [Logger](classes/Logger.md) +- [DataStore](classes/DataStore.md) +- [InstanceLocker](classes/InstanceLocker.md) +- [BpmnModelData](classes/BpmnModelData.md) +- [ProcessData](classes/ProcessData.md) +- [EventData](classes/EventData.md) +- [ModelsDatastore](classes/ModelsDatastore.md) +- [ModelsDatastoreDB](classes/ModelsDatastoreDB.md) +- [MongoDB](classes/MongoDB.md) +- [Definition](classes/Definition.md) +- [Element](classes/Element.md) +- [Event](classes/Event.md) +- [CatchEvent](classes/CatchEvent.md) +- [BoundaryEvent](classes/BoundaryEvent.md) +- [ThrowEvent](classes/ThrowEvent.md) +- [EndEvent](classes/EndEvent.md) +- [StartEvent](classes/StartEvent.md) +- [Flow](classes/Flow.md) +- [MessageFlow](classes/MessageFlow.md) +- [Gateway](classes/Gateway.md) +- [XORGateway](classes/XORGateway.md) +- [EventBasedGateway](classes/EventBasedGateway.md) +- [Node](classes/Node.md) +- [NodeLoader](classes/NodeLoader.md) +- [Process](classes/Process.md) +- [ScriptTask](classes/ScriptTask.md) +- [ServiceTask](classes/ServiceTask.md) +- [BusinessRuleTask](classes/BusinessRuleTask.md) +- [SendTask](classes/SendTask.md) +- [UserTask](classes/UserTask.md) +- [ReceiveTask](classes/ReceiveTask.md) +- [SubProcess](classes/SubProcess.md) +- [CallActivity](classes/CallActivity.md) +- [Transaction](classes/Transaction.md) +- [Behaviour](classes/Behaviour.md) +- [BehaviourLoader](classes/BehaviourLoader.md) +- [CamundaFormData](classes/CamundaFormData.md) +- [IOBehaviour](classes/IOBehaviour.md) +- [LoopBehaviour](classes/LoopBehaviour.md) +- [MessageEventBehaviour](classes/MessageEventBehaviour.md) +- [SignalEventBehaviour](classes/SignalEventBehaviour.md) +- [ScriptBehaviour](classes/ScriptBehaviour.md) +- [TerminateBehaviour](classes/TerminateBehaviour.md) +- [TimerBehaviour](classes/TimerBehaviour.md) +- [DefaultAppDelegate](classes/DefaultAppDelegate.md) +- [Execution](classes/Execution.md) +- [Item](classes/Item.md) +- [Loop](classes/Loop.md) +- [InstanceObject](classes/InstanceObject.md) +- [ItemObject](classes/ItemObject.md) +- [TokenObject](classes/TokenObject.md) +- [LoopObject](classes/LoopObject.md) +- [Query](classes/Query.md) +- [ScriptHandler](classes/ScriptHandler.md) +- [Token](classes/Token.md) +- [BPMNServer](classes/BPMNServer.md) +- [NoCacheManager](classes/NoCacheManager.md) +- [CacheManager](classes/CacheManager.md) +- [Cron](classes/Cron.md) +- [Engine](classes/Engine.md) +- [ServerComponent](classes/ServerComponent.md) + +### Interfaces + +- [IAPIEngine](interfaces/IAPIEngine.md) +- [IAPIData](interfaces/IAPIData.md) +- [IAPIModel](interfaces/IAPIModel.md) +- [IBehaviour](interfaces/IBehaviour.md) +- [IItemData](interfaces/IItemData.md) +- [IInstanceData](interfaces/IInstanceData.md) +- [IDefinitionData](interfaces/IDefinitionData.md) +- [IElementData](interfaces/IElementData.md) +- [IFlowData](interfaces/IFlowData.md) +- [IEventData](interfaces/IEventData.md) +- [IBpmnModelData](interfaces/IBpmnModelData.md) +- [IProcessData](interfaces/IProcessData.md) +- [IUserInfo](interfaces/IUserInfo.md) +- [ISecureUser](interfaces/ISecureUser.md) +- [IUserService](interfaces/IUserService.md) +- [IConfiguration](interfaces/IConfiguration.md) +- [ILogger](interfaces/ILogger.md) +- [IAppDelegate](interfaces/IAppDelegate.md) +- [IDataStore](interfaces/IDataStore.md) +- [IModelsDatastore](interfaces/IModelsDatastore.md) +- [IDefinition](interfaces/IDefinition.md) +- [IElement](interfaces/IElement.md) +- [IFlow](interfaces/IFlow.md) +- [INode](interfaces/INode.md) +- [IToken](interfaces/IToken.md) +- [IExecution](interfaces/IExecution.md) +- [IItem](interfaces/IItem.md) +- [IBPMNServer](interfaces/IBPMNServer.md) +- [IServerComponent](interfaces/IServerComponent.md) +- [IEngine](interfaces/IEngine.md) +- [ICron](interfaces/ICron.md) +- [ICacheManager](interfaces/ICacheManager.md) + +### Variables + +- [SystemUser](API.md#systemuser) +- [defaultConfiguration](API.md#defaultconfiguration) +- [Behaviour\_names](API.md#behaviour_names) +- [docsFolder](API.md#docsfolder) + +### Functions + +- [dateDiff](API.md#datediff) + +## Variables + +### SystemUser + +• `Const` **SystemUser**: [`SecureUser`](classes/SecureUser.md) + +#### Defined in + +[API/SecureUser.ts:230](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L230) + +___ + +### defaultConfiguration + +• **defaultConfiguration**: [`Configuration`](classes/Configuration.md) + +#### Defined in + +[common/DefaultConfiguration.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L59) + +___ + +### Behaviour\_names + +• `Const` **Behaviour\_names**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `TimerEventDefinition` | `string` | +| `LoopCharacteristics` | `string` | +| `IOSpecification` | `string` | +| `TerminateEventDefinition` | `string` | +| `MessageEventDefinition` | `string` | +| `SignalEventDefinition` | `string` | +| `ErrorEventDefinition` | `string` | +| `EscalationEventDefinition` | `string` | +| `CancelEventDefinition` | `string` | +| `CompensateEventDefinition` | `string` | +| `CamundaFormData` | `string` | +| `CamundaScript` | `string` | +| `CamundaScript2` | `string` | +| `CamundaScript3` | `string` | +| `CamundaIO` | `string` | + +#### Defined in + +[elements/behaviours/BehaviourLoader.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/BehaviourLoader.ts#L16) + +___ + +### docsFolder + +• `Const` **docsFolder**: `string` + +#### Defined in + +[index.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/index.ts#L9) + +## Functions + +### dateDiff + +▸ **dateDiff**(`dateStr`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dateStr` | `any` | + +#### Returns + +`string` + +#### Defined in + +[common/timer.ts:4](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/timer.ts#L4) diff --git a/docs/api/classes/APIData.md b/docs/api/classes/APIData.md new file mode 100644 index 00000000..7b4231c2 --- /dev/null +++ b/docs/api/classes/APIData.md @@ -0,0 +1,193 @@ +[bpmn-server](../API.md) / APIData + +# Class: APIData + +## Hierarchy + +- `APIComponent` + + ↳ **`APIData`** + +## Table of contents + +### Constructors + +- [constructor](APIData.md#constructor) + +### Properties + +- [api](APIData.md#api) + +### Accessors + +- [server](APIData.md#server) + +### Methods + +- [getPendingUserTasks](APIData.md#getpendingusertasks) +- [findItems](APIData.md#finditems) +- [findItem](APIData.md#finditem) +- [findInstances](APIData.md#findinstances) +- [deleteInstances](APIData.md#deleteinstances) + +## Constructors + +### constructor + +• **new APIData**(`api`): [`APIData`](APIData.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `api` | `any` | + +#### Returns + +[`APIData`](APIData.md) + +#### Inherited from + +APIComponent.constructor + +#### Defined in + +[API/API.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L24) + +## Properties + +### api + +• **api**: [`BPMNAPI`](BPMNAPI.md) + +#### Inherited from + +APIComponent.api + +#### Defined in + +[API/API.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L22) + +## Accessors + +### server + +• `get` **server**(): [`IBPMNServer`](../interfaces/IBPMNServer.md) + +#### Returns + +[`IBPMNServer`](../interfaces/IBPMNServer.md) + +#### Inherited from + +APIComponent.server + +#### Defined in + +[API/API.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L27) + +## Methods + +### getPendingUserTasks + +▸ **getPendingUserTasks**(`query`, `user`): `Promise`\<[`IItemData`](../interfaces/IItemData.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<[`IItemData`](../interfaces/IItemData.md)[]\> + +#### Defined in + +[API/API.ts:179](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L179) + +___ + +### findItems + +▸ **findItems**(`query`, `user`): `Promise`\<[`IItemData`](../interfaces/IItemData.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<[`IItemData`](../interfaces/IItemData.md)[]\> + +#### Defined in + +[API/API.ts:187](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L187) + +___ + +### findItem + +▸ **findItem**(`query`, `user`): `Promise`\<[`IItemData`](../interfaces/IItemData.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<[`IItemData`](../interfaces/IItemData.md)\> + +#### Defined in + +[API/API.ts:191](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L191) + +___ + +### findInstances + +▸ **findInstances**(`query`, `user`, `options`): `Promise`\<[`IInstanceData`](../interfaces/IInstanceData.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | +| `options` | `any` | + +#### Returns + +`Promise`\<[`IInstanceData`](../interfaces/IInstanceData.md)[]\> + +#### Defined in + +[API/API.ts:196](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L196) + +___ + +### deleteInstances + +▸ **deleteInstances**(`query`, `user`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[API/API.ts:200](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L200) diff --git a/docs/api/classes/APIEngine.md b/docs/api/classes/APIEngine.md new file mode 100644 index 00000000..8541ef00 --- /dev/null +++ b/docs/api/classes/APIEngine.md @@ -0,0 +1,283 @@ +[bpmn-server](../API.md) / APIEngine + +# Class: APIEngine + +common parameters: + +- query: MongoDB query to locate the target instance or item + +- data: input Data + +- user: an instance of ISecureUser object + +- options: various options, this is an open object that is based through the run-time + +Returns IExecution +containing the instance and the results of the call + +## Hierarchy + +- `APIComponent` + + ↳ **`APIEngine`** + +## Implements + +- [`IAPIEngine`](../interfaces/IAPIEngine.md) + +## Table of contents + +### Constructors + +- [constructor](APIEngine.md#constructor) + +### Properties + +- [api](APIEngine.md#api) + +### Accessors + +- [server](APIEngine.md#server) + +### Methods + +- [start](APIEngine.md#start) +- [invoke](APIEngine.md#invoke) +- [assign](APIEngine.md#assign) +- [throwMessage](APIEngine.md#throwmessage) +- [throwSignal](APIEngine.md#throwsignal) +- [startEvent](APIEngine.md#startevent) + +## Constructors + +### constructor + +• **new APIEngine**(`api`): [`APIEngine`](APIEngine.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `api` | `any` | + +#### Returns + +[`APIEngine`](APIEngine.md) + +#### Inherited from + +APIComponent.constructor + +#### Defined in + +[API/API.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L24) + +## Properties + +### api + +• **api**: [`BPMNAPI`](BPMNAPI.md) + +#### Inherited from + +APIComponent.api + +#### Defined in + +[API/API.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L22) + +## Accessors + +### server + +• `get` **server**(): [`IBPMNServer`](../interfaces/IBPMNServer.md) + +#### Returns + +[`IBPMNServer`](../interfaces/IBPMNServer.md) + +#### Inherited from + +APIComponent.server + +#### Defined in + +[API/API.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L27) + +## Methods + +### start + +▸ **start**(`name`, `data?`, `user`, `options?`): `Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +start a new Instance of specified model + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `data` | `Object` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | +| `options` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Implementation of + +[IAPIEngine](../interfaces/IAPIEngine.md).[start](../interfaces/IAPIEngine.md#start) + +#### Defined in + +[API/API.ts:155](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L155) + +___ + +### invoke + +▸ **invoke**(`query`, `data?`, `user`, `options?`): `Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +continue with the execution of a particular item that is in a wait state, typically a user task + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `data` | `Object` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | +| `options` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Implementation of + +[IAPIEngine](../interfaces/IAPIEngine.md).[invoke](../interfaces/IAPIEngine.md#invoke) + +#### Defined in + +[API/API.ts:159](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L159) + +___ + +### assign + +▸ **assign**(`query`, `data`, `assignment`, `user`, `options?`): `Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +provide assignment data to a user task + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `data` | `any` | +| `assignment` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | +| `options` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Implementation of + +[IAPIEngine](../interfaces/IAPIEngine.md).[assign](../interfaces/IAPIEngine.md#assign) + +#### Defined in + +[API/API.ts:164](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L164) + +___ + +### throwMessage + +▸ **throwMessage**(`messageId`, `data`, `messageMatchingKey`, `user`, `options?`): `Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +throw a message with an id, system will identify receiving item + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `messageId` | `any` | +| `data` | `any` | +| `messageMatchingKey` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | +| `options` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Implementation of + +[IAPIEngine](../interfaces/IAPIEngine.md).[throwMessage](../interfaces/IAPIEngine.md#throwmessage) + +#### Defined in + +[API/API.ts:168](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L168) + +___ + +### throwSignal + +▸ **throwSignal**(`signalId`, `data`, `messageMatchingKey`, `user`, `options?`): `Promise`\<`any`\> + +throw a signal with an id, system will identify receiving item(s) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signalId` | `any` | +| `data` | `any` | +| `messageMatchingKey` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | +| `options` | `Object` | + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IAPIEngine](../interfaces/IAPIEngine.md).[throwSignal](../interfaces/IAPIEngine.md#throwsignal) + +#### Defined in + +[API/API.ts:171](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L171) + +___ + +### startEvent + +▸ **startEvent**(`query`, `elementId`, `data?`, `user`, `options?`): `Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +start a second event node (in a subprocess) for a running instance + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `elementId` | `any` | +| `data` | `Object` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | +| `options` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Implementation of + +[IAPIEngine](../interfaces/IAPIEngine.md).[startEvent](../interfaces/IAPIEngine.md#startevent) + +#### Defined in + +[API/API.ts:174](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L174) diff --git a/docs/api/classes/APIModel.md b/docs/api/classes/APIModel.md new file mode 100644 index 00000000..eea91007 --- /dev/null +++ b/docs/api/classes/APIModel.md @@ -0,0 +1,283 @@ +[bpmn-server](../API.md) / APIModel + +# Class: APIModel + +## Hierarchy + +- `APIComponent` + + ↳ **`APIModel`** + +## Table of contents + +### Constructors + +- [constructor](APIModel.md#constructor) + +### Properties + +- [api](APIModel.md#api) + +### Accessors + +- [server](APIModel.md#server) + +### Methods + +- [save](APIModel.md#save) +- [list](APIModel.md#list) +- [findEvents](APIModel.md#findevents) +- [findStartEvents](APIModel.md#findstartevents) +- [delete](APIModel.md#delete) +- [rename](APIModel.md#rename) +- [getSource](APIModel.md#getsource) +- [load](APIModel.md#load) +- [export](APIModel.md#export) + +## Constructors + +### constructor + +• **new APIModel**(`api`): [`APIModel`](APIModel.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `api` | `any` | + +#### Returns + +[`APIModel`](APIModel.md) + +#### Inherited from + +APIComponent.constructor + +#### Defined in + +[API/API.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L24) + +## Properties + +### api + +• **api**: [`BPMNAPI`](BPMNAPI.md) + +#### Inherited from + +APIComponent.api + +#### Defined in + +[API/API.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L22) + +## Accessors + +### server + +• `get` **server**(): [`IBPMNServer`](../interfaces/IBPMNServer.md) + +#### Returns + +[`IBPMNServer`](../interfaces/IBPMNServer.md) + +#### Inherited from + +APIComponent.server + +#### Defined in + +[API/API.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L27) + +## Methods + +### save + +▸ **save**(`name`, `source`, `svg`, `user`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `source` | `any` | +| `svg` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[API/API.ts:207](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L207) + +___ + +### list + +▸ **list**(`user`): `Promise`\<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<`string`[]\> + +#### Defined in + +[API/API.ts:214](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L214) + +___ + +### findEvents + +▸ **findEvents**(`query`, `user`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Defined in + +[API/API.ts:221](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L221) + +___ + +### findStartEvents + +▸ **findStartEvents**(`query`, `user`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Defined in + +[API/API.ts:225](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L225) + +___ + +### delete + +▸ **delete**(`name`, `user`): `Promise`\<``false`` \| `void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<``false`` \| `void`\> + +#### Defined in + +[API/API.ts:230](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L230) + +___ + +### rename + +▸ **rename**(`name`, `newName`, `user`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `newName` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[API/API.ts:235](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L235) + +___ + +### getSource + +▸ **getSource**(`name`, `user`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[API/API.ts:240](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L240) + +___ + +### load + +▸ **load**(`name`, `user`): `Promise`\<[`IDefinition`](../interfaces/IDefinition.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<[`IDefinition`](../interfaces/IDefinition.md)\> + +#### Defined in + +[API/API.ts:243](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L243) + +___ + +### export + +▸ **export**(`query`, `folder`, `user`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `folder` | `any` | +| `user` | [`ISecureUser`](../interfaces/ISecureUser.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[API/API.ts:246](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L246) diff --git a/docs/api/classes/BPMNAPI.md b/docs/api/classes/BPMNAPI.md new file mode 100644 index 00000000..470a32eb --- /dev/null +++ b/docs/api/classes/BPMNAPI.md @@ -0,0 +1,76 @@ +[bpmn-server](../API.md) / BPMNAPI + +# Class: BPMNAPI + +## Table of contents + +### Constructors + +- [constructor](BPMNAPI.md#constructor) + +### Properties + +- [server](BPMNAPI.md#server) +- [engine](BPMNAPI.md#engine) +- [data](BPMNAPI.md#data) +- [model](BPMNAPI.md#model) + +## Constructors + +### constructor + +• **new BPMNAPI**(`server`): [`BPMNAPI`](BPMNAPI.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | [`IBPMNServer`](../interfaces/IBPMNServer.md) | + +#### Returns + +[`BPMNAPI`](BPMNAPI.md) + +#### Defined in + +[API/API.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L14) + +## Properties + +### server + +• **server**: [`IBPMNServer`](../interfaces/IBPMNServer.md) + +#### Defined in + +[API/API.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L9) + +___ + +### engine + +• **engine**: [`APIEngine`](APIEngine.md) + +#### Defined in + +[API/API.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L10) + +___ + +### data + +• **data**: [`APIData`](APIData.md) + +#### Defined in + +[API/API.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L11) + +___ + +### model + +• **model**: [`APIModel`](APIModel.md) + +#### Defined in + +[API/API.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L12) diff --git a/docs/api/classes/BPMNServer.md b/docs/api/classes/BPMNServer.md new file mode 100644 index 00000000..e31cb8a9 --- /dev/null +++ b/docs/api/classes/BPMNServer.md @@ -0,0 +1,276 @@ +[bpmn-server](../API.md) / BPMNServer + +# Class: BPMNServer + +The main class of Server Layer + provides the full functionalities: + + at start of the app: + new BPMNServer(configuration,options); + + after that point: + + BPMNServer.engine.start(...) + BPMNServer.engine.invoke(...) + BPMNServer.dataStore.findInstances(...) + BPMNServer.dataStore.findItems(...) + +## Implements + +- [`IBPMNServer`](../interfaces/IBPMNServer.md) + +## Table of contents + +### Constructors + +- [constructor](BPMNServer.md#constructor) + +### Properties + +- [engine](BPMNServer.md#engine) +- [listener](BPMNServer.md#listener) +- [configuration](BPMNServer.md#configuration) +- [logger](BPMNServer.md#logger) +- [definitions](BPMNServer.md#definitions) +- [appDelegate](BPMNServer.md#appdelegate) +- [dataStore](BPMNServer.md#datastore) +- [cache](BPMNServer.md#cache) +- [cron](BPMNServer.md#cron) +- [userService](BPMNServer.md#userservice) +- [error](BPMNServer.md#error) +- [instance](BPMNServer.md#instance) + +### Accessors + +- [engine](BPMNServer.md#engine-1) + +### Methods + +- [getVersion](BPMNServer.md#getversion) +- [getInstance](BPMNServer.md#getinstance) + +## Constructors + +### constructor + +• **new BPMNServer**(`configuration`, `logger?`, `options?`): [`BPMNServer`](BPMNServer.md) + +Server Constructor + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `configuration` | [`IConfiguration`](../interfaces/IConfiguration.md) | see | +| `logger?` | [`ILogger`](../interfaces/ILogger.md) | | +| `options` | `Object` | - | + +#### Returns + +[`BPMNServer`](BPMNServer.md) + +#### Defined in + +[server/BPMNServer.ts:65](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L65) + +## Properties + +### engine + +• **engine**: [`Engine`](Engine.md) + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[engine](../interfaces/IBPMNServer.md#engine) + +#### Defined in + +[server/BPMNServer.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L44) + +___ + +### listener + +• **listener**: `EventEmitter` + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[listener](../interfaces/IBPMNServer.md#listener) + +#### Defined in + +[server/BPMNServer.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L45) + +___ + +### configuration + +• **configuration**: [`IConfiguration`](../interfaces/IConfiguration.md) + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[configuration](../interfaces/IBPMNServer.md#configuration) + +#### Defined in + +[server/BPMNServer.ts:46](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L46) + +___ + +### logger + +• **logger**: [`ILogger`](../interfaces/ILogger.md) + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[logger](../interfaces/IBPMNServer.md#logger) + +#### Defined in + +[server/BPMNServer.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L47) + +___ + +### definitions + +• **definitions**: `any` + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[definitions](../interfaces/IBPMNServer.md#definitions) + +#### Defined in + +[server/BPMNServer.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L48) + +___ + +### appDelegate + +• **appDelegate**: [`IAppDelegate`](../interfaces/IAppDelegate.md) + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[appDelegate](../interfaces/IBPMNServer.md#appdelegate) + +#### Defined in + +[server/BPMNServer.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L49) + +___ + +### dataStore + +• **dataStore**: [`IDataStore`](../interfaces/IDataStore.md) + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[dataStore](../interfaces/IBPMNServer.md#datastore) + +#### Defined in + +[server/BPMNServer.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L50) + +___ + +### cache + +• **cache**: [`ICacheManager`](../interfaces/ICacheManager.md) + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[cache](../interfaces/IBPMNServer.md#cache) + +#### Defined in + +[server/BPMNServer.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L51) + +___ + +### cron + +• **cron**: [`Cron`](Cron.md) + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[cron](../interfaces/IBPMNServer.md#cron) + +#### Defined in + +[server/BPMNServer.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L52) + +___ + +### userService + +• **userService**: [`IUserService`](../interfaces/IUserService.md) + +#### Implementation of + +[IBPMNServer](../interfaces/IBPMNServer.md).[userService](../interfaces/IBPMNServer.md#userservice) + +#### Defined in + +[server/BPMNServer.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L53) + +___ + +### error + +• **error**: `any` + +#### Defined in + +[server/BPMNServer.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L54) + +___ + +### instance + +▪ `Static` `Private` **instance**: [`BPMNServer`](BPMNServer.md) + +#### Defined in + +[server/BPMNServer.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L56) + +## Accessors + +### engine + +• `get` **engine**(): [`Engine`](Engine.md) + +#### Returns + +[`Engine`](Engine.md) + +#### Defined in + +[server/BPMNServer.ts:111](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L111) + +## Methods + +### getVersion + +▸ **getVersion**(): `any` + +#### Returns + +`any` + +#### Defined in + +[server/BPMNServer.ts:96](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L96) + +___ + +### getInstance + +▸ **getInstance**(): [`BPMNServer`](BPMNServer.md) + +#### Returns + +[`BPMNServer`](BPMNServer.md) + +#### Defined in + +[server/BPMNServer.ts:114](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/BPMNServer.ts#L114) diff --git a/docs/api/classes/Behaviour.md b/docs/api/classes/Behaviour.md new file mode 100644 index 00000000..b31cd282 --- /dev/null +++ b/docs/api/classes/Behaviour.md @@ -0,0 +1,355 @@ +[bpmn-server](../API.md) / Behaviour + +# Class: Behaviour + +Behaviour + ioSpecification + timer + message + signal + + each behaviour is a class + it scans def and insert itself to perform actions as required + +## Hierarchy + +- **`Behaviour`** + + ↳ [`CamundaFormData`](CamundaFormData.md) + + ↳ [`IOBehaviour`](IOBehaviour.md) + + ↳ [`MessageEventBehaviour`](MessageEventBehaviour.md) + + ↳ [`SignalEventBehaviour`](SignalEventBehaviour.md) + + ↳ [`TerminateBehaviour`](TerminateBehaviour.md) + + ↳ [`TimerBehaviour`](TimerBehaviour.md) + + ↳ [`LoopBehaviour`](LoopBehaviour.md) + + ↳ [`ScriptBehaviour`](ScriptBehaviour.md) + +## Implements + +- [`IBehaviour`](../interfaces/IBehaviour.md) + +## Table of contents + +### Constructors + +- [constructor](Behaviour.md#constructor) + +### Properties + +- [node](Behaviour.md#node) +- [definition](Behaviour.md#definition) + +### Methods + +- [restored](Behaviour.md#restored) +- [describe](Behaviour.md#describe) +- [init](Behaviour.md#init) +- [enter](Behaviour.md#enter) +- [start](Behaviour.md#start) +- [run](Behaviour.md#run) +- [end](Behaviour.md#end) +- [exit](Behaviour.md#exit) +- [resume](Behaviour.md#resume) +- [getNodeAttributes](Behaviour.md#getnodeattributes) +- [getItemAttributes](Behaviour.md#getitemattributes) + +## Constructors + +### constructor + +• **new Behaviour**(`node`, `definition`): [`Behaviour`](Behaviour.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `definition` | `any` | + +#### Returns + +[`Behaviour`](Behaviour.md) + +#### Defined in + +[elements/behaviours/Behaviour.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L40) + +## Properties + +### node + +• **node**: [`Node`](Node.md) + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[node](../interfaces/IBehaviour.md#node) + +#### Defined in + +[elements/behaviours/Behaviour.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L38) + +___ + +### definition + +• **definition**: `any` + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[definition](../interfaces/IBehaviour.md#definition) + +#### Defined in + +[elements/behaviours/Behaviour.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L39) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[restored](../interfaces/IBehaviour.md#restored) + +#### Defined in + +[elements/behaviours/Behaviour.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L45) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[describe](../interfaces/IBehaviour.md#describe) + +#### Defined in + +[elements/behaviours/Behaviour.ts:46](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L46) + +___ + +### init + +▸ **init**(): `void` + +#### Returns + +`void` + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[init](../interfaces/IBehaviour.md#init) + +#### Defined in + +[elements/behaviours/Behaviour.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L47) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Defined in + +[elements/behaviours/Behaviour.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L48) + +___ + +### start + +▸ **start**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[start](../interfaces/IBehaviour.md#start) + +#### Defined in + +[elements/behaviours/Behaviour.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L49) + +___ + +### run + +▸ **run**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[run](../interfaces/IBehaviour.md#run) + +#### Defined in + +[elements/behaviours/Behaviour.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L50) + +___ + +### end + +▸ **end**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[end](../interfaces/IBehaviour.md#end) + +#### Defined in + +[elements/behaviours/Behaviour.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L51) + +___ + +### exit + +▸ **exit**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Defined in + +[elements/behaviours/Behaviour.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L52) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[resume](../interfaces/IBehaviour.md#resume) + +#### Defined in + +[elements/behaviours/Behaviour.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L53) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[getNodeAttributes](../interfaces/IBehaviour.md#getnodeattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L54) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Implementation of + +[IBehaviour](../interfaces/IBehaviour.md).[getItemAttributes](../interfaces/IBehaviour.md#getitemattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L55) diff --git a/docs/api/classes/BehaviourLoader.md b/docs/api/classes/BehaviourLoader.md new file mode 100644 index 00000000..6d73629b --- /dev/null +++ b/docs/api/classes/BehaviourLoader.md @@ -0,0 +1,114 @@ +[bpmn-server](../API.md) / BehaviourLoader + +# Class: BehaviourLoader + +## Table of contents + +### Constructors + +- [constructor](BehaviourLoader.md#constructor) + +### Properties + +- [behaviours](BehaviourLoader.md#behaviours) + +### Methods + +- [register](BehaviourLoader.md#register) +- [load](BehaviourLoader.md#load) + +## Constructors + +### constructor + +• **new BehaviourLoader**(): [`BehaviourLoader`](BehaviourLoader.md) + +#### Returns + +[`BehaviourLoader`](BehaviourLoader.md) + +## Properties + +### behaviours + +▪ `Static` **behaviours**: (\{ `name`: `string` = Behaviour\_names.CamundaFormData; `funct`: (`node`: `any`, `def`: `any`) => [`CamundaFormData`](CamundaFormData.md) } \| \{ `name`: `string` = Behaviour\_names.SignalEventDefinition; `funct`: (`node`: `any`, `def`: `any`) => [`SignalEventBehaviour`](SignalEventBehaviour.md) } \| \{ `name`: `string` = Behaviour\_names.CompensateEventDefinition; `funct`: (`node`: `any`, `def`: `any`) => `CompensateEventBehaviour` } \| \{ `name`: `string` = Behaviour\_names.CancelEventDefinition; `funct`: (`node`: `any`, `def`: `any`) => `CancelEventBehaviour` } \| \{ `name`: `string` = Behaviour\_names.CamundaScript2; `funct`: (`node`: `any`, `def`: `any`) => [`ScriptBehaviour`](ScriptBehaviour.md) } \| \{ `name`: `string` = Behaviour\_names.TerminateEventDefinition; `funct`: (`node`: `any`, `def`: `any`) => [`TerminateBehaviour`](TerminateBehaviour.md) })[] + +#### Defined in + +[elements/behaviours/BehaviourLoader.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/BehaviourLoader.ts#L36) + +## Methods + +### register + +▸ **register**(`name`, `funct`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `funct` | `any` | + +#### Returns + +`void` + +#### Defined in + +[elements/behaviours/BehaviourLoader.ts:114](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/BehaviourLoader.ts#L114) + +___ + +### load + +▸ **load**(`node`): `void` + +#### 1. Load behaviours from node definition + +`node.definition[]` + +#### 2. Load behaviours from node definition.eventDefinitions + +```ts +node.definition.eventDefinitions + $type == +``` +example: + +```xml + + PT2S + + ``` + #### 3. Load behaviours from node definition.extensionElements + +```ts +node.definitions.extensionElements + $type == +``` +example: + +```xml +'camunda:formData' + + + + + + < /extensionElements> +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | + +#### Returns + +`void` + +#### Defined in + +[elements/behaviours/BehaviourLoader.ts:156](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/BehaviourLoader.ts#L156) diff --git a/docs/api/classes/BoundaryEvent.md b/docs/api/classes/BoundaryEvent.md new file mode 100644 index 00000000..1451e182 --- /dev/null +++ b/docs/api/classes/BoundaryEvent.md @@ -0,0 +1,1069 @@ +[bpmn-server](../API.md) / BoundaryEvent + +# Class: BoundaryEvent + +## Hierarchy + +- [`Event`](Event.md) + + ↳ **`BoundaryEvent`** + +## Table of contents + +### Constructors + +- [constructor](BoundaryEvent.md#constructor) + +### Properties + +- [id](BoundaryEvent.md#id) +- [type](BoundaryEvent.md#type) +- [subType](BoundaryEvent.md#subtype) +- [behaviours](BoundaryEvent.md#behaviours) +- [isFlow](BoundaryEvent.md#isflow) +- [lane](BoundaryEvent.md#lane) +- [isCancelling](BoundaryEvent.md#iscancelling) +- [name](BoundaryEvent.md#name) +- [process](BoundaryEvent.md#process) +- [def](BoundaryEvent.md#def) +- [outbounds](BoundaryEvent.md#outbounds) +- [inbounds](BoundaryEvent.md#inbounds) +- [attachments](BoundaryEvent.md#attachments) +- [attachedTo](BoundaryEvent.md#attachedto) +- [messageId](BoundaryEvent.md#messageid) +- [signalId](BoundaryEvent.md#signalid) +- [initiator](BoundaryEvent.md#initiator) +- [assignee](BoundaryEvent.md#assignee) +- [candidateGroups](BoundaryEvent.md#candidategroups) +- [candidateUsers](BoundaryEvent.md#candidateusers) +- [scripts](BoundaryEvent.md#scripts) + +### Accessors + +- [isCatching](BoundaryEvent.md#iscatching) +- [requiresWait](BoundaryEvent.md#requireswait) +- [canBeInvoked](BoundaryEvent.md#canbeinvoked) +- [processId](BoundaryEvent.md#processid) + +### Methods + +- [restored](BoundaryEvent.md#restored) +- [hasBehaviour](BoundaryEvent.md#hasbehaviour) +- [getBehaviour](BoundaryEvent.md#getbehaviour) +- [addBehaviour](BoundaryEvent.md#addbehaviour) +- [hasMessage](BoundaryEvent.md#hasmessage) +- [hasSignal](BoundaryEvent.md#hassignal) +- [hasTimer](BoundaryEvent.md#hastimer) +- [end](BoundaryEvent.md#end) +- [start](BoundaryEvent.md#start) +- [run](BoundaryEvent.md#run) +- [validate](BoundaryEvent.md#validate) +- [doEvent](BoundaryEvent.md#doevent) +- [setInput](BoundaryEvent.md#setinput) +- [getInput](BoundaryEvent.md#getinput) +- [getOutput](BoundaryEvent.md#getoutput) +- [enter](BoundaryEvent.md#enter) +- [execute](BoundaryEvent.md#execute) +- [continue](BoundaryEvent.md#continue) +- [cancelEBG](BoundaryEvent.md#cancelebg) +- [cancelBoundaryEvents](BoundaryEvent.md#cancelboundaryevents) +- [resume](BoundaryEvent.md#resume) +- [init](BoundaryEvent.md#init) +- [getOutbounds](BoundaryEvent.md#getoutbounds) +- [startBoundaryEvents](BoundaryEvent.md#startboundaryevents) +- [describe](BoundaryEvent.md#describe) + +## Constructors + +### constructor + +• **new BoundaryEvent**(`id`, `process`, `type`, `def`): [`BoundaryEvent`](BoundaryEvent.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`BoundaryEvent`](BoundaryEvent.md) + +#### Overrides + +[Event](Event.md).[constructor](Event.md#constructor) + +#### Defined in + +[elements/Events.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L56) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Event](Event.md).[id](Event.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Event](Event.md).[type](Event.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Event](Event.md).[subType](Event.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[behaviours](Event.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Event](Event.md).[isFlow](Event.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Event](Event.md).[lane](Event.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### isCancelling + +• **isCancelling**: `boolean` + +#### Defined in + +[elements/Events.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L55) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Event](Event.md).[name](Event.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Event](Event.md).[process](Event.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Event](Event.md).[def](Event.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[outbounds](Event.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[inbounds](Event.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Event](Event.md).[attachments](Event.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Event](Event.md).[attachedTo](Event.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Event](Event.md).[messageId](Event.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Event](Event.md).[signalId](Event.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Event](Event.md).[initiator](Event.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Event](Event.md).[assignee](Event.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Event](Event.md).[candidateGroups](Event.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Event](Event.md).[candidateUsers](Event.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[scripts](Event.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Event.isCatching + +#### Defined in + +[elements/Events.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L53) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Event.requiresWait + +#### Defined in + +[elements/Events.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L64) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Event.canBeInvoked + +#### Defined in + +[elements/Events.ts:67](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L67) + +___ + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Event.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[restored](Event.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Event](Event.md).[hasBehaviour](Event.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[getBehaviour](Event.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[addBehaviour](Event.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### hasMessage + +▸ **hasMessage**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasMessage](Event.md#hasmessage) + +#### Defined in + +[elements/Events.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L9) + +___ + +### hasSignal + +▸ **hasSignal**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasSignal](Event.md#hassignal) + +#### Defined in + +[elements/Events.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L12) + +___ + +### hasTimer + +▸ **hasTimer**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasTimer](Event.md#hastimer) + +#### Defined in + +[elements/Events.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L15) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[end](Event.md#end) + +#### Defined in + +[elements/Events.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L28) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +using token: check if fromEventBasedGateway; if yes cancel all other events + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Event](Event.md).[start](Event.md#start) + +#### Defined in + +[elements/Events.ts:71](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L71) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Event](Event.md).[run](Event.md#run) + +#### Defined in + +[elements/Events.ts:74](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L74) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[validate](Event.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Event](Event.md).[doEvent](Event.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[setInput](Event.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getInput](Event.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getOutput](Event.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[enter](Event.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Event](Event.md).[execute](Event.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[continue](Event.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelEBG](Event.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelBoundaryEvents](Event.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[resume](Event.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[init](Event.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Event](Event.md).[getOutbounds](Event.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[startBoundaryEvents](Event.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Event](Event.md).[describe](Event.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/BpmnModelData.md b/docs/api/classes/BpmnModelData.md new file mode 100644 index 00000000..fa958728 --- /dev/null +++ b/docs/api/classes/BpmnModelData.md @@ -0,0 +1,154 @@ +[bpmn-server](../API.md) / BpmnModelData + +# Class: BpmnModelData + +## Implements + +- [`IBpmnModelData`](../interfaces/IBpmnModelData.md) + +## Table of contents + +### Constructors + +- [constructor](BpmnModelData.md#constructor) + +### Properties + +- [name](BpmnModelData.md#name) +- [source](BpmnModelData.md#source) +- [svg](BpmnModelData.md#svg) +- [processes](BpmnModelData.md#processes) +- [events](BpmnModelData.md#events) +- [saved](BpmnModelData.md#saved) + +### Methods + +- [parse](BpmnModelData.md#parse) + +## Constructors + +### constructor + +• **new BpmnModelData**(`name`, `source`, `svg`, `processes`, `events`): [`BpmnModelData`](BpmnModelData.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `source` | `any` | +| `svg` | `any` | +| `processes` | `any` | +| `events` | `any` | + +#### Returns + +[`BpmnModelData`](BpmnModelData.md) + +#### Defined in + +[datastore/ModelsData.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L18) + +## Properties + +### name + +• **name**: `any` + +#### Implementation of + +[IBpmnModelData](../interfaces/IBpmnModelData.md).[name](../interfaces/IBpmnModelData.md#name) + +#### Defined in + +[datastore/ModelsData.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L12) + +___ + +### source + +• **source**: `any` + +#### Implementation of + +[IBpmnModelData](../interfaces/IBpmnModelData.md).[source](../interfaces/IBpmnModelData.md#source) + +#### Defined in + +[datastore/ModelsData.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L13) + +___ + +### svg + +• **svg**: `any` + +#### Implementation of + +[IBpmnModelData](../interfaces/IBpmnModelData.md).[svg](../interfaces/IBpmnModelData.md#svg) + +#### Defined in + +[datastore/ModelsData.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L14) + +___ + +### processes + +• **processes**: [`IProcessData`](../interfaces/IProcessData.md)[] + +#### Implementation of + +[IBpmnModelData](../interfaces/IBpmnModelData.md).[processes](../interfaces/IBpmnModelData.md#processes) + +#### Defined in + +[datastore/ModelsData.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L15) + +___ + +### events + +• **events**: [`IEventData`](../interfaces/IEventData.md)[] + +#### Implementation of + +[IBpmnModelData](../interfaces/IBpmnModelData.md).[events](../interfaces/IBpmnModelData.md#events) + +#### Defined in + +[datastore/ModelsData.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L16) + +___ + +### saved + +• **saved**: `any` + +#### Implementation of + +[IBpmnModelData](../interfaces/IBpmnModelData.md).[saved](../interfaces/IBpmnModelData.md#saved) + +#### Defined in + +[datastore/ModelsData.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L17) + +## Methods + +### parse + +▸ **parse**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Definition`](Definition.md) | + +#### Returns + +`void` + +#### Defined in + +[datastore/ModelsData.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L30) diff --git a/docs/api/classes/BusinessRuleTask.md b/docs/api/classes/BusinessRuleTask.md new file mode 100644 index 00000000..27c72ce6 --- /dev/null +++ b/docs/api/classes/BusinessRuleTask.md @@ -0,0 +1,1028 @@ +[bpmn-server](../API.md) / BusinessRuleTask + +# Class: BusinessRuleTask + +```ts + foo[method](); + + await this.token.appDelegate[serviceName](data); + + + service signature: + output= service (input,context) +``` + +## Hierarchy + +- [`ServiceTask`](ServiceTask.md) + + ↳ **`BusinessRuleTask`** + +## Table of contents + +### Constructors + +- [constructor](BusinessRuleTask.md#constructor) + +### Properties + +- [id](BusinessRuleTask.md#id) +- [type](BusinessRuleTask.md#type) +- [subType](BusinessRuleTask.md#subtype) +- [behaviours](BusinessRuleTask.md#behaviours) +- [isFlow](BusinessRuleTask.md#isflow) +- [lane](BusinessRuleTask.md#lane) +- [name](BusinessRuleTask.md#name) +- [process](BusinessRuleTask.md#process) +- [def](BusinessRuleTask.md#def) +- [outbounds](BusinessRuleTask.md#outbounds) +- [inbounds](BusinessRuleTask.md#inbounds) +- [attachments](BusinessRuleTask.md#attachments) +- [attachedTo](BusinessRuleTask.md#attachedto) +- [messageId](BusinessRuleTask.md#messageid) +- [signalId](BusinessRuleTask.md#signalid) +- [initiator](BusinessRuleTask.md#initiator) +- [assignee](BusinessRuleTask.md#assignee) +- [candidateGroups](BusinessRuleTask.md#candidategroups) +- [candidateUsers](BusinessRuleTask.md#candidateusers) +- [scripts](BusinessRuleTask.md#scripts) + +### Accessors + +- [processId](BusinessRuleTask.md#processid) +- [requiresWait](BusinessRuleTask.md#requireswait) +- [canBeInvoked](BusinessRuleTask.md#canbeinvoked) +- [isCatching](BusinessRuleTask.md#iscatching) +- [serviceName](BusinessRuleTask.md#servicename) + +### Methods + +- [restored](BusinessRuleTask.md#restored) +- [hasBehaviour](BusinessRuleTask.md#hasbehaviour) +- [getBehaviour](BusinessRuleTask.md#getbehaviour) +- [addBehaviour](BusinessRuleTask.md#addbehaviour) +- [validate](BusinessRuleTask.md#validate) +- [doEvent](BusinessRuleTask.md#doevent) +- [setInput](BusinessRuleTask.md#setinput) +- [getInput](BusinessRuleTask.md#getinput) +- [getOutput](BusinessRuleTask.md#getoutput) +- [enter](BusinessRuleTask.md#enter) +- [execute](BusinessRuleTask.md#execute) +- [continue](BusinessRuleTask.md#continue) +- [start](BusinessRuleTask.md#start) +- [cancelEBG](BusinessRuleTask.md#cancelebg) +- [cancelBoundaryEvents](BusinessRuleTask.md#cancelboundaryevents) +- [end](BusinessRuleTask.md#end) +- [resume](BusinessRuleTask.md#resume) +- [init](BusinessRuleTask.md#init) +- [getOutbounds](BusinessRuleTask.md#getoutbounds) +- [startBoundaryEvents](BusinessRuleTask.md#startboundaryevents) +- [describe](BusinessRuleTask.md#describe) +- [run](BusinessRuleTask.md#run) + +## Constructors + +### constructor + +• **new BusinessRuleTask**(`id`, `process`, `type`, `def`): [`BusinessRuleTask`](BusinessRuleTask.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`BusinessRuleTask`](BusinessRuleTask.md) + +#### Inherited from + +[ServiceTask](ServiceTask.md).[constructor](ServiceTask.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[id](ServiceTask.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[type](ServiceTask.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[subType](ServiceTask.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[behaviours](ServiceTask.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[isFlow](ServiceTask.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[lane](ServiceTask.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[name](ServiceTask.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[process](ServiceTask.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[def](ServiceTask.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[outbounds](ServiceTask.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[inbounds](ServiceTask.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[attachments](ServiceTask.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[ServiceTask](ServiceTask.md).[attachedTo](ServiceTask.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[messageId](ServiceTask.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[signalId](ServiceTask.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[initiator](ServiceTask.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[assignee](ServiceTask.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[candidateGroups](ServiceTask.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[candidateUsers](ServiceTask.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[scripts](ServiceTask.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServiceTask.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +ServiceTask.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +ServiceTask.canBeInvoked + +#### Defined in + +[elements/Node.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L127) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +ServiceTask.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +___ + +### serviceName + +• `get` **serviceName**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServiceTask.serviceName + +#### Defined in + +[elements/Tasks.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L38) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[restored](ServiceTask.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[hasBehaviour](ServiceTask.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[getBehaviour](ServiceTask.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[addBehaviour](ServiceTask.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[validate](ServiceTask.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[doEvent](ServiceTask.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[setInput](ServiceTask.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[getInput](ServiceTask.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[getOutput](ServiceTask.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[enter](ServiceTask.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[execute](ServiceTask.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[continue](ServiceTask.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[start](ServiceTask.md#start) + +#### Defined in + +[elements/Node.ts:217](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L217) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[cancelEBG](ServiceTask.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[cancelBoundaryEvents](ServiceTask.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[end](ServiceTask.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[resume](ServiceTask.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[init](ServiceTask.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[getOutbounds](ServiceTask.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[startBoundaryEvents](ServiceTask.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[describe](ServiceTask.md#describe) + +#### Defined in + +[elements/Tasks.ts:94](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L94) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[ServiceTask](ServiceTask.md).[run](ServiceTask.md#run) + +#### Defined in + +[elements/Tasks.ts:105](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L105) diff --git a/docs/api/classes/CacheManager.md b/docs/api/classes/CacheManager.md new file mode 100644 index 00000000..5a688c02 --- /dev/null +++ b/docs/api/classes/CacheManager.md @@ -0,0 +1,360 @@ +[bpmn-server](../API.md) / CacheManager + +# Class: CacheManager + +super class for various objects that are part of the server + +## Hierarchy + +- [`ServerComponent`](ServerComponent.md) + + ↳ **`CacheManager`** + +## Implements + +- [`ICacheManager`](../interfaces/ICacheManager.md) + +## Table of contents + +### Constructors + +- [constructor](CacheManager.md#constructor) + +### Properties + +- [liveInstances](CacheManager.md#liveinstances) +- [server](CacheManager.md#server) + +### Accessors + +- [configuration](CacheManager.md#configuration) +- [logger](CacheManager.md#logger) +- [cron](CacheManager.md#cron) +- [cache](CacheManager.md#cache) +- [appDelegate](CacheManager.md#appdelegate) +- [engine](CacheManager.md#engine) +- [dataStore](CacheManager.md#datastore) +- [definitions](CacheManager.md#definitions) +- [listener](CacheManager.md#listener) + +### Methods + +- [list](CacheManager.md#list) +- [getInstance](CacheManager.md#getinstance) +- [add](CacheManager.md#add) +- [remove](CacheManager.md#remove) +- [shutdown](CacheManager.md#shutdown) + +## Constructors + +### constructor + +• **new CacheManager**(`server`): [`CacheManager`](CacheManager.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Overrides + +[ServerComponent](ServerComponent.md).[constructor](ServerComponent.md#constructor) + +#### Defined in + +[server/CacheManager.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L32) + +## Properties + +### liveInstances + +▪ `Static` **liveInstances**: `Map`\<`any`, `any`\> + +#### Defined in + +[server/CacheManager.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L30) + +___ + +### server + +• **server**: `any` + +#### Inherited from + +[ServerComponent](ServerComponent.md).[server](ServerComponent.md#server) + +#### Defined in + +[server/ServerComponent.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L9) + +## Accessors + +### configuration + +• `get` **configuration**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.configuration + +#### Defined in + +[server/ServerComponent.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L14) + +___ + +### logger + +• `get` **logger**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.logger + +#### Defined in + +[server/ServerComponent.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L15) + +___ + +### cron + +• `get` **cron**(): [`Cron`](Cron.md) + +#### Returns + +[`Cron`](Cron.md) + +#### Inherited from + +ServerComponent.cron + +#### Defined in + +[server/ServerComponent.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L16) + +___ + +### cache + +• `get` **cache**(): [`CacheManager`](CacheManager.md) + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Inherited from + +ServerComponent.cache + +#### Defined in + +[server/ServerComponent.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L17) + +___ + +### appDelegate + +• `get` **appDelegate**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.appDelegate + +#### Defined in + +[server/ServerComponent.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L18) + +___ + +### engine + +• `get` **engine**(): [`IEngine`](../interfaces/IEngine.md) + +#### Returns + +[`IEngine`](../interfaces/IEngine.md) + +#### Inherited from + +ServerComponent.engine + +#### Defined in + +[server/ServerComponent.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L19) + +___ + +### dataStore + +• `get` **dataStore**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.dataStore + +#### Defined in + +[server/ServerComponent.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L20) + +___ + +### definitions + +• `get` **definitions**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.definitions + +#### Defined in + +[server/ServerComponent.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L21) + +___ + +### listener + +• `get` **listener**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.listener + +#### Defined in + +[server/ServerComponent.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L22) + +## Methods + +### list + +▸ **list**(): `any`[] + +#### Returns + +`any`[] + +#### Implementation of + +[ICacheManager](../interfaces/ICacheManager.md).[list](../interfaces/ICacheManager.md#list) + +#### Defined in + +[server/CacheManager.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L44) + +___ + +### getInstance + +▸ **getInstance**(`instanceId`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | + +#### Returns + +`any` + +#### Defined in + +[server/CacheManager.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L52) + +___ + +### add + +▸ **add**(`execution`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`IExecution`](../interfaces/IExecution.md) | + +#### Returns + +`void` + +#### Implementation of + +[ICacheManager](../interfaces/ICacheManager.md).[add](../interfaces/ICacheManager.md#add) + +#### Defined in + +[server/CacheManager.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L58) + +___ + +### remove + +▸ **remove**(`instanceId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[ICacheManager](../interfaces/ICacheManager.md).[remove](../interfaces/ICacheManager.md#remove) + +#### Defined in + +[server/CacheManager.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L62) + +___ + +### shutdown + +▸ **shutdown**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[ICacheManager](../interfaces/ICacheManager.md).[shutdown](../interfaces/ICacheManager.md#shutdown) + +#### Defined in + +[server/CacheManager.ts:66](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L66) diff --git a/docs/api/classes/CallActivity.md b/docs/api/classes/CallActivity.md new file mode 100644 index 00000000..37a22263 --- /dev/null +++ b/docs/api/classes/CallActivity.md @@ -0,0 +1,1052 @@ +[bpmn-server](../API.md) / CallActivity + +# Class: CallActivity + + + +the called process need to call me back when done. + + Scenario + a process 'D1' element 'E' is a 'CallActivity' calling Definition 'D2' +steps: + + 1. Item 'E': item start: start event is fired to prepare for input + 2. Item 'E': item start: executing the call process passing input + 3. If Process 'D2' is completed immediatly + we continue, skip next steps + * 4. Process 'D1' goes on a wait state + 5. When the process 'D2' is completed it calls 'executionEnded' + 6. We continue with Item:Invoke + 7. event 'end' is fired to handle output of the process + +## Hierarchy + +- [`Node`](Node.md) + + ↳ **`CallActivity`** + +## Table of contents + +### Constructors + +- [constructor](CallActivity.md#constructor) + +### Properties + +- [id](CallActivity.md#id) +- [type](CallActivity.md#type) +- [subType](CallActivity.md#subtype) +- [behaviours](CallActivity.md#behaviours) +- [isFlow](CallActivity.md#isflow) +- [lane](CallActivity.md#lane) +- [name](CallActivity.md#name) +- [process](CallActivity.md#process) +- [def](CallActivity.md#def) +- [outbounds](CallActivity.md#outbounds) +- [inbounds](CallActivity.md#inbounds) +- [attachments](CallActivity.md#attachments) +- [attachedTo](CallActivity.md#attachedto) +- [messageId](CallActivity.md#messageid) +- [signalId](CallActivity.md#signalid) +- [initiator](CallActivity.md#initiator) +- [assignee](CallActivity.md#assignee) +- [candidateGroups](CallActivity.md#candidategroups) +- [candidateUsers](CallActivity.md#candidateusers) +- [scripts](CallActivity.md#scripts) + +### Accessors + +- [processId](CallActivity.md#processid) +- [isCatching](CallActivity.md#iscatching) +- [calledElement](CallActivity.md#calledelement) +- [requiresWait](CallActivity.md#requireswait) +- [canBeInvoked](CallActivity.md#canbeinvoked) + +### Methods + +- [restored](CallActivity.md#restored) +- [hasBehaviour](CallActivity.md#hasbehaviour) +- [getBehaviour](CallActivity.md#getbehaviour) +- [addBehaviour](CallActivity.md#addbehaviour) +- [validate](CallActivity.md#validate) +- [doEvent](CallActivity.md#doevent) +- [setInput](CallActivity.md#setinput) +- [getInput](CallActivity.md#getinput) +- [getOutput](CallActivity.md#getoutput) +- [enter](CallActivity.md#enter) +- [execute](CallActivity.md#execute) +- [continue](CallActivity.md#continue) +- [run](CallActivity.md#run) +- [cancelEBG](CallActivity.md#cancelebg) +- [cancelBoundaryEvents](CallActivity.md#cancelboundaryevents) +- [end](CallActivity.md#end) +- [resume](CallActivity.md#resume) +- [init](CallActivity.md#init) +- [getOutbounds](CallActivity.md#getoutbounds) +- [startBoundaryEvents](CallActivity.md#startboundaryevents) +- [describe](CallActivity.md#describe) +- [executionEnded](CallActivity.md#executionended) +- [start](CallActivity.md#start) + +## Constructors + +### constructor + +• **new CallActivity**(`id`, `process`, `type`, `def`): [`CallActivity`](CallActivity.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`CallActivity`](CallActivity.md) + +#### Inherited from + +[Node](Node.md).[constructor](Node.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Node](Node.md).[id](Node.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Node](Node.md).[type](Node.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Node](Node.md).[subType](Node.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[behaviours](Node.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Node](Node.md).[isFlow](Node.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Node](Node.md).[lane](Node.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Node](Node.md).[name](Node.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Node](Node.md).[process](Node.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Node](Node.md).[def](Node.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[outbounds](Node.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[inbounds](Node.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Node](Node.md).[attachments](Node.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Node](Node.md).[attachedTo](Node.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Node](Node.md).[messageId](Node.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Node](Node.md).[signalId](Node.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Node](Node.md).[initiator](Node.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Node](Node.md).[assignee](Node.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Node](Node.md).[candidateGroups](Node.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Node](Node.md).[candidateUsers](Node.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[scripts](Node.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Node.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +___ + +### calledElement + +• `get` **calledElement**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/Tasks.ts:274](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L274) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.requiresWait + +#### Defined in + +[elements/Tasks.ts:278](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L278) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.canBeInvoked + +#### Defined in + +[elements/Tasks.ts:279](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L279) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[restored](Node.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Node](Node.md).[hasBehaviour](Node.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Node](Node.md).[getBehaviour](Node.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[addBehaviour](Node.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[validate](Node.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Node](Node.md).[doEvent](Node.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[setInput](Node.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getInput](Node.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getOutput](Node.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[enter](Node.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Node](Node.md).[execute](Node.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[continue](Node.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Node](Node.md).[run](Node.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelEBG](Node.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelBoundaryEvents](Node.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[end](Node.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[resume](Node.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[init](Node.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Node](Node.md).[getOutbounds](Node.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[startBoundaryEvents](Node.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Node](Node.md).[describe](Node.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) + +___ + +### executionEnded + +▸ **executionEnded**(`execution`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`IExecution`](../interfaces/IExecution.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Tasks.ts:281](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L281) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Node](Node.md).[start](Node.md#start) + +#### Defined in + +[elements/Tasks.ts:287](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L287) diff --git a/docs/api/classes/CamundaFormData.md b/docs/api/classes/CamundaFormData.md new file mode 100644 index 00000000..7664fe2f --- /dev/null +++ b/docs/api/classes/CamundaFormData.md @@ -0,0 +1,375 @@ +[bpmn-server](../API.md) / CamundaFormData + +# Class: CamundaFormData + +Behaviour + ioSpecification + timer + message + signal + + each behaviour is a class + it scans def and insert itself to perform actions as required + +## Hierarchy + +- [`Behaviour`](Behaviour.md) + + ↳ **`CamundaFormData`** + +## Table of contents + +### Constructors + +- [constructor](CamundaFormData.md#constructor) + +### Properties + +- [node](CamundaFormData.md#node) +- [definition](CamundaFormData.md#definition) +- [fields](CamundaFormData.md#fields) + +### Methods + +- [restored](CamundaFormData.md#restored) +- [enter](CamundaFormData.md#enter) +- [start](CamundaFormData.md#start) +- [run](CamundaFormData.md#run) +- [end](CamundaFormData.md#end) +- [exit](CamundaFormData.md#exit) +- [resume](CamundaFormData.md#resume) +- [getNodeAttributes](CamundaFormData.md#getnodeattributes) +- [getItemAttributes](CamundaFormData.md#getitemattributes) +- [init](CamundaFormData.md#init) +- [getFields](CamundaFormData.md#getfields) +- [describe](CamundaFormData.md#describe) + +## Constructors + +### constructor + +• **new CamundaFormData**(`node`, `definition`): [`CamundaFormData`](CamundaFormData.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `definition` | `any` | + +#### Returns + +[`CamundaFormData`](CamundaFormData.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[constructor](Behaviour.md#constructor) + +#### Defined in + +[elements/behaviours/Behaviour.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L40) + +## Properties + +### node + +• **node**: [`Node`](Node.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[node](Behaviour.md#node) + +#### Defined in + +[elements/behaviours/Behaviour.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L38) + +___ + +### definition + +• **definition**: `any` + +#### Inherited from + +[Behaviour](Behaviour.md).[definition](Behaviour.md#definition) + +#### Defined in + +[elements/behaviours/Behaviour.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L39) + +___ + +### fields + +• **fields**: `any` + +#### Defined in + +[elements/behaviours/Form.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Form.ts#L10) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[restored](Behaviour.md#restored) + +#### Defined in + +[elements/behaviours/Behaviour.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L45) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[enter](Behaviour.md#enter) + +#### Defined in + +[elements/behaviours/Behaviour.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L48) + +___ + +### start + +▸ **start**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[start](Behaviour.md#start) + +#### Defined in + +[elements/behaviours/Behaviour.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L49) + +___ + +### run + +▸ **run**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[run](Behaviour.md#run) + +#### Defined in + +[elements/behaviours/Behaviour.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L50) + +___ + +### end + +▸ **end**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[end](Behaviour.md#end) + +#### Defined in + +[elements/behaviours/Behaviour.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L51) + +___ + +### exit + +▸ **exit**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[exit](Behaviour.md#exit) + +#### Defined in + +[elements/behaviours/Behaviour.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L52) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[resume](Behaviour.md#resume) + +#### Defined in + +[elements/behaviours/Behaviour.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L53) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getNodeAttributes](Behaviour.md#getnodeattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L54) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getItemAttributes](Behaviour.md#getitemattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L55) + +___ + +### init + +▸ **init**(): `void` + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[init](Behaviour.md#init) + +#### Defined in + +[elements/behaviours/Form.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Form.ts#L11) + +___ + +### getFields + +▸ **getFields**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Form.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Form.ts#L17) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Overrides + +[Behaviour](Behaviour.md).[describe](Behaviour.md#describe) + +#### Defined in + +[elements/behaviours/Form.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Form.ts#L18) diff --git a/docs/api/classes/CatchEvent.md b/docs/api/classes/CatchEvent.md new file mode 100644 index 00000000..2aaec733 --- /dev/null +++ b/docs/api/classes/CatchEvent.md @@ -0,0 +1,1058 @@ +[bpmn-server](../API.md) / CatchEvent + +# Class: CatchEvent + +## Hierarchy + +- [`Event`](Event.md) + + ↳ **`CatchEvent`** + +## Table of contents + +### Constructors + +- [constructor](CatchEvent.md#constructor) + +### Properties + +- [id](CatchEvent.md#id) +- [type](CatchEvent.md#type) +- [subType](CatchEvent.md#subtype) +- [behaviours](CatchEvent.md#behaviours) +- [isFlow](CatchEvent.md#isflow) +- [lane](CatchEvent.md#lane) +- [name](CatchEvent.md#name) +- [process](CatchEvent.md#process) +- [def](CatchEvent.md#def) +- [outbounds](CatchEvent.md#outbounds) +- [inbounds](CatchEvent.md#inbounds) +- [attachments](CatchEvent.md#attachments) +- [attachedTo](CatchEvent.md#attachedto) +- [messageId](CatchEvent.md#messageid) +- [signalId](CatchEvent.md#signalid) +- [initiator](CatchEvent.md#initiator) +- [assignee](CatchEvent.md#assignee) +- [candidateGroups](CatchEvent.md#candidategroups) +- [candidateUsers](CatchEvent.md#candidateusers) +- [scripts](CatchEvent.md#scripts) + +### Accessors + +- [isCatching](CatchEvent.md#iscatching) +- [requiresWait](CatchEvent.md#requireswait) +- [canBeInvoked](CatchEvent.md#canbeinvoked) +- [processId](CatchEvent.md#processid) + +### Methods + +- [restored](CatchEvent.md#restored) +- [hasBehaviour](CatchEvent.md#hasbehaviour) +- [getBehaviour](CatchEvent.md#getbehaviour) +- [addBehaviour](CatchEvent.md#addbehaviour) +- [hasMessage](CatchEvent.md#hasmessage) +- [hasSignal](CatchEvent.md#hassignal) +- [hasTimer](CatchEvent.md#hastimer) +- [end](CatchEvent.md#end) +- [start](CatchEvent.md#start) +- [validate](CatchEvent.md#validate) +- [doEvent](CatchEvent.md#doevent) +- [setInput](CatchEvent.md#setinput) +- [getInput](CatchEvent.md#getinput) +- [getOutput](CatchEvent.md#getoutput) +- [enter](CatchEvent.md#enter) +- [execute](CatchEvent.md#execute) +- [continue](CatchEvent.md#continue) +- [run](CatchEvent.md#run) +- [cancelEBG](CatchEvent.md#cancelebg) +- [cancelBoundaryEvents](CatchEvent.md#cancelboundaryevents) +- [resume](CatchEvent.md#resume) +- [init](CatchEvent.md#init) +- [getOutbounds](CatchEvent.md#getoutbounds) +- [startBoundaryEvents](CatchEvent.md#startboundaryevents) +- [describe](CatchEvent.md#describe) + +## Constructors + +### constructor + +• **new CatchEvent**(`id`, `process`, `type`, `def`): [`CatchEvent`](CatchEvent.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`CatchEvent`](CatchEvent.md) + +#### Inherited from + +[Event](Event.md).[constructor](Event.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Event](Event.md).[id](Event.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Event](Event.md).[type](Event.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Event](Event.md).[subType](Event.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[behaviours](Event.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Event](Event.md).[isFlow](Event.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Event](Event.md).[lane](Event.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Event](Event.md).[name](Event.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Event](Event.md).[process](Event.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Event](Event.md).[def](Event.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[outbounds](Event.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[inbounds](Event.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Event](Event.md).[attachments](Event.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Event](Event.md).[attachedTo](Event.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Event](Event.md).[messageId](Event.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Event](Event.md).[signalId](Event.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Event](Event.md).[initiator](Event.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Event](Event.md).[assignee](Event.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Event](Event.md).[candidateGroups](Event.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Event](Event.md).[candidateUsers](Event.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[scripts](Event.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Event.isCatching + +#### Defined in + +[elements/Events.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L38) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Event.requiresWait + +#### Defined in + +[elements/Events.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L40) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Event.canBeInvoked + +#### Defined in + +[elements/Events.ts:43](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L43) + +___ + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Event.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[restored](Event.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Event](Event.md).[hasBehaviour](Event.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[getBehaviour](Event.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[addBehaviour](Event.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### hasMessage + +▸ **hasMessage**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasMessage](Event.md#hasmessage) + +#### Defined in + +[elements/Events.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L9) + +___ + +### hasSignal + +▸ **hasSignal**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasSignal](Event.md#hassignal) + +#### Defined in + +[elements/Events.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L12) + +___ + +### hasTimer + +▸ **hasTimer**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasTimer](Event.md#hastimer) + +#### Defined in + +[elements/Events.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L15) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[end](Event.md#end) + +#### Defined in + +[elements/Events.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L28) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +using token: check if fromEventBasedGateway; if yes cancel all other events + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Event](Event.md).[start](Event.md#start) + +#### Defined in + +[elements/Events.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L47) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[validate](Event.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Event](Event.md).[doEvent](Event.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[setInput](Event.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getInput](Event.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getOutput](Event.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[enter](Event.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Event](Event.md).[execute](Event.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[continue](Event.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Event](Event.md).[run](Event.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelEBG](Event.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelBoundaryEvents](Event.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[resume](Event.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[init](Event.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Event](Event.md).[getOutbounds](Event.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[startBoundaryEvents](Event.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Event](Event.md).[describe](Event.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/Configuration.md b/docs/api/classes/Configuration.md new file mode 100644 index 00000000..83f530c9 --- /dev/null +++ b/docs/api/classes/Configuration.md @@ -0,0 +1,292 @@ +[bpmn-server](../API.md) / Configuration + +# Class: Configuration + +## Implements + +- [`IConfiguration`](../interfaces/IConfiguration.md) + +## Table of contents + +### Constructors + +- [constructor](Configuration.md#constructor) + +### Properties + +- [definitionsPath](Configuration.md#definitionspath) +- [templatesPath](Configuration.md#templatespath) +- [timers](Configuration.md#timers) +- [database](Configuration.md#database) +- [logger](Configuration.md#logger) +- [apiKey](Configuration.md#apikey) +- [sendGridAPIKey](Configuration.md#sendgridapikey) + +### Methods + +- [definitions](Configuration.md#definitions) +- [appDelegate](Configuration.md#appdelegate) +- [dataStore](Configuration.md#datastore) +- [cacheManager](Configuration.md#cachemanager) +- [userService](Configuration.md#userservice) + +## Constructors + +### constructor + +• **new Configuration**(`«destructured»`): [`Configuration`](Configuration.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `definitionsPath` | `any` | +| › `templatesPath` | `any` | +| › `timers` | `any` | +| › `database` | `any` | +| › `apiKey` | `any` | +| › `logger` | `any` | +| › `definitions` | `any` | +| › `appDelegate` | `any` | +| › `dataStore` | `any` | +| › `cacheManager` | `any` | +| › `userService` | `any` | + +#### Returns + +[`Configuration`](Configuration.md) + +#### Defined in + +[common/DefaultConfiguration.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L39) + +## Properties + +### definitionsPath + +• **definitionsPath**: `string` + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[definitionsPath](../interfaces/IConfiguration.md#definitionspath) + +#### Defined in + +[common/DefaultConfiguration.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L12) + +___ + +### templatesPath + +• **templatesPath**: `string` + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[templatesPath](../interfaces/IConfiguration.md#templatespath) + +#### Defined in + +[common/DefaultConfiguration.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L13) + +___ + +### timers + +• **timers**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `forceTimersDelay` | `number` | +| `precision` | `number` | + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[timers](../interfaces/IConfiguration.md#timers) + +#### Defined in + +[common/DefaultConfiguration.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L14) + +___ + +### database + +• **database**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `MongoDB` | \{ `db_url`: `string` ; `db`: `string` } | +| `MongoDB.db_url` | `string` | +| `MongoDB.db` | `string` | +| `loopbackRepositories?` | `any` | + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[database](../interfaces/IConfiguration.md#database) + +#### Defined in + +[common/DefaultConfiguration.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L15) + +___ + +### logger + +• **logger**: [`ILogger`](../interfaces/ILogger.md) + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[logger](../interfaces/IConfiguration.md#logger) + +#### Defined in + +[common/DefaultConfiguration.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L19) + +___ + +### apiKey + +• **apiKey**: `string` + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[apiKey](../interfaces/IConfiguration.md#apikey) + +#### Defined in + +[common/DefaultConfiguration.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L20) + +___ + +### sendGridAPIKey + +• **sendGridAPIKey**: `string` + +#### Defined in + +[common/DefaultConfiguration.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L21) + +## Methods + +### definitions + +▸ **definitions**(`server`): [`ModelsDatastore`](ModelsDatastore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`ModelsDatastore`](ModelsDatastore.md) + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[definitions](../interfaces/IConfiguration.md#definitions) + +#### Defined in + +[common/DefaultConfiguration.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L22) + +___ + +### appDelegate + +▸ **appDelegate**(`server`): [`IAppDelegate`](../interfaces/IAppDelegate.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`IAppDelegate`](../interfaces/IAppDelegate.md) + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[appDelegate](../interfaces/IConfiguration.md#appdelegate) + +#### Defined in + +[common/DefaultConfiguration.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L25) + +___ + +### dataStore + +▸ **dataStore**(`server`): [`DataStore`](DataStore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`DataStore`](DataStore.md) + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[dataStore](../interfaces/IConfiguration.md#datastore) + +#### Defined in + +[common/DefaultConfiguration.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L28) + +___ + +### cacheManager + +▸ **cacheManager**(`server`): [`NoCacheManager`](NoCacheManager.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`NoCacheManager`](NoCacheManager.md) + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[cacheManager](../interfaces/IConfiguration.md#cachemanager) + +#### Defined in + +[common/DefaultConfiguration.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L31) + +___ + +### userService + +▸ **userService**(`server`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +`any` + +#### Implementation of + +[IConfiguration](../interfaces/IConfiguration.md).[userService](../interfaces/IConfiguration.md#userservice) + +#### Defined in + +[common/DefaultConfiguration.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L34) diff --git a/docs/api/classes/Cron.md b/docs/api/classes/Cron.md new file mode 100644 index 00000000..7524bb37 --- /dev/null +++ b/docs/api/classes/Cron.md @@ -0,0 +1,494 @@ +[bpmn-server](../API.md) / Cron + +# Class: Cron + +super class for various objects that are part of the server + +## Hierarchy + +- [`ServerComponent`](ServerComponent.md) + + ↳ **`Cron`** + +## Implements + +- [`ICron`](../interfaces/ICron.md) + +## Table of contents + +### Constructors + +- [constructor](Cron.md#constructor) + +### Properties + +- [timersStarted](Cron.md#timersstarted) +- [checkingTimers](Cron.md#checkingtimers) +- [timersFired](Cron.md#timersfired) +- [server](Cron.md#server) + +### Accessors + +- [configuration](Cron.md#configuration) +- [logger](Cron.md#logger) +- [cron](Cron.md#cron) +- [cache](Cron.md#cache) +- [appDelegate](Cron.md#appdelegate) +- [engine](Cron.md#engine) +- [dataStore](Cron.md#datastore) +- [definitions](Cron.md#definitions) +- [listener](Cron.md#listener) + +### Methods + +- [timerScheduled](Cron.md#timerscheduled) +- [timerEnded](Cron.md#timerended) +- [checkTimers](Cron.md#checktimers) +- [start](Cron.md#start) +- [startTimers](Cron.md#starttimers) +- [itemTimerExpired](Cron.md#itemtimerexpired) +- [processTimerExpired](Cron.md#processtimerexpired) +- [scheduleProcess](Cron.md#scheduleprocess) +- [scheduleItem](Cron.md#scheduleitem) +- [checkCron](Cron.md#checkcron) +- [timeDue](Cron.md#timedue) + +## Constructors + +### constructor + +• **new Cron**(`server`): [`Cron`](Cron.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | [`IBPMNServer`](../interfaces/IBPMNServer.md) | + +#### Returns + +[`Cron`](Cron.md) + +#### Inherited from + +[ServerComponent](ServerComponent.md).[constructor](ServerComponent.md#constructor) + +#### Defined in + +[server/ServerComponent.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L10) + +## Properties + +### timersStarted + +▪ `Static` `Private` **timersStarted**: `boolean` = `false` + +#### Defined in + +[server/Cron.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L15) + +___ + +### checkingTimers + +▪ `Static` `Private` **checkingTimers**: `boolean` = `false` + +#### Defined in + +[server/Cron.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L16) + +___ + +### timersFired + +▪ `Static` `Private` **timersFired**: `number` = `0` + +#### Defined in + +[server/Cron.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L17) + +___ + +### server + +• **server**: `any` + +#### Inherited from + +[ServerComponent](ServerComponent.md).[server](ServerComponent.md#server) + +#### Defined in + +[server/ServerComponent.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L9) + +## Accessors + +### configuration + +• `get` **configuration**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.configuration + +#### Defined in + +[server/ServerComponent.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L14) + +___ + +### logger + +• `get` **logger**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.logger + +#### Defined in + +[server/ServerComponent.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L15) + +___ + +### cron + +• `get` **cron**(): [`Cron`](Cron.md) + +#### Returns + +[`Cron`](Cron.md) + +#### Inherited from + +ServerComponent.cron + +#### Defined in + +[server/ServerComponent.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L16) + +___ + +### cache + +• `get` **cache**(): [`CacheManager`](CacheManager.md) + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Inherited from + +ServerComponent.cache + +#### Defined in + +[server/ServerComponent.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L17) + +___ + +### appDelegate + +• `get` **appDelegate**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.appDelegate + +#### Defined in + +[server/ServerComponent.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L18) + +___ + +### engine + +• `get` **engine**(): [`IEngine`](../interfaces/IEngine.md) + +#### Returns + +[`IEngine`](../interfaces/IEngine.md) + +#### Inherited from + +ServerComponent.engine + +#### Defined in + +[server/ServerComponent.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L19) + +___ + +### dataStore + +• `get` **dataStore**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.dataStore + +#### Defined in + +[server/ServerComponent.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L20) + +___ + +### definitions + +• `get` **definitions**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.definitions + +#### Defined in + +[server/ServerComponent.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L21) + +___ + +### listener + +• `get` **listener**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.listener + +#### Defined in + +[server/ServerComponent.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L22) + +## Methods + +### timerScheduled + +▸ **timerScheduled**(`timeDue`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `timeDue` | `any` | + +#### Returns + +`void` + +#### Defined in + +[server/Cron.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L19) + +___ + +### timerEnded + +▸ **timerEnded**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Defined in + +[server/Cron.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L22) + +___ + +### checkTimers + +▸ **checkTimers**(`duration?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `duration` | `number` | `0` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[ICron](../interfaces/ICron.md).[checkTimers](../interfaces/ICron.md#checktimers) + +#### Defined in + +[server/Cron.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L26) + +___ + +### start + +▸ **start**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[ICron](../interfaces/ICron.md).[start](../interfaces/ICron.md#start) + +#### Defined in + +[server/Cron.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L29) + +___ + +### startTimers + +▸ **startTimers**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[ICron](../interfaces/ICron.md).[startTimers](../interfaces/ICron.md#starttimers) + +#### Defined in + +[server/Cron.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L32) + +___ + +### itemTimerExpired + +▸ **itemTimerExpired**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[server/Cron.ts:89](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L89) + +___ + +### processTimerExpired + +▸ **processTimerExpired**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[server/Cron.ts:93](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L93) + +___ + +### scheduleProcess + +▸ **scheduleProcess**(`entry`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `entry` | `any` | + +#### Returns + +`void` + +#### Defined in + +[server/Cron.ts:105](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L105) + +___ + +### scheduleItem + +▸ **scheduleItem**(`entry`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `entry` | `any` | + +#### Returns + +`void` + +#### Defined in + +[server/Cron.ts:118](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L118) + +___ + +### checkCron + +▸ **checkCron**(`expression`, `referenceDateTime`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `expression` | `any` | +| `referenceDateTime` | `any` | + +#### Returns + +`number` + +#### Defined in + +[server/Cron.ts:128](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L128) + +___ + +### timeDue + +▸ **timeDue**(`expression`, `referenceDateTime`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `expression` | `any` | +| `referenceDateTime` | `any` | + +#### Returns + +`any` + +#### Defined in + +[server/Cron.ts:147](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Cron.ts#L147) diff --git a/docs/api/classes/DataStore.md b/docs/api/classes/DataStore.md new file mode 100644 index 00000000..ecf42682 --- /dev/null +++ b/docs/api/classes/DataStore.md @@ -0,0 +1,669 @@ +[bpmn-server](../API.md) / DataStore + +# Class: DataStore + +super class for various objects that are part of the server + +## Hierarchy + +- [`ServerComponent`](ServerComponent.md) + + ↳ **`DataStore`** + +## Implements + +- [`IDataStore`](../interfaces/IDataStore.md) + +## Table of contents + +### Constructors + +- [constructor](DataStore.md#constructor) + +### Properties + +- [dbConfiguration](DataStore.md#dbconfiguration) +- [db](DataStore.md#db) +- [execution](DataStore.md#execution) +- [isModified](DataStore.md#ismodified) +- [isRunning](DataStore.md#isrunning) +- [inSaving](DataStore.md#insaving) +- [promises](DataStore.md#promises) +- [locker](DataStore.md#locker) +- [seq](DataStore.md#seq) +- [server](DataStore.md#server) + +### Accessors + +- [configuration](DataStore.md#configuration) +- [logger](DataStore.md#logger) +- [cron](DataStore.md#cron) +- [cache](DataStore.md#cache) +- [appDelegate](DataStore.md#appdelegate) +- [engine](DataStore.md#engine) +- [dataStore](DataStore.md#datastore) +- [definitions](DataStore.md#definitions) +- [listener](DataStore.md#listener) + +### Methods + +- [save](DataStore.md#save) +- [loadInstance](DataStore.md#loadinstance) +- [getItemsFromInstances](DataStore.md#getitemsfrominstances) +- [saveInstance](DataStore.md#saveinstance) +- [findItem](DataStore.md#finditem) +- [findInstance](DataStore.md#findinstance) +- [convertObj](DataStore.md#convertobj) +- [convertColl](DataStore.md#convertcoll) +- [findInstances](DataStore.md#findinstances) +- [findItems](DataStore.md#finditems) +- [deleteInstances](DataStore.md#deleteinstances) +- [install](DataStore.md#install) + +## Constructors + +### constructor + +• **new DataStore**(`server`): [`DataStore`](DataStore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | [`IBPMNServer`](../interfaces/IBPMNServer.md) | + +#### Returns + +[`DataStore`](DataStore.md) + +#### Overrides + +[ServerComponent](ServerComponent.md).[constructor](ServerComponent.md#constructor) + +#### Defined in + +[datastore/DataStore.ts:33](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L33) + +## Properties + +### dbConfiguration + +• **dbConfiguration**: `any` + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[dbConfiguration](../interfaces/IDataStore.md#dbconfiguration) + +#### Defined in + +[datastore/DataStore.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L23) + +___ + +### db + +• **db**: `any` + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[db](../interfaces/IDataStore.md#db) + +#### Defined in + +[datastore/DataStore.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L24) + +___ + +### execution + +• **execution**: [`Execution`](Execution.md) + +#### Defined in + +[datastore/DataStore.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L26) + +___ + +### isModified + +• **isModified**: `boolean` = `false` + +#### Defined in + +[datastore/DataStore.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L27) + +___ + +### isRunning + +• **isRunning**: `boolean` = `false` + +#### Defined in + +[datastore/DataStore.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L28) + +___ + +### inSaving + +• **inSaving**: `boolean` = `false` + +#### Defined in + +[datastore/DataStore.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L29) + +___ + +### promises + +• **promises**: `any`[] = `[]` + +#### Defined in + +[datastore/DataStore.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L30) + +___ + +### locker + +• **locker**: `any` + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[locker](../interfaces/IDataStore.md#locker) + +#### Defined in + +[datastore/DataStore.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L31) + +___ + +### seq + +▪ `Static` **seq**: `number` = `0` + +#### Defined in + +[datastore/DataStore.ts:89](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L89) + +___ + +### server + +• **server**: `any` + +#### Inherited from + +[ServerComponent](ServerComponent.md).[server](ServerComponent.md#server) + +#### Defined in + +[server/ServerComponent.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L9) + +## Accessors + +### configuration + +• `get` **configuration**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.configuration + +#### Defined in + +[server/ServerComponent.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L14) + +___ + +### logger + +• `get` **logger**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[logger](../interfaces/IDataStore.md#logger) + +#### Inherited from + +ServerComponent.logger + +#### Defined in + +[server/ServerComponent.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L15) + +___ + +### cron + +• `get` **cron**(): [`Cron`](Cron.md) + +#### Returns + +[`Cron`](Cron.md) + +#### Inherited from + +ServerComponent.cron + +#### Defined in + +[server/ServerComponent.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L16) + +___ + +### cache + +• `get` **cache**(): [`CacheManager`](CacheManager.md) + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Inherited from + +ServerComponent.cache + +#### Defined in + +[server/ServerComponent.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L17) + +___ + +### appDelegate + +• `get` **appDelegate**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.appDelegate + +#### Defined in + +[server/ServerComponent.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L18) + +___ + +### engine + +• `get` **engine**(): [`IEngine`](../interfaces/IEngine.md) + +#### Returns + +[`IEngine`](../interfaces/IEngine.md) + +#### Inherited from + +ServerComponent.engine + +#### Defined in + +[server/ServerComponent.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L19) + +___ + +### dataStore + +• `get` **dataStore**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.dataStore + +#### Defined in + +[server/ServerComponent.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L20) + +___ + +### definitions + +• `get` **definitions**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.definitions + +#### Defined in + +[server/ServerComponent.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L21) + +___ + +### listener + +• `get` **listener**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.listener + +#### Defined in + +[server/ServerComponent.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L22) + +## Methods + +### save + +▸ **save**(`instance`, `options?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[save](../interfaces/IDataStore.md#save) + +#### Defined in + +[datastore/DataStore.ts:46](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L46) + +___ + +### loadInstance + +▸ **loadInstance**(`instanceId`, `options?`): `Promise`\<\{ `instance`: [`IInstanceData`](../interfaces/IInstanceData.md) = instanceData; `items`: `any`[] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<\{ `instance`: [`IInstanceData`](../interfaces/IInstanceData.md) = instanceData; `items`: `any`[] }\> + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[loadInstance](../interfaces/IDataStore.md#loadinstance) + +#### Defined in + +[datastore/DataStore.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L49) + +___ + +### getItemsFromInstances + +▸ **getItemsFromInstances**(`instances`, `condition?`, `trans?`): `any`[] + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `instances` | `any` | `undefined` | +| `condition` | `any` | `null` | +| `trans` | `any` | `null` | + +#### Returns + +`any`[] + +#### Defined in + +[datastore/DataStore.ts:67](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L67) + +___ + +### saveInstance + +▸ **saveInstance**(`instance`, `options?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[datastore/DataStore.ts:90](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L90) + +___ + +### findItem + +▸ **findItem**(`query`): `Promise`\<[`IItemData`](../interfaces/IItemData.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`Promise`\<[`IItemData`](../interfaces/IItemData.md)\> + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[findItem](../interfaces/IDataStore.md#finditem) + +#### Defined in + +[datastore/DataStore.ts:132](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L132) + +___ + +### findInstance + +▸ **findInstance**(`query`, `options`): `Promise`\<[`IInstanceData`](../interfaces/IInstanceData.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `options` | `any` | + +#### Returns + +`Promise`\<[`IInstanceData`](../interfaces/IInstanceData.md)\> + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[findInstance](../interfaces/IDataStore.md#findinstance) + +#### Defined in + +[datastore/DataStore.ts:142](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L142) + +___ + +### convertObj + +▸ **convertObj**(`obj`, `cls`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `any` | +| `cls` | `any` | + +#### Returns + +`any` + +#### Defined in + +[datastore/DataStore.ts:163](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L163) + +___ + +### convertColl + +▸ **convertColl**(`coll`, `cls`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `coll` | `any` | +| `cls` | `any` | + +#### Returns + +`void` + +#### Defined in + +[datastore/DataStore.ts:167](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L167) + +___ + +### findInstances + +▸ **findInstances**(`query`, `option?`): `Promise`\<[`IInstanceData`](../interfaces/IInstanceData.md)[]\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `query` | `any` | `undefined` | +| `option` | `any` | `'summary'` | + +#### Returns + +`Promise`\<[`IInstanceData`](../interfaces/IInstanceData.md)[]\> + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[findInstances](../interfaces/IDataStore.md#findinstances) + +#### Defined in + +[datastore/DataStore.ts:177](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L177) + +___ + +### findItems + +▸ **findItems**(`query`): `Promise`\<[`IItemData`](../interfaces/IItemData.md)[]\> + +scenario: + +``` +itemId { items { id : value } } +itemKey { items {key: value } } +instance, task { instance: { id: instanceId }, items: { elementId: value }} +message { items: { messageId: nameofmessage, key: value } {} +status { items: {status: 'wait' } } +custom: { query: query, projection: projection } +``` +New approach: +just like MongoDB +``` +itemId { items { id : value } } +itemKey { items {key: value } } +instance, task { id: instanceId , items.elementId: value } +message { items.messageId: nameofmessage, key: value } {} +status { items.status: 'wait' } } +custom: { query: query, projection: projection } +``` + +Problem with Mongodb: `projection $elematch returns only the first record` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`Promise`\<[`IItemData`](../interfaces/IItemData.md)[]\> + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[findItems](../interfaces/IDataStore.md#finditems) + +#### Defined in + +[datastore/DataStore.ts:215](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L215) + +___ + +### deleteInstances + +▸ **deleteInstances**(`query`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[deleteInstances](../interfaces/IDataStore.md#deleteinstances) + +#### Defined in + +[datastore/DataStore.ts:229](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L229) + +___ + +### install + +▸ **install**(): `Promise`\<`void`\> + +first time installation of DB + +creates a new collection and add an index + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IDataStore](../interfaces/IDataStore.md).[install](../interfaces/IDataStore.md#install) + +#### Defined in + +[datastore/DataStore.ts:242](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/DataStore.ts#L242) diff --git a/docs/api/classes/DefaultAppDelegate.md b/docs/api/classes/DefaultAppDelegate.md new file mode 100644 index 00000000..9cfd0a54 --- /dev/null +++ b/docs/api/classes/DefaultAppDelegate.md @@ -0,0 +1,353 @@ +[bpmn-server](../API.md) / DefaultAppDelegate + +# Class: DefaultAppDelegate + +Application Delegate Object to respond to various events and services: + + 1. receive all events from workflow + 2. receive service calls + 3. receive message and signal calls + 4. execute scripts + +## Implements + +- [`IAppDelegate`](../interfaces/IAppDelegate.md) + +## Table of contents + +### Constructors + +- [constructor](DefaultAppDelegate.md#constructor) + +### Properties + +- [server](DefaultAppDelegate.md#server) + +### Accessors + +- [moddleOptions](DefaultAppDelegate.md#moddleoptions) + +### Methods + +- [getServicesProvider](DefaultAppDelegate.md#getservicesprovider) +- [startUp](DefaultAppDelegate.md#startup) +- [sendEmail](DefaultAppDelegate.md#sendemail) +- [executionStarted](DefaultAppDelegate.md#executionstarted) +- [executionEvent](DefaultAppDelegate.md#executionevent) +- [messageThrown](DefaultAppDelegate.md#messagethrown) +- [issueMessage](DefaultAppDelegate.md#issuemessage) +- [issueSignal](DefaultAppDelegate.md#issuesignal) +- [signalThrown](DefaultAppDelegate.md#signalthrown) +- [serviceCalled](DefaultAppDelegate.md#servicecalled) + +## Constructors + +### constructor + +• **new DefaultAppDelegate**(`server`): [`DefaultAppDelegate`](DefaultAppDelegate.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`DefaultAppDelegate`](DefaultAppDelegate.md) + +#### Defined in + +[engine/DefaultAppDelegate.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L11) + +## Properties + +### server + +• **server**: `any` + +#### Defined in + +[engine/DefaultAppDelegate.ts:8](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L8) + +## Accessors + +### moddleOptions + +• `get` **moddleOptions**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `uri` | `string` | +| `prefix` | `string` | +| `xml` | \{ `tagAlias`: `string` = "lowerCase" } | +| `xml.tagAlias` | `string` | +| `types` | (\{ `name`: `string` = "Task"; `isAbstract`: `boolean` = true; `extends`: `string`[] ; `properties`: \{ `name`: `string` = "result"; `isAttr`: `boolean` = true; `type`: `string` = "String" }[] ; `superClass?`: `undefined` } \| \{ `isAbstract?`: `undefined` = true; `extends?`: `undefined` ; `properties?`: `undefined` ; `name`: `string` = "Output"; `superClass`: `string`[] })[] | + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[moddleOptions](../interfaces/IAppDelegate.md#moddleoptions) + +#### Defined in + +[engine/DefaultAppDelegate.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L29) + +## Methods + +### getServicesProvider + +▸ **getServicesProvider**(`context`): `Promise`\<[`DefaultAppDelegate`](DefaultAppDelegate.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `context` | `any` | + +#### Returns + +`Promise`\<[`DefaultAppDelegate`](DefaultAppDelegate.md)\> + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[getServicesProvider](../interfaces/IAppDelegate.md#getservicesprovider) + +#### Defined in + +[engine/DefaultAppDelegate.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L18) + +___ + +### startUp + +▸ **startUp**(`options`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[startUp](../interfaces/IAppDelegate.md#startup) + +#### Defined in + +[engine/DefaultAppDelegate.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L22) + +___ + +### sendEmail + +▸ **sendEmail**(`to`, `msg`, `body`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `to` | `any` | +| `msg` | `any` | +| `body` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[sendEmail](../interfaces/IAppDelegate.md#sendemail) + +#### Defined in + +[engine/DefaultAppDelegate.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L25) + +___ + +### executionStarted + +▸ **executionStarted**(`execution`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`IExecution`](../interfaces/IExecution.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[executionStarted](../interfaces/IAppDelegate.md#executionstarted) + +#### Defined in + +[engine/DefaultAppDelegate.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L32) + +___ + +### executionEvent + +▸ **executionEvent**(`context`, `event`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `context` | `any` | +| `event` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[engine/DefaultAppDelegate.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L35) + +___ + +### messageThrown + +▸ **messageThrown**(`messageId`, `data`, `messageMatchingKey`, `item`): `Promise`\<`void`\> + +is called when a event throws a message + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `messageId` | `any` | +| `data` | `any` | +| `messageMatchingKey` | `any` | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[messageThrown](../interfaces/IAppDelegate.md#messagethrown) + +#### Defined in + +[engine/DefaultAppDelegate.ts:46](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L46) + +___ + +### issueMessage + +▸ **issueMessage**(`messageId`, `data`): `Promise`\<`void`\> + +is called when an event throws a message that can not be answered by another process + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `messageId` | `any` | +| `data` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[issueMessage](../interfaces/IAppDelegate.md#issuemessage) + +#### Defined in + +[engine/DefaultAppDelegate.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L64) + +___ + +### issueSignal + +▸ **issueSignal**(`signalId`, `data`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signalId` | `any` | +| `data` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[issueSignal](../interfaces/IAppDelegate.md#issuesignal) + +#### Defined in + +[engine/DefaultAppDelegate.ts:67](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L67) + +___ + +### signalThrown + +▸ **signalThrown**(`signalId`, `data`, `messageMatchingKey`, `item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signalId` | `any` | +| `data` | `any` | +| `messageMatchingKey` | `any` | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[signalThrown](../interfaces/IAppDelegate.md#signalthrown) + +#### Defined in + +[engine/DefaultAppDelegate.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L70) + +___ + +### serviceCalled + +▸ **serviceCalled**(`serviceName`, `data`, `item`): `Promise`\<`void`\> + +is called only if the serviceTask has no implementation; otherwise the specified implementation will be called. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `serviceName` | `any` | +| `data` | `any` | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IAppDelegate](../interfaces/IAppDelegate.md).[serviceCalled](../interfaces/IAppDelegate.md#servicecalled) + +#### Defined in + +[engine/DefaultAppDelegate.ts:82](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/DefaultAppDelegate.ts#L82) diff --git a/docs/api/classes/Definition.md b/docs/api/classes/Definition.md new file mode 100644 index 00000000..13d80ed6 --- /dev/null +++ b/docs/api/classes/Definition.md @@ -0,0 +1,356 @@ +[bpmn-server](../API.md) / Definition + +# Class: Definition + +## Implements + +- [`IDefinition`](../interfaces/IDefinition.md) + +## Table of contents + +### Constructors + +- [constructor](Definition.md#constructor) + +### Properties + +- [name](Definition.md#name) +- [processes](Definition.md#processes) +- [rootElements](Definition.md#rootelements) +- [nodes](Definition.md#nodes) +- [flows](Definition.md#flows) +- [source](Definition.md#source) +- [logger](Definition.md#logger) +- [server](Definition.md#server) +- [moddle](Definition.md#moddle) +- [accessRules](Definition.md#accessrules) + +### Methods + +- [loadProcess](Definition.md#loadprocess) +- [load](Definition.md#load) +- [getJson](Definition.md#getjson) +- [getDefinition](Definition.md#getdefinition) +- [getFields](Definition.md#getfields) +- [getStartNodes](Definition.md#getstartnodes) +- [getStartNode](Definition.md#getstartnode) +- [getNodeById](Definition.md#getnodebyid) + +## Constructors + +### constructor + +• **new Definition**(`name`, `source`, `server`): [`Definition`](Definition.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `source` | `string` | +| `server` | [`BPMNServer`](BPMNServer.md) | + +#### Returns + +[`Definition`](Definition.md) + +#### Defined in + +[elements/Definition.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L34) + +## Properties + +### name + +• **name**: `any` + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[name](../interfaces/IDefinition.md#name) + +#### Defined in + +[elements/Definition.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L24) + +___ + +### processes + +• **processes**: `Map`\<`any`, `any`\> + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[processes](../interfaces/IDefinition.md#processes) + +#### Defined in + +[elements/Definition.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L25) + +___ + +### rootElements + +• **rootElements**: `any` + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[rootElements](../interfaces/IDefinition.md#rootelements) + +#### Defined in + +[elements/Definition.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L26) + +___ + +### nodes + +• **nodes**: `Map`\<`any`, `any`\> + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[nodes](../interfaces/IDefinition.md#nodes) + +#### Defined in + +[elements/Definition.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L27) + +___ + +### flows + +• **flows**: `any`[] = `[]` + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[flows](../interfaces/IDefinition.md#flows) + +#### Defined in + +[elements/Definition.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L28) + +___ + +### source + +• **source**: `any` + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[source](../interfaces/IDefinition.md#source) + +#### Defined in + +[elements/Definition.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L29) + +___ + +### logger + +• **logger**: `any` + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[logger](../interfaces/IDefinition.md#logger) + +#### Defined in + +[elements/Definition.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L30) + +___ + +### server + +• **server**: `any` + +#### Defined in + +[elements/Definition.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L31) + +___ + +### moddle + +• **moddle**: `any` + +#### Defined in + +[elements/Definition.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L32) + +___ + +### accessRules + +• **accessRules**: `any`[] = `[]` + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[accessRules](../interfaces/IDefinition.md#accessrules) + +#### Defined in + +[elements/Definition.ts:33](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L33) + +## Methods + +### loadProcess + +▸ **loadProcess**(`definition`, `processElement`, `parentProcess`): [`Process`](Process.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | `any` | +| `processElement` | `any` | +| `parentProcess` | `any` | + +#### Returns + +[`Process`](Process.md) + +#### Defined in + +[elements/Definition.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L44) + +___ + +### load + +▸ **load**(): `Promise`\<`any`\> + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[load](../interfaces/IDefinition.md#load) + +#### Defined in + +[elements/Definition.ts:133](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L133) + +___ + +### getJson + +▸ **getJson**(): `string` + +#### Returns + +`string` + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[getJson](../interfaces/IDefinition.md#getjson) + +#### Defined in + +[elements/Definition.ts:274](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L274) + +___ + +### getDefinition + +▸ **getDefinition**(`source`, `logger`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `any` | +| `logger` | `any` | + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[getDefinition](../interfaces/IDefinition.md#getdefinition) + +#### Defined in + +[elements/Definition.ts:301](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L301) + +___ + +### getFields + +▸ **getFields**(`elementId`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `elementId` | `any` | + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[elements/Definition.ts:314](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L314) + +___ + +### getStartNodes + +▸ **getStartNodes**(`userInvokable?`): `any`[] + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `userInvokable` | `boolean` | `false` | + +#### Returns + +`any`[] + +#### Defined in + +[elements/Definition.ts:325](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L325) + +___ + +### getStartNode + +▸ **getStartNode**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[getStartNode](../interfaces/IDefinition.md#getstartnode) + +#### Defined in + +[elements/Definition.ts:336](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L336) + +___ + +### getNodeById + +▸ **getNodeById**(`id`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | + +#### Returns + +`any` + +#### Implementation of + +[IDefinition](../interfaces/IDefinition.md).[getNodeById](../interfaces/IDefinition.md#getnodebyid) + +#### Defined in + +[elements/Definition.ts:339](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Definition.ts#L339) diff --git a/docs/api/classes/Element.md b/docs/api/classes/Element.md new file mode 100644 index 00000000..b2154e7e --- /dev/null +++ b/docs/api/classes/Element.md @@ -0,0 +1,307 @@ +[bpmn-server](../API.md) / Element + +# Class: Element + +## Hierarchy + +- **`Element`** + + ↳ [`Node`](Node.md) + + ↳ [`Flow`](Flow.md) + +## Implements + +- [`IElement`](../interfaces/IElement.md) + +## Table of contents + +### Constructors + +- [constructor](Element.md#constructor) + +### Properties + +- [id](Element.md#id) +- [type](Element.md#type) +- [subType](Element.md#subtype) +- [name](Element.md#name) +- [behaviours](Element.md#behaviours) +- [isFlow](Element.md#isflow) +- [lane](Element.md#lane) + +### Methods + +- [continue](Element.md#continue) +- [describe](Element.md#describe) +- [restored](Element.md#restored) +- [resume](Element.md#resume) +- [hasBehaviour](Element.md#hasbehaviour) +- [getBehaviour](Element.md#getbehaviour) +- [addBehaviour](Element.md#addbehaviour) + +## Constructors + +### constructor + +• **new Element**(): [`Element`](Element.md) + +#### Returns + +[`Element`](Element.md) + +## Properties + +### id + +• **id**: `any` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[id](../interfaces/IElement.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[type](../interfaces/IElement.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### name + +• **name**: `any` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[name](../interfaces/IElement.md#name) + +#### Defined in + +[elements/Element.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L16) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Implementation of + +[IElement](../interfaces/IElement.md).[behaviours](../interfaces/IElement.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[lane](../interfaces/IElement.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +## Methods + +### continue + +▸ **continue**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[continue](../interfaces/IElement.md#continue) + +#### Defined in + +[elements/Element.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L20) + +___ + +### describe + +▸ **describe**(): `string`[][] + +#### Returns + +`string`[][] + +#### Implementation of + +[IElement](../interfaces/IElement.md).[describe](../interfaces/IElement.md#describe) + +#### Defined in + +[elements/Element.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L21) + +___ + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[restored](../interfaces/IElement.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[resume](../interfaces/IElement.md#resume) + +#### Defined in + +[elements/Element.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L27) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[hasBehaviour](../interfaces/IElement.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[getBehaviour](../interfaces/IElement.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IElement](../interfaces/IElement.md).[addBehaviour](../interfaces/IElement.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) diff --git a/docs/api/classes/EndEvent.md b/docs/api/classes/EndEvent.md new file mode 100644 index 00000000..bcff292a --- /dev/null +++ b/docs/api/classes/EndEvent.md @@ -0,0 +1,1057 @@ +[bpmn-server](../API.md) / EndEvent + +# Class: EndEvent + +## Hierarchy + +- [`Event`](Event.md) + + ↳ **`EndEvent`** + +## Table of contents + +### Constructors + +- [constructor](EndEvent.md#constructor) + +### Properties + +- [id](EndEvent.md#id) +- [type](EndEvent.md#type) +- [subType](EndEvent.md#subtype) +- [behaviours](EndEvent.md#behaviours) +- [isFlow](EndEvent.md#isflow) +- [lane](EndEvent.md#lane) +- [name](EndEvent.md#name) +- [process](EndEvent.md#process) +- [def](EndEvent.md#def) +- [outbounds](EndEvent.md#outbounds) +- [inbounds](EndEvent.md#inbounds) +- [attachments](EndEvent.md#attachments) +- [attachedTo](EndEvent.md#attachedto) +- [messageId](EndEvent.md#messageid) +- [signalId](EndEvent.md#signalid) +- [initiator](EndEvent.md#initiator) +- [assignee](EndEvent.md#assignee) +- [candidateGroups](EndEvent.md#candidategroups) +- [candidateUsers](EndEvent.md#candidateusers) +- [scripts](EndEvent.md#scripts) + +### Accessors + +- [canBeInvoked](EndEvent.md#canbeinvoked) +- [isCatching](EndEvent.md#iscatching) +- [processId](EndEvent.md#processid) +- [requiresWait](EndEvent.md#requireswait) + +### Methods + +- [restored](EndEvent.md#restored) +- [hasBehaviour](EndEvent.md#hasbehaviour) +- [getBehaviour](EndEvent.md#getbehaviour) +- [addBehaviour](EndEvent.md#addbehaviour) +- [hasMessage](EndEvent.md#hasmessage) +- [hasSignal](EndEvent.md#hassignal) +- [hasTimer](EndEvent.md#hastimer) +- [start](EndEvent.md#start) +- [end](EndEvent.md#end) +- [validate](EndEvent.md#validate) +- [doEvent](EndEvent.md#doevent) +- [setInput](EndEvent.md#setinput) +- [getInput](EndEvent.md#getinput) +- [getOutput](EndEvent.md#getoutput) +- [enter](EndEvent.md#enter) +- [execute](EndEvent.md#execute) +- [continue](EndEvent.md#continue) +- [run](EndEvent.md#run) +- [cancelEBG](EndEvent.md#cancelebg) +- [cancelBoundaryEvents](EndEvent.md#cancelboundaryevents) +- [resume](EndEvent.md#resume) +- [init](EndEvent.md#init) +- [getOutbounds](EndEvent.md#getoutbounds) +- [startBoundaryEvents](EndEvent.md#startboundaryevents) +- [describe](EndEvent.md#describe) + +## Constructors + +### constructor + +• **new EndEvent**(`id`, `process`, `type`, `def`): [`EndEvent`](EndEvent.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`EndEvent`](EndEvent.md) + +#### Inherited from + +[Event](Event.md).[constructor](Event.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Event](Event.md).[id](Event.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Event](Event.md).[type](Event.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Event](Event.md).[subType](Event.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[behaviours](Event.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Event](Event.md).[isFlow](Event.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Event](Event.md).[lane](Event.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Event](Event.md).[name](Event.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Event](Event.md).[process](Event.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Event](Event.md).[def](Event.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[outbounds](Event.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[inbounds](Event.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Event](Event.md).[attachments](Event.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Event](Event.md).[attachedTo](Event.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Event](Event.md).[messageId](Event.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Event](Event.md).[signalId](Event.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Event](Event.md).[initiator](Event.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Event](Event.md).[assignee](Event.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Event](Event.md).[candidateGroups](Event.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Event](Event.md).[candidateUsers](Event.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[scripts](Event.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Event.canBeInvoked + +#### Defined in + +[elements/Events.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L32) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Event.isCatching + +#### Defined in + +[elements/Events.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L113) + +___ + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Event.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Event.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[restored](Event.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Event](Event.md).[hasBehaviour](Event.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[getBehaviour](Event.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[addBehaviour](Event.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### hasMessage + +▸ **hasMessage**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasMessage](Event.md#hasmessage) + +#### Defined in + +[elements/Events.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L9) + +___ + +### hasSignal + +▸ **hasSignal**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasSignal](Event.md#hassignal) + +#### Defined in + +[elements/Events.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L12) + +___ + +### hasTimer + +▸ **hasTimer**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasTimer](Event.md#hastimer) + +#### Defined in + +[elements/Events.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L15) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +using token: check if fromEventBasedGateway; if yes cancel all other events + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Event](Event.md).[start](Event.md#start) + +#### Defined in + +[elements/Events.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L24) + +___ + +### end + +▸ **end**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[Event](Event.md).[end](Event.md#end) + +#### Defined in + +[elements/Events.ts:114](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L114) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[validate](Event.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Event](Event.md).[doEvent](Event.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[setInput](Event.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getInput](Event.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getOutput](Event.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[enter](Event.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Event](Event.md).[execute](Event.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[continue](Event.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Event](Event.md).[run](Event.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelEBG](Event.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelBoundaryEvents](Event.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[resume](Event.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[init](Event.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Event](Event.md).[getOutbounds](Event.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[startBoundaryEvents](Event.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Event](Event.md).[describe](Event.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/Engine.md b/docs/api/classes/Engine.md new file mode 100644 index 00000000..7064e2b8 --- /dev/null +++ b/docs/api/classes/Engine.md @@ -0,0 +1,602 @@ +[bpmn-server](../API.md) / Engine + +# Class: Engine + +super class for various objects that are part of the server + +## Hierarchy + +- [`ServerComponent`](ServerComponent.md) + + ↳ **`Engine`** + +## Implements + +- [`IEngine`](../interfaces/IEngine.md) + +## Table of contents + +### Constructors + +- [constructor](Engine.md#constructor) + +### Properties + +- [server](Engine.md#server) + +### Accessors + +- [configuration](Engine.md#configuration) +- [logger](Engine.md#logger) +- [cron](Engine.md#cron) +- [cache](Engine.md#cache) +- [appDelegate](Engine.md#appdelegate) +- [engine](Engine.md#engine) +- [dataStore](Engine.md#datastore) +- [definitions](Engine.md#definitions) +- [listener](Engine.md#listener) + +### Methods + +- [start](Engine.md#start) +- [get](Engine.md#get) +- [lock](Engine.md#lock) +- [release](Engine.md#release) +- [restore](Engine.md#restore) +- [invokeItem](Engine.md#invokeitem) +- [assign](Engine.md#assign) +- [invoke](Engine.md#invoke) +- [startRepeatTimerEvent](Engine.md#startrepeattimerevent) +- [startEvent](Engine.md#startevent) +- [throwMessage](Engine.md#throwmessage) +- [throwSignal](Engine.md#throwsignal) + +## Constructors + +### constructor + +• **new Engine**(`server`): [`Engine`](Engine.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`Engine`](Engine.md) + +#### Overrides + +[ServerComponent](ServerComponent.md).[constructor](ServerComponent.md#constructor) + +#### Defined in + +[server/Engine.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L12) + +## Properties + +### server + +• **server**: `any` + +#### Inherited from + +[ServerComponent](ServerComponent.md).[server](ServerComponent.md#server) + +#### Defined in + +[server/ServerComponent.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L9) + +## Accessors + +### configuration + +• `get` **configuration**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.configuration + +#### Defined in + +[server/ServerComponent.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L14) + +___ + +### logger + +• `get` **logger**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.logger + +#### Defined in + +[server/ServerComponent.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L15) + +___ + +### cron + +• `get` **cron**(): [`Cron`](Cron.md) + +#### Returns + +[`Cron`](Cron.md) + +#### Inherited from + +ServerComponent.cron + +#### Defined in + +[server/ServerComponent.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L16) + +___ + +### cache + +• `get` **cache**(): [`CacheManager`](CacheManager.md) + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Inherited from + +ServerComponent.cache + +#### Defined in + +[server/ServerComponent.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L17) + +___ + +### appDelegate + +• `get` **appDelegate**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.appDelegate + +#### Defined in + +[server/ServerComponent.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L18) + +___ + +### engine + +• `get` **engine**(): [`IEngine`](../interfaces/IEngine.md) + +#### Returns + +[`IEngine`](../interfaces/IEngine.md) + +#### Inherited from + +ServerComponent.engine + +#### Defined in + +[server/ServerComponent.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L19) + +___ + +### dataStore + +• `get` **dataStore**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.dataStore + +#### Defined in + +[server/ServerComponent.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L20) + +___ + +### definitions + +• `get` **definitions**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.definitions + +#### Defined in + +[server/ServerComponent.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L21) + +___ + +### listener + +• `get` **listener**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.listener + +#### Defined in + +[server/ServerComponent.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L22) + +## Methods + +### start + +▸ **start**(`name`, `data?`, `startNodeId?`, `userName?`, `options?`): `Promise`\<[`Execution`](Execution.md)\> + +loads a definitions and start execution + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | `any` | `undefined` | name of the process to start | +| `data` | `any` | `{}` | input data | +| `startNodeId` | `string` | `null` | in process has multiple start node; you need to specify which one | +| `userName` | `string` | `null` | - | +| `options` | `Object` | `{}` | - | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Implementation of + +[IEngine](../interfaces/IEngine.md).[start](../interfaces/IEngine.md#start) + +#### Defined in + +[server/Engine.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L23) + +___ + +### get + +▸ **get**(`instanceQuery`): `Promise`\<[`Execution`](Execution.md)\> + +restores an instance into memeory or provides you access to a running instance + +this will also resume execution + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `instanceQuery` | `any` | criteria to fetch the instance query example: ```jsonl { id: instanceId} { data: {caseId: 1005}} { items.id : 'abcc111322'} { items.itemKey : 'businesskey here'} ``` | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Implementation of + +[IEngine](../interfaces/IEngine.md).[get](../interfaces/IEngine.md#get) + +#### Defined in + +[server/Engine.ts:88](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L88) + +___ + +### lock + +▸ **lock**(`executionId`): `Promise`\<`void`\> + +lock instance + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `executionId` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[server/Engine.ts:98](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L98) + +___ + +### release + +▸ **release**(`execution`): `Promise`\<`void`\> + +release instance lock + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`Execution`](Execution.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[server/Engine.ts:107](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L107) + +___ + +### restore + +▸ **restore**(`instanceId`): `Promise`\<[`Execution`](Execution.md)\> + +* +Loads instance into memory for purpose of execution +Locks instance first if required +check if in cache + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Defined in + +[server/Engine.ts:131](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L131) + +___ + +### invokeItem + +▸ **invokeItem**(`itemQuery`, `data?`): `Promise`\<[`Execution`](Execution.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `itemQuery` | `any` | +| `data` | `Object` | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Defined in + +[server/Engine.ts:163](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L163) + +___ + +### assign + +▸ **assign**(`itemQuery`, `data?`, `assignment?`, `userName`, `options?`): `Promise`\<[`Execution`](Execution.md)\> + +update an existing item that is in a wait state with an assignment +can modify data or assignment or both + +------------------------------------------------- + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `itemQuery` | `any` | criteria to retrieve the item | +| `data` | `Object` | | +| `assignment` | `Object` | - | +| `userName` | `string` | - | +| `options` | `Object` | - | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Implementation of + +[IEngine](../interfaces/IEngine.md).[assign](../interfaces/IEngine.md#assign) + +#### Defined in + +[server/Engine.ts:176](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L176) + +___ + +### invoke + +▸ **invoke**(`itemQuery`, `data?`, `userName?`, `options?`): `Promise`\<[`Execution`](Execution.md)\> + +Continue an existing item that is in a wait state + +------------------------------------------------- + +scenario: + +``` +itemId {itemId: value } +itemKey {itemKey: value} +instance,task {instanceId: instanceId, elementId: value } +``` + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `itemQuery` | `any` | `undefined` | criteria to retrieve the item | +| `data` | `Object` | `{}` | | +| `userName` | `string` | `null` | - | +| `options` | `Object` | `{}` | - | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Implementation of + +[IEngine](../interfaces/IEngine.md).[invoke](../interfaces/IEngine.md#invoke) + +#### Defined in + +[server/Engine.ts:221](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L221) + +___ + +### startRepeatTimerEvent + +▸ **startRepeatTimerEvent**(`instanceId`, `prevItem`, `data?`, `options?`): `Promise`\<[`Execution`](Execution.md)\> + +Repeat Timers need to create new Item + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | +| `prevItem` | `any` | +| `data` | `Object` | +| `options` | `Object` | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Implementation of + +[IEngine](../interfaces/IEngine.md).[startRepeatTimerEvent](../interfaces/IEngine.md#startrepeattimerevent) + +#### Defined in + +[server/Engine.ts:282](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L282) + +___ + +### startEvent + +▸ **startEvent**(`instanceId`, `elementId`, `data?`): `Promise`\<[`Execution`](Execution.md)\> + +Invoking an event (usually start event of a secondary process) against an existing instance +or +Invoking a start event (of a secondary process) against an existing instance +---------------------------------------------------------------------------- + instance,task +``` + {instanceId: instanceId, elementId: value } +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | +| `elementId` | `any` | +| `data` | `Object` | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Implementation of + +[IEngine](../interfaces/IEngine.md).[startEvent](../interfaces/IEngine.md#startevent) + +#### Defined in + +[server/Engine.ts:319](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L319) + +___ + +### throwMessage + +▸ **throwMessage**(`messageId`, `data?`, `matchingQuery?`): `Promise`\<[`Execution`](Execution.md)\> + +signal/message raise a signal or throw a message + +will seach for a matching event/task given the signalId/messageId + +that can be againt a running instance or it may start a new instance +---------------------------------------------------------------------------- + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | `any` | the id of the message or signal as per bpmn definition | +| `data` | `Object` | message data | +| `matchingQuery` | `Object` | - | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Implementation of + +[IEngine](../interfaces/IEngine.md).[throwMessage](../interfaces/IEngine.md#throwmessage) + +#### Defined in + +[server/Engine.ts:343](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L343) + +___ + +### throwSignal + +▸ **throwSignal**(`signalId`, `data?`, `matchingQuery?`): `Promise`\<`any`[]\> + +signal/message raise a signal or throw a message + +will seach for a matching event/task given the signalId/messageId + +that can be againt a running instance or it may start a new instance +---------------------------------------------------------------------------- + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `signalId` | `any` | - | +| `data` | `Object` | message data | +| `matchingQuery` | `Object` | should match the itemKey (if specified) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Implementation of + +[IEngine](../interfaces/IEngine.md).[throwSignal](../interfaces/IEngine.md#throwsignal) + +#### Defined in + +[server/Engine.ts:400](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/Engine.ts#L400) diff --git a/docs/api/classes/Event.md b/docs/api/classes/Event.md new file mode 100644 index 00000000..34df1f01 --- /dev/null +++ b/docs/api/classes/Event.md @@ -0,0 +1,1056 @@ +[bpmn-server](../API.md) / Event + +# Class: Event + +## Hierarchy + +- [`Node`](Node.md) + + ↳ **`Event`** + + ↳↳ [`StartEvent`](StartEvent.md) + + ↳↳ [`EndEvent`](EndEvent.md) + + ↳↳ [`CatchEvent`](CatchEvent.md) + + ↳↳ [`ThrowEvent`](ThrowEvent.md) + + ↳↳ [`BoundaryEvent`](BoundaryEvent.md) + +## Table of contents + +### Constructors + +- [constructor](Event.md#constructor) + +### Properties + +- [id](Event.md#id) +- [type](Event.md#type) +- [subType](Event.md#subtype) +- [behaviours](Event.md#behaviours) +- [isFlow](Event.md#isflow) +- [lane](Event.md#lane) +- [name](Event.md#name) +- [process](Event.md#process) +- [def](Event.md#def) +- [outbounds](Event.md#outbounds) +- [inbounds](Event.md#inbounds) +- [attachments](Event.md#attachments) +- [attachedTo](Event.md#attachedto) +- [messageId](Event.md#messageid) +- [signalId](Event.md#signalid) +- [initiator](Event.md#initiator) +- [assignee](Event.md#assignee) +- [candidateGroups](Event.md#candidategroups) +- [candidateUsers](Event.md#candidateusers) +- [scripts](Event.md#scripts) + +### Accessors + +- [canBeInvoked](Event.md#canbeinvoked) +- [processId](Event.md#processid) +- [requiresWait](Event.md#requireswait) +- [isCatching](Event.md#iscatching) + +### Methods + +- [restored](Event.md#restored) +- [hasBehaviour](Event.md#hasbehaviour) +- [getBehaviour](Event.md#getbehaviour) +- [addBehaviour](Event.md#addbehaviour) +- [hasMessage](Event.md#hasmessage) +- [hasSignal](Event.md#hassignal) +- [hasTimer](Event.md#hastimer) +- [start](Event.md#start) +- [end](Event.md#end) +- [validate](Event.md#validate) +- [doEvent](Event.md#doevent) +- [setInput](Event.md#setinput) +- [getInput](Event.md#getinput) +- [getOutput](Event.md#getoutput) +- [enter](Event.md#enter) +- [execute](Event.md#execute) +- [continue](Event.md#continue) +- [run](Event.md#run) +- [cancelEBG](Event.md#cancelebg) +- [cancelBoundaryEvents](Event.md#cancelboundaryevents) +- [resume](Event.md#resume) +- [init](Event.md#init) +- [getOutbounds](Event.md#getoutbounds) +- [startBoundaryEvents](Event.md#startboundaryevents) +- [describe](Event.md#describe) + +## Constructors + +### constructor + +• **new Event**(`id`, `process`, `type`, `def`): [`Event`](Event.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`Event`](Event.md) + +#### Inherited from + +[Node](Node.md).[constructor](Node.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Node](Node.md).[id](Node.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Node](Node.md).[type](Node.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Node](Node.md).[subType](Node.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[behaviours](Node.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Node](Node.md).[isFlow](Node.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Node](Node.md).[lane](Node.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Node](Node.md).[name](Node.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Node](Node.md).[process](Node.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Node](Node.md).[def](Node.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[outbounds](Node.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[inbounds](Node.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Node](Node.md).[attachments](Node.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Node](Node.md).[attachedTo](Node.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Node](Node.md).[messageId](Node.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Node](Node.md).[signalId](Node.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Node](Node.md).[initiator](Node.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Node](Node.md).[assignee](Node.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Node](Node.md).[candidateGroups](Node.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Node](Node.md).[candidateUsers](Node.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[scripts](Node.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.canBeInvoked + +#### Defined in + +[elements/Events.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L32) + +___ + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Node.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[restored](Node.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Node](Node.md).[hasBehaviour](Node.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Node](Node.md).[getBehaviour](Node.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[addBehaviour](Node.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### hasMessage + +▸ **hasMessage**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/Events.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L9) + +___ + +### hasSignal + +▸ **hasSignal**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/Events.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L12) + +___ + +### hasTimer + +▸ **hasTimer**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/Events.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L15) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +using token: check if fromEventBasedGateway; if yes cancel all other events + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Node](Node.md).[start](Node.md#start) + +#### Defined in + +[elements/Events.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L24) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[Node](Node.md).[end](Node.md#end) + +#### Defined in + +[elements/Events.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L28) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[validate](Node.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Node](Node.md).[doEvent](Node.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[setInput](Node.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getInput](Node.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getOutput](Node.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[enter](Node.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Node](Node.md).[execute](Node.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[continue](Node.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Node](Node.md).[run](Node.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelEBG](Node.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelBoundaryEvents](Node.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[resume](Node.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[init](Node.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Node](Node.md).[getOutbounds](Node.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[startBoundaryEvents](Node.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Node](Node.md).[describe](Node.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/EventBasedGateway.md b/docs/api/classes/EventBasedGateway.md new file mode 100644 index 00000000..a8359e67 --- /dev/null +++ b/docs/api/classes/EventBasedGateway.md @@ -0,0 +1,1154 @@ +[bpmn-server](../API.md) / EventBasedGateway + +# Class: EventBasedGateway + +trick here is once one event is met all others must be cancelled + +How will I know? + when one of my events is fired shoudl I subscribe to the event or get directly notified? + +## Hierarchy + +- [`Gateway`](Gateway.md) + + ↳ **`EventBasedGateway`** + +## Table of contents + +### Constructors + +- [constructor](EventBasedGateway.md#constructor) + +### Properties + +- [id](EventBasedGateway.md#id) +- [type](EventBasedGateway.md#type) +- [subType](EventBasedGateway.md#subtype) +- [behaviours](EventBasedGateway.md#behaviours) +- [isFlow](EventBasedGateway.md#isflow) +- [lane](EventBasedGateway.md#lane) +- [working](EventBasedGateway.md#working) +- [listener](EventBasedGateway.md#listener) +- [name](EventBasedGateway.md#name) +- [process](EventBasedGateway.md#process) +- [def](EventBasedGateway.md#def) +- [outbounds](EventBasedGateway.md#outbounds) +- [inbounds](EventBasedGateway.md#inbounds) +- [attachments](EventBasedGateway.md#attachments) +- [attachedTo](EventBasedGateway.md#attachedto) +- [messageId](EventBasedGateway.md#messageid) +- [signalId](EventBasedGateway.md#signalid) +- [initiator](EventBasedGateway.md#initiator) +- [assignee](EventBasedGateway.md#assignee) +- [candidateGroups](EventBasedGateway.md#candidategroups) +- [candidateUsers](EventBasedGateway.md#candidateusers) +- [scripts](EventBasedGateway.md#scripts) + +### Accessors + +- [processId](EventBasedGateway.md#processid) +- [requiresWait](EventBasedGateway.md#requireswait) +- [canBeInvoked](EventBasedGateway.md#canbeinvoked) +- [isCatching](EventBasedGateway.md#iscatching) + +### Methods + +- [hasBehaviour](EventBasedGateway.md#hasbehaviour) +- [getBehaviour](EventBasedGateway.md#getbehaviour) +- [addBehaviour](EventBasedGateway.md#addbehaviour) +- [getOutbounds](EventBasedGateway.md#getoutbounds) +- [getPotentialPath](EventBasedGateway.md#getpotentialpath) +- [canReach](EventBasedGateway.md#canreach) +- [getRelatedTokens](EventBasedGateway.md#getrelatedtokens) +- [analyzeConvergingTokens](EventBasedGateway.md#analyzeconvergingtokens) +- [start](EventBasedGateway.md#start) +- [restored](EventBasedGateway.md#restored) +- [run](EventBasedGateway.md#run) +- [cancelAllBranched](EventBasedGateway.md#cancelallbranched) +- [validate](EventBasedGateway.md#validate) +- [doEvent](EventBasedGateway.md#doevent) +- [setInput](EventBasedGateway.md#setinput) +- [getInput](EventBasedGateway.md#getinput) +- [getOutput](EventBasedGateway.md#getoutput) +- [enter](EventBasedGateway.md#enter) +- [execute](EventBasedGateway.md#execute) +- [continue](EventBasedGateway.md#continue) +- [cancelEBG](EventBasedGateway.md#cancelebg) +- [cancelBoundaryEvents](EventBasedGateway.md#cancelboundaryevents) +- [end](EventBasedGateway.md#end) +- [resume](EventBasedGateway.md#resume) +- [init](EventBasedGateway.md#init) +- [startBoundaryEvents](EventBasedGateway.md#startboundaryevents) +- [describe](EventBasedGateway.md#describe) + +## Constructors + +### constructor + +• **new EventBasedGateway**(`id`, `process`, `type`, `def`): [`EventBasedGateway`](EventBasedGateway.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`EventBasedGateway`](EventBasedGateway.md) + +#### Inherited from + +[Gateway](Gateway.md).[constructor](Gateway.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[id](Gateway.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[type](Gateway.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[subType](Gateway.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Gateway](Gateway.md).[behaviours](Gateway.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Gateway](Gateway.md).[isFlow](Gateway.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[lane](Gateway.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### working + +• **working**: `boolean` = `false` + +#### Defined in + +[elements/Gateway.ts:266](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L266) + +___ + +### listener + +• **listener**: `any` + +#### Defined in + +[elements/Gateway.ts:267](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L267) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[name](Gateway.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[process](Gateway.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[def](Gateway.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Gateway](Gateway.md).[outbounds](Gateway.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Gateway](Gateway.md).[inbounds](Gateway.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Gateway](Gateway.md).[attachments](Gateway.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Gateway](Gateway.md).[attachedTo](Gateway.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[messageId](Gateway.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[signalId](Gateway.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[initiator](Gateway.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[assignee](Gateway.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[candidateGroups](Gateway.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[candidateUsers](Gateway.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Gateway](Gateway.md).[scripts](Gateway.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Gateway.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Gateway.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Gateway.canBeInvoked + +#### Defined in + +[elements/Node.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L127) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Gateway.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +## Methods + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Gateway](Gateway.md).[hasBehaviour](Gateway.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Gateway](Gateway.md).[getBehaviour](Gateway.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Gateway](Gateway.md).[addBehaviour](Gateway.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Gateway](Gateway.md).[getOutbounds](Gateway.md#getoutbounds) + +#### Defined in + +[elements/Gateway.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L34) + +___ + +### getPotentialPath + +▸ **getPotentialPath**(`node`, `path?`): `any` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `node` | `any` | `undefined` | +| `path` | `any` | `null` | + +#### Returns + +`any` + +#### Inherited from + +[Gateway](Gateway.md).[getPotentialPath](Gateway.md#getpotentialpath) + +#### Defined in + +[elements/Gateway.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L64) + +___ + +### canReach + +▸ **canReach**(`node`, `target`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | `any` | +| `target` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Gateway](Gateway.md).[canReach](Gateway.md#canreach) + +#### Defined in + +[elements/Gateway.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L78) + +___ + +### getRelatedTokens + +▸ **getRelatedTokens**(`item`): `any`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`any`[] + +#### Inherited from + +[Gateway](Gateway.md).[getRelatedTokens](Gateway.md#getrelatedtokens) + +#### Defined in + +[elements/Gateway.ts:88](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L88) + +___ + +### analyzeConvergingTokens + +▸ **analyzeConvergingTokens**(`item`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `pendingTokens` | [`Token`](Token.md)[] | +| `waitingTokens` | [`Token`](Token.md)[] | + +#### Inherited from + +[Gateway](Gateway.md).[analyzeConvergingTokens](Gateway.md#analyzeconvergingtokens) + +#### Defined in + +[elements/Gateway.ts:120](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L120) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Gateway](Gateway.md).[start](Gateway.md#start) + +#### Defined in + +[elements/Gateway.ts:149](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L149) + +___ + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Overrides + +[Gateway](Gateway.md).[restored](Gateway.md#restored) + +#### Defined in + +[elements/Gateway.ts:269](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L269) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Gateway](Gateway.md).[run](Gateway.md#run) + +#### Defined in + +[elements/Gateway.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L272) + +___ + +### cancelAllBranched + +▸ **cancelAllBranched**(`endingItem`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `endingItem` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Gateway.ts:275](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L275) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[validate](Gateway.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Gateway](Gateway.md).[doEvent](Gateway.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[setInput](Gateway.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Gateway](Gateway.md).[getInput](Gateway.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Gateway](Gateway.md).[getOutput](Gateway.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Gateway](Gateway.md).[enter](Gateway.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Gateway](Gateway.md).[execute](Gateway.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[continue](Gateway.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[cancelEBG](Gateway.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[cancelBoundaryEvents](Gateway.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[end](Gateway.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Gateway](Gateway.md).[resume](Gateway.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Gateway](Gateway.md).[init](Gateway.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[startBoundaryEvents](Gateway.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Gateway](Gateway.md).[describe](Gateway.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/EventData.md b/docs/api/classes/EventData.md new file mode 100644 index 00000000..2931fe8f --- /dev/null +++ b/docs/api/classes/EventData.md @@ -0,0 +1,266 @@ +[bpmn-server](../API.md) / EventData + +# Class: EventData + +## Implements + +- [`IEventData`](../interfaces/IEventData.md) + +## Table of contents + +### Constructors + +- [constructor](EventData.md#constructor) + +### Properties + +- [elementId](EventData.md#elementid) +- [type](EventData.md#type) +- [subType](EventData.md#subtype) +- [name](EventData.md#name) +- [processId](EventData.md#processid) +- [signalId](EventData.md#signalid) +- [messageId](EventData.md#messageid) +- [expression](EventData.md#expression) +- [expressionFormat](EventData.md#expressionformat) +- [referenceDateTime](EventData.md#referencedatetime) +- [maxRepeat](EventData.md#maxrepeat) +- [repeatCount](EventData.md#repeatcount) +- [timeDue](EventData.md#timedue) +- [lane](EventData.md#lane) +- [candidateGroups](EventData.md#candidategroups) +- [candidateUsers](EventData.md#candidateusers) + +## Constructors + +### constructor + +• **new EventData**(): [`EventData`](EventData.md) + +#### Returns + +[`EventData`](EventData.md) + +## Properties + +### elementId + +• **elementId**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[elementId](../interfaces/IEventData.md#elementid) + +#### Defined in + +[datastore/ModelsData.ts:83](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L83) + +___ + +### type + +• **type**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[type](../interfaces/IEventData.md#type) + +#### Defined in + +[datastore/ModelsData.ts:84](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L84) + +___ + +### subType + +• **subType**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[subType](../interfaces/IEventData.md#subtype) + +#### Defined in + +[datastore/ModelsData.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L85) + +___ + +### name + +• **name**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[name](../interfaces/IEventData.md#name) + +#### Defined in + +[datastore/ModelsData.ts:86](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L86) + +___ + +### processId + +• **processId**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[processId](../interfaces/IEventData.md#processid) + +#### Defined in + +[datastore/ModelsData.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L87) + +___ + +### signalId + +• **signalId**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[signalId](../interfaces/IEventData.md#signalid) + +#### Defined in + +[datastore/ModelsData.ts:88](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L88) + +___ + +### messageId + +• **messageId**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[messageId](../interfaces/IEventData.md#messageid) + +#### Defined in + +[datastore/ModelsData.ts:89](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L89) + +___ + +### expression + +• **expression**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[expression](../interfaces/IEventData.md#expression) + +#### Defined in + +[datastore/ModelsData.ts:91](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L91) + +___ + +### expressionFormat + +• **expressionFormat**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[expressionFormat](../interfaces/IEventData.md#expressionformat) + +#### Defined in + +[datastore/ModelsData.ts:92](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L92) + +___ + +### referenceDateTime + +• **referenceDateTime**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[referenceDateTime](../interfaces/IEventData.md#referencedatetime) + +#### Defined in + +[datastore/ModelsData.ts:93](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L93) + +___ + +### maxRepeat + +• **maxRepeat**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[maxRepeat](../interfaces/IEventData.md#maxrepeat) + +#### Defined in + +[datastore/ModelsData.ts:94](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L94) + +___ + +### repeatCount + +• **repeatCount**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[repeatCount](../interfaces/IEventData.md#repeatcount) + +#### Defined in + +[datastore/ModelsData.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L95) + +___ + +### timeDue + +• **timeDue**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[timeDue](../interfaces/IEventData.md#timedue) + +#### Defined in + +[datastore/ModelsData.ts:96](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L96) + +___ + +### lane + +• **lane**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[lane](../interfaces/IEventData.md#lane) + +#### Defined in + +[datastore/ModelsData.ts:97](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L97) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[candidateGroups](../interfaces/IEventData.md#candidategroups) + +#### Defined in + +[datastore/ModelsData.ts:98](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L98) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Implementation of + +[IEventData](../interfaces/IEventData.md).[candidateUsers](../interfaces/IEventData.md#candidateusers) + +#### Defined in + +[datastore/ModelsData.ts:99](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L99) diff --git a/docs/api/classes/Execution.md b/docs/api/classes/Execution.md new file mode 100644 index 00000000..19aae599 --- /dev/null +++ b/docs/api/classes/Execution.md @@ -0,0 +1,1295 @@ +[bpmn-server](../API.md) / Execution + +# Class: Execution + +is accessed two ways: + execute - start process + signal - invoke a node (userTask, event, etc.) + +## Hierarchy + +- [`ServerComponent`](ServerComponent.md) + + ↳ **`Execution`** + +## Implements + +- [`IExecution`](../interfaces/IExecution.md) + +## Table of contents + +### Constructors + +- [constructor](Execution.md#constructor) + +### Properties + +- [instance](Execution.md#instance) +- [tokens](Execution.md#tokens) +- [definition](Execution.md#definition) +- [process](Execution.md#process) +- [errors](Execution.md#errors) +- [item](Execution.md#item) +- [messageMatchingKey](Execution.md#messagematchingkey) +- [worker](Execution.md#worker) +- [userName](Execution.md#username) +- [promises](Execution.md#promises) +- [servicesProvider](Execution.md#servicesprovider) +- [isLocked](Execution.md#islocked) +- [options](Execution.md#options) +- [operation](Execution.md#operation) +- [uids](Execution.md#uids) +- [server](Execution.md#server) + +### Accessors + +- [id](Execution.md#id) +- [name](Execution.md#name) +- [status](Execution.md#status) +- [execution](Execution.md#execution) +- [listener](Execution.md#listener) +- [configuration](Execution.md#configuration) +- [logger](Execution.md#logger) +- [cron](Execution.md#cron) +- [cache](Execution.md#cache) +- [appDelegate](Execution.md#appdelegate) +- [engine](Execution.md#engine) +- [dataStore](Execution.md#datastore) +- [definitions](Execution.md#definitions) + +### Methods + +- [tillDone](Execution.md#tilldone) +- [getNodeById](Execution.md#getnodebyid) +- [getToken](Execution.md#gettoken) +- [tokenEnded](Execution.md#tokenended) +- [end](Execution.md#end) +- [terminate](Execution.md#terminate) +- [stop](Execution.md#stop) +- [execute](Execution.md#execute) +- [assign](Execution.md#assign) +- [signalItem](Execution.md#signalitem) +- [signalEvent](Execution.md#signalevent) +- [signalRepeatTimerEvent](Execution.md#signalrepeattimerevent) +- [save](Execution.md#save) +- [getItems](Execution.md#getitems) +- [getItemsData](Execution.md#getitemsdata) +- [getState](Execution.md#getstate) +- [restore](Execution.md#restore) +- [restored](Execution.md#restored) +- [resume](Execution.md#resume) +- [report](Execution.md#report) +- [getNewId](Execution.md#getnewid) +- [getUUID](Execution.md#getuuid) +- [doExecutionEvent](Execution.md#doexecutionevent) +- [doItemEvent](Execution.md#doitemevent) +- [log](Execution.md#log) +- [info](Execution.md#info) +- [error](Execution.md#error) +- [appendData](Execution.md#appenddata) +- [addHistory](Execution.md#addhistory) +- [getData](Execution.md#getdata) +- [getAndCreateData](Execution.md#getandcreatedata) + +## Constructors + +### constructor + +• **new Execution**(`server`, `name`, `source`, `state?`): [`Execution`](Execution.md) + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `server` | `any` | `undefined` | - | +| `name` | `string` | `undefined` | process name | +| `source` | `any` | `undefined` | bpmn source | +| `state` | `any` | `null` | - | + +#### Returns + +[`Execution`](Execution.md) + +#### Overrides + +[ServerComponent](ServerComponent.md).[constructor](ServerComponent.md#constructor) + +#### Defined in + +[engine/Execution.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L62) + +## Properties + +### instance + +• **instance**: [`InstanceObject`](InstanceObject.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[instance](../interfaces/IExecution.md#instance) + +#### Defined in + +[engine/Execution.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L26) + +___ + +### tokens + +• **tokens**: `Map`\<`any`, `any`\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[tokens](../interfaces/IExecution.md#tokens) + +#### Defined in + +[engine/Execution.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L27) + +___ + +### definition + +• **definition**: [`IDefinition`](../interfaces/IDefinition.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[definition](../interfaces/IExecution.md#definition) + +#### Defined in + +[engine/Execution.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L28) + +___ + +### process + +• **process**: [`Process`](Process.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[process](../interfaces/IExecution.md#process) + +#### Defined in + +[engine/Execution.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L29) + +___ + +### errors + +• **errors**: `any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[errors](../interfaces/IExecution.md#errors) + +#### Defined in + +[engine/Execution.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L30) + +___ + +### item + +• **item**: `any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[item](../interfaces/IExecution.md#item) + +#### Defined in + +[engine/Execution.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L31) + +___ + +### messageMatchingKey + +• **messageMatchingKey**: `any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[messageMatchingKey](../interfaces/IExecution.md#messagematchingkey) + +#### Defined in + +[engine/Execution.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L32) + +___ + +### worker + +• **worker**: `any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[worker](../interfaces/IExecution.md#worker) + +#### Defined in + +[engine/Execution.ts:33](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L33) + +___ + +### userName + +• **userName**: `any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[userName](../interfaces/IExecution.md#username) + +#### Defined in + +[engine/Execution.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L34) + +___ + +### promises + +• **promises**: `any`[] = `[]` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[promises](../interfaces/IExecution.md#promises) + +#### Defined in + +[engine/Execution.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L35) + +___ + +### servicesProvider + +• **servicesProvider**: `any` + +#### Defined in + +[engine/Execution.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L36) + +___ + +### isLocked + +• **isLocked**: `boolean` = `false` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[isLocked](../interfaces/IExecution.md#islocked) + +#### Defined in + +[engine/Execution.ts:37](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L37) + +___ + +### options + +• **options**: `any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[options](../interfaces/IExecution.md#options) + +#### Defined in + +[engine/Execution.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L38) + +___ + +### operation + +• **operation**: `any` + +#### Defined in + +[engine/Execution.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L39) + +___ + +### uids + +• **uids**: `Object` = `{}` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[uids](../interfaces/IExecution.md#uids) + +#### Defined in + +[engine/Execution.ts:526](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L526) + +___ + +### server + +• **server**: `any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[server](../interfaces/IExecution.md#server) + +#### Inherited from + +[ServerComponent](ServerComponent.md).[server](ServerComponent.md#server) + +#### Defined in + +[server/ServerComponent.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L9) + +## Accessors + +### id + +• `get` **id**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[id](../interfaces/IExecution.md#id) + +#### Defined in + +[engine/Execution.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L41) + +___ + +### name + +• `get` **name**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[name](../interfaces/IExecution.md#name) + +#### Defined in + +[engine/Execution.ts:42](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L42) + +___ + +### status + +• `get` **status**(): [`EXECUTION_STATUS`](../enums/EXECUTION_STATUS.md) + +#### Returns + +[`EXECUTION_STATUS`](../enums/EXECUTION_STATUS.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[status](../interfaces/IExecution.md#status) + +#### Defined in + +[engine/Execution.ts:43](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L43) + +___ + +### execution + +• `get` **execution**(): `this` + +#### Returns + +`this` + +#### Defined in + +[engine/Execution.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L44) + +___ + +### listener + +• `get` **listener**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[listener](../interfaces/IExecution.md#listener) + +#### Overrides + +ServerComponent.listener + +#### Defined in + +[engine/Execution.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L52) + +___ + +### configuration + +• `get` **configuration**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[configuration](../interfaces/IExecution.md#configuration) + +#### Inherited from + +ServerComponent.configuration + +#### Defined in + +[server/ServerComponent.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L14) + +___ + +### logger + +• `get` **logger**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[logger](../interfaces/IExecution.md#logger) + +#### Inherited from + +ServerComponent.logger + +#### Defined in + +[server/ServerComponent.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L15) + +___ + +### cron + +• `get` **cron**(): [`Cron`](Cron.md) + +#### Returns + +[`Cron`](Cron.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[cron](../interfaces/IExecution.md#cron) + +#### Inherited from + +ServerComponent.cron + +#### Defined in + +[server/ServerComponent.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L16) + +___ + +### cache + +• `get` **cache**(): [`CacheManager`](CacheManager.md) + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[cache](../interfaces/IExecution.md#cache) + +#### Inherited from + +ServerComponent.cache + +#### Defined in + +[server/ServerComponent.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L17) + +___ + +### appDelegate + +• `get` **appDelegate**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[appDelegate](../interfaces/IExecution.md#appdelegate) + +#### Inherited from + +ServerComponent.appDelegate + +#### Defined in + +[server/ServerComponent.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L18) + +___ + +### engine + +• `get` **engine**(): [`IEngine`](../interfaces/IEngine.md) + +#### Returns + +[`IEngine`](../interfaces/IEngine.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[engine](../interfaces/IExecution.md#engine) + +#### Inherited from + +ServerComponent.engine + +#### Defined in + +[server/ServerComponent.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L19) + +___ + +### dataStore + +• `get` **dataStore**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[dataStore](../interfaces/IExecution.md#datastore) + +#### Inherited from + +ServerComponent.dataStore + +#### Defined in + +[server/ServerComponent.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L20) + +___ + +### definitions + +• `get` **definitions**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[definitions](../interfaces/IExecution.md#definitions) + +#### Inherited from + +ServerComponent.definitions + +#### Defined in + +[server/ServerComponent.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L21) + +## Methods + +### tillDone + +▸ **tillDone**(): `Promise`\<[`Execution`](Execution.md)\> + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Defined in + +[engine/Execution.ts:46](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L46) + +___ + +### getNodeById + +▸ **getNodeById**(`id`): [`Node`](Node.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | + +#### Returns + +[`Node`](Node.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[getNodeById](../interfaces/IExecution.md#getnodebyid) + +#### Defined in + +[engine/Execution.ts:76](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L76) + +___ + +### getToken + +▸ **getToken**(`id`): [`Token`](Token.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `number` | + +#### Returns + +[`Token`](Token.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[getToken](../interfaces/IExecution.md#gettoken) + +#### Defined in + +[engine/Execution.ts:79](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L79) + +___ + +### tokenEnded + +▸ **tokenEnded**(`token`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | [`Token`](Token.md) | + +#### Returns + +`void` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[tokenEnded](../interfaces/IExecution.md#tokenended) + +#### Defined in + +[engine/Execution.ts:82](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L82) + +___ + +### end + +▸ **end**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[end](../interfaces/IExecution.md#end) + +#### Defined in + +[engine/Execution.ts:90](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L90) + +___ + +### terminate + +▸ **terminate**(): `void` + +causes the execution to stop from running any further + +#### Returns + +`void` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[terminate](../interfaces/IExecution.md#terminate) + +#### Defined in + +[engine/Execution.ts:104](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L104) + +___ + +### stop + +▸ **stop**(): `void` + +causes the execution to stop from running any further + +#### Returns + +`void` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[stop](../interfaces/IExecution.md#stop) + +#### Defined in + +[engine/Execution.ts:114](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L114) + +___ + +### execute + +▸ **execute**(`startNodeId?`, `inputData?`, `options?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `startNodeId` | `any` | `null` | +| `inputData` | `Object` | `{}` | +| `options` | `Object` | `{}` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[execute](../interfaces/IExecution.md#execute) + +#### Defined in + +[engine/Execution.ts:121](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L121) + +___ + +### assign + +▸ **assign**(`executionId`, `inputData`, `assignment?`, `userName`, `options?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `executionId` | `any` | +| `inputData` | `any` | +| `assignment` | `Object` | +| `userName` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[engine/Execution.ts:181](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L181) + +___ + +### signalItem + +▸ **signalItem**(`itemId`, `inputData`, `userName`, `options?`): `Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +invoke scenarios: + itemId + elementId - but only one is active + elementId - for a startEvent in a secondary process + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `itemId` | `any` | +| `inputData` | `any` | +| `userName` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[signalItem](../interfaces/IExecution.md#signalitem) + +#### Defined in + +[engine/Execution.ts:218](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L218) + +___ + +### signalEvent + +▸ **signalEvent**(`executionId`, `inputData`, `options?`): `Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `executionId` | `any` | +| `inputData` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[signalEvent](../interfaces/IExecution.md#signalevent) + +#### Defined in + +[engine/Execution.ts:260](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L260) + +___ + +### signalRepeatTimerEvent + +▸ **signalRepeatTimerEvent**(`executionId`, `prevItem`, `inputData`, `options?`): `Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `executionId` | `any` | +| `prevItem` | `any` | +| `inputData` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](../interfaces/IExecution.md)\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[signalRepeatTimerEvent](../interfaces/IExecution.md#signalrepeattimerevent) + +#### Defined in + +[engine/Execution.ts:335](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L335) + +___ + +### save + +▸ **save**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[save](../interfaces/IExecution.md#save) + +#### Defined in + +[engine/Execution.ts:365](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L365) + +___ + +### getItems + +▸ **getItems**(): [`Item`](Item.md)[] + +#### Returns + +[`Item`](Item.md)[] + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[getItems](../interfaces/IExecution.md#getitems) + +#### Defined in + +[engine/Execution.ts:378](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L378) + +___ + +### getItemsData + +▸ **getItemsData**(): `any`[] + +#### Returns + +`any`[] + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[getItemsData](../interfaces/IExecution.md#getitemsdata) + +#### Defined in + +[engine/Execution.ts:389](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L389) + +___ + +### getState + +▸ **getState**(): [`IInstanceData`](../interfaces/IInstanceData.md) + +#### Returns + +[`IInstanceData`](../interfaces/IInstanceData.md) + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[getState](../interfaces/IExecution.md#getstate) + +#### Defined in + +[engine/Execution.ts:399](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L399) + +___ + +### restore + +▸ **restore**(`server`, `state`): `Promise`\<[`Execution`](Execution.md)\> + +re-enstate the execution from db + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | +| `state` | [`IInstanceData`](../interfaces/IInstanceData.md) | + +#### Returns + +`Promise`\<[`Execution`](Execution.md)\> + +#### Defined in + +[engine/Execution.ts:425](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L425) + +___ + +### restored + +▸ **restored**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[restored](../interfaces/IExecution.md#restored) + +#### Defined in + +[engine/Execution.ts:485](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L485) + +___ + +### resume + +▸ **resume**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[resume](../interfaces/IExecution.md#resume) + +#### Defined in + +[engine/Execution.ts:492](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L492) + +___ + +### report + +▸ **report**(): `void` + +#### Returns + +`void` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[report](../interfaces/IExecution.md#report) + +#### Defined in + +[engine/Execution.ts:498](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L498) + +___ + +### getNewId + +▸ **getNewId**(`scope`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | `string` | + +#### Returns + +`number` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[getNewId](../interfaces/IExecution.md#getnewid) + +#### Defined in + +[engine/Execution.ts:528](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L528) + +___ + +### getUUID + +▸ **getUUID**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[getUUID](../interfaces/IExecution.md#getuuid) + +#### Defined in + +[engine/Execution.ts:535](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L535) + +___ + +### doExecutionEvent + +▸ **doExecutionEvent**(`process`, `event`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `process` | `any` | +| `event` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[doExecutionEvent](../interfaces/IExecution.md#doexecutionevent) + +#### Defined in + +[engine/Execution.ts:542](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L542) + +___ + +### doItemEvent + +▸ **doItemEvent**(`item`, `event`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `event` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[doItemEvent](../interfaces/IExecution.md#doitemevent) + +#### Defined in + +[engine/Execution.ts:548](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L548) + +___ + +### log + +▸ **log**(`...msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...msg` | `any`[] | + +#### Returns + +`void` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[log](../interfaces/IExecution.md#log) + +#### Defined in + +[engine/Execution.ts:553](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L553) + +___ + +### info + +▸ **info**(`...msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...msg` | `any`[] | + +#### Returns + +`void` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[info](../interfaces/IExecution.md#info) + +#### Defined in + +[engine/Execution.ts:556](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L556) + +___ + +### error + +▸ **error**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[error](../interfaces/IExecution.md#error) + +#### Defined in + +[engine/Execution.ts:559](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L559) + +___ + +### appendData + +▸ **appendData**(`inputData`, `item`, `dataPath?`, `assignment?`): `void` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `inputData` | `any` | `undefined` | +| `item` | `any` | `undefined` | +| `dataPath` | `any` | `null` | +| `assignment` | `any` | `null` | + +#### Returns + +`void` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[appendData](../interfaces/IExecution.md#appenddata) + +#### Defined in + +[engine/Execution.ts:568](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L568) + +___ + +### addHistory + +▸ **addHistory**(`inputData`, `assignment`, `item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inputData` | `any` | +| `assignment` | `any` | +| `item` | `any` | + +#### Returns + +`void` + +#### Defined in + +[engine/Execution.ts:605](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L605) + +___ + +### getData + +▸ **getData**(`dataPath`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dataPath` | `any` | + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[getData](../interfaces/IExecution.md#getdata) + +#### Defined in + +[engine/Execution.ts:623](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L623) + +___ + +### getAndCreateData + +▸ **getAndCreateData**(`dataPath`, `asArray?`): `any` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `dataPath` | `any` | `undefined` | +| `asArray` | `boolean` | `false` | + +#### Returns + +`any` + +#### Implementation of + +[IExecution](../interfaces/IExecution.md).[getAndCreateData](../interfaces/IExecution.md#getandcreatedata) + +#### Defined in + +[engine/Execution.ts:636](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Execution.ts#L636) diff --git a/docs/api/classes/Flow.md b/docs/api/classes/Flow.md new file mode 100644 index 00000000..b6b6398b --- /dev/null +++ b/docs/api/classes/Flow.md @@ -0,0 +1,494 @@ +[bpmn-server](../API.md) / Flow + +# Class: Flow + +## Hierarchy + +- [`Element`](Element.md) + + ↳ **`Flow`** + + ↳↳ [`MessageFlow`](MessageFlow.md) + +## Implements + +- [`IFlow`](../interfaces/IFlow.md) + +## Table of contents + +### Constructors + +- [constructor](Flow.md#constructor) + +### Properties + +- [id](Flow.md#id) +- [type](Flow.md#type) +- [subType](Flow.md#subtype) +- [name](Flow.md#name) +- [behaviours](Flow.md#behaviours) +- [isFlow](Flow.md#isflow) +- [lane](Flow.md#lane) +- [from](Flow.md#from) +- [to](Flow.md#to) +- [def](Flow.md#def) +- [isMessageFlow](Flow.md#ismessageflow) + +### Methods + +- [continue](Flow.md#continue) +- [restored](Flow.md#restored) +- [resume](Flow.md#resume) +- [hasBehaviour](Flow.md#hasbehaviour) +- [getBehaviour](Flow.md#getbehaviour) +- [addBehaviour](Flow.md#addbehaviour) +- [describe](Flow.md#describe) +- [run](Flow.md#run) +- [evaluateCondition](Flow.md#evaluatecondition) +- [execute](Flow.md#execute) + +## Constructors + +### constructor + +• **new Flow**(`id`, `type`, `from`, `to`, `def`): [`Flow`](Flow.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `type` | `any` | +| `from` | `any` | +| `to` | `any` | +| `def` | `any` | + +#### Returns + +[`Flow`](Flow.md) + +#### Overrides + +[Element](Element.md).[constructor](Element.md#constructor) + +#### Defined in + +[elements/Flow.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L16) + +## Properties + +### id + +• **id**: `any` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[id](../interfaces/IFlow.md#id) + +#### Inherited from + +[Element](Element.md).[id](Element.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[type](../interfaces/IFlow.md#type) + +#### Inherited from + +[Element](Element.md).[type](Element.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Element](Element.md).[subType](Element.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### name + +• **name**: `any` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[name](../interfaces/IFlow.md#name) + +#### Inherited from + +[Element](Element.md).[name](Element.md#name) + +#### Defined in + +[elements/Element.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L16) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[behaviours](../interfaces/IFlow.md#behaviours) + +#### Inherited from + +[Element](Element.md).[behaviours](Element.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Element](Element.md).[isFlow](Element.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[lane](../interfaces/IFlow.md#lane) + +#### Inherited from + +[Element](Element.md).[lane](Element.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### from + +• **from**: [`Node`](Node.md) + +#### Defined in + +[elements/Flow.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L12) + +___ + +### to + +• **to**: [`Node`](Node.md) + +#### Defined in + +[elements/Flow.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Defined in + +[elements/Flow.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L14) + +___ + +### isMessageFlow + +• **isMessageFlow**: `boolean` = `false` + +#### Defined in + +[elements/Flow.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L15) + +## Methods + +### continue + +▸ **continue**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[continue](../interfaces/IFlow.md#continue) + +#### Inherited from + +[Element](Element.md).[continue](Element.md#continue) + +#### Defined in + +[elements/Element.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L20) + +___ + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[restored](../interfaces/IFlow.md#restored) + +#### Inherited from + +[Element](Element.md).[restored](Element.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[resume](../interfaces/IFlow.md#resume) + +#### Inherited from + +[Element](Element.md).[resume](Element.md#resume) + +#### Defined in + +[elements/Element.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L27) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[hasBehaviour](../interfaces/IFlow.md#hasbehaviour) + +#### Inherited from + +[Element](Element.md).[hasBehaviour](Element.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[getBehaviour](../interfaces/IFlow.md#getbehaviour) + +#### Inherited from + +[Element](Element.md).[getBehaviour](Element.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[addBehaviour](../interfaces/IFlow.md#addbehaviour) + +#### Inherited from + +[Element](Element.md).[addBehaviour](Element.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### describe + +▸ **describe**(): `any`[][] + +#### Returns + +`any`[][] + +#### Implementation of + +[IFlow](../interfaces/IFlow.md).[describe](../interfaces/IFlow.md#describe) + +#### Overrides + +[Element](Element.md).[describe](Element.md#describe) + +#### Defined in + +[elements/Flow.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L26) + +___ + +### run + +▸ **run**(`item`): [`FLOW_ACTION`](../enums/FLOW_ACTION.md) + +```xml + if flow has a condition, it must be evaluated and if result is true flow will continue + otherwise, flow will be discarded. + +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`FLOW_ACTION`](../enums/FLOW_ACTION.md) + +#### Defined in + +[elements/Flow.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L44) + +___ + +### evaluateCondition + +▸ **evaluateCondition**(`item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`any` + +#### Defined in + +[elements/Flow.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L54) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Flow.ts:67](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L67) diff --git a/docs/api/classes/Gateway.md b/docs/api/classes/Gateway.md new file mode 100644 index 00000000..51d00f7c --- /dev/null +++ b/docs/api/classes/Gateway.md @@ -0,0 +1,1094 @@ +[bpmn-server](../API.md) / Gateway + +# Class: Gateway + +## Hierarchy + +- [`Node`](Node.md) + + ↳ **`Gateway`** + + ↳↳ [`XORGateway`](XORGateway.md) + + ↳↳ [`EventBasedGateway`](EventBasedGateway.md) + +## Table of contents + +### Constructors + +- [constructor](Gateway.md#constructor) + +### Properties + +- [id](Gateway.md#id) +- [type](Gateway.md#type) +- [subType](Gateway.md#subtype) +- [behaviours](Gateway.md#behaviours) +- [isFlow](Gateway.md#isflow) +- [lane](Gateway.md#lane) +- [name](Gateway.md#name) +- [process](Gateway.md#process) +- [def](Gateway.md#def) +- [outbounds](Gateway.md#outbounds) +- [inbounds](Gateway.md#inbounds) +- [attachments](Gateway.md#attachments) +- [attachedTo](Gateway.md#attachedto) +- [messageId](Gateway.md#messageid) +- [signalId](Gateway.md#signalid) +- [initiator](Gateway.md#initiator) +- [assignee](Gateway.md#assignee) +- [candidateGroups](Gateway.md#candidategroups) +- [candidateUsers](Gateway.md#candidateusers) +- [scripts](Gateway.md#scripts) + +### Accessors + +- [processId](Gateway.md#processid) +- [requiresWait](Gateway.md#requireswait) +- [canBeInvoked](Gateway.md#canbeinvoked) +- [isCatching](Gateway.md#iscatching) + +### Methods + +- [restored](Gateway.md#restored) +- [hasBehaviour](Gateway.md#hasbehaviour) +- [getBehaviour](Gateway.md#getbehaviour) +- [addBehaviour](Gateway.md#addbehaviour) +- [getOutbounds](Gateway.md#getoutbounds) +- [getPotentialPath](Gateway.md#getpotentialpath) +- [canReach](Gateway.md#canreach) +- [getRelatedTokens](Gateway.md#getrelatedtokens) +- [analyzeConvergingTokens](Gateway.md#analyzeconvergingtokens) +- [start](Gateway.md#start) +- [validate](Gateway.md#validate) +- [doEvent](Gateway.md#doevent) +- [setInput](Gateway.md#setinput) +- [getInput](Gateway.md#getinput) +- [getOutput](Gateway.md#getoutput) +- [enter](Gateway.md#enter) +- [execute](Gateway.md#execute) +- [continue](Gateway.md#continue) +- [run](Gateway.md#run) +- [cancelEBG](Gateway.md#cancelebg) +- [cancelBoundaryEvents](Gateway.md#cancelboundaryevents) +- [end](Gateway.md#end) +- [resume](Gateway.md#resume) +- [init](Gateway.md#init) +- [startBoundaryEvents](Gateway.md#startboundaryevents) +- [describe](Gateway.md#describe) + +## Constructors + +### constructor + +• **new Gateway**(`id`, `process`, `type`, `def`): [`Gateway`](Gateway.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`Gateway`](Gateway.md) + +#### Inherited from + +[Node](Node.md).[constructor](Node.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Node](Node.md).[id](Node.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Node](Node.md).[type](Node.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Node](Node.md).[subType](Node.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[behaviours](Node.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Node](Node.md).[isFlow](Node.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Node](Node.md).[lane](Node.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Node](Node.md).[name](Node.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Node](Node.md).[process](Node.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Node](Node.md).[def](Node.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[outbounds](Node.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[inbounds](Node.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Node](Node.md).[attachments](Node.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Node](Node.md).[attachedTo](Node.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Node](Node.md).[messageId](Node.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Node](Node.md).[signalId](Node.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Node](Node.md).[initiator](Node.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Node](Node.md).[assignee](Node.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Node](Node.md).[candidateGroups](Node.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Node](Node.md).[candidateUsers](Node.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[scripts](Node.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Node.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.canBeInvoked + +#### Defined in + +[elements/Node.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L127) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[restored](Node.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Node](Node.md).[hasBehaviour](Node.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Node](Node.md).[getBehaviour](Node.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[addBehaviour](Node.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Overrides + +[Node](Node.md).[getOutbounds](Node.md#getoutbounds) + +#### Defined in + +[elements/Gateway.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L34) + +___ + +### getPotentialPath + +▸ **getPotentialPath**(`node`, `path?`): `any` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `node` | `any` | `undefined` | +| `path` | `any` | `null` | + +#### Returns + +`any` + +#### Defined in + +[elements/Gateway.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L64) + +___ + +### canReach + +▸ **canReach**(`node`, `target`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | `any` | +| `target` | `any` | + +#### Returns + +`any` + +#### Defined in + +[elements/Gateway.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L78) + +___ + +### getRelatedTokens + +▸ **getRelatedTokens**(`item`): `any`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`any`[] + +#### Defined in + +[elements/Gateway.ts:88](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L88) + +___ + +### analyzeConvergingTokens + +▸ **analyzeConvergingTokens**(`item`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `pendingTokens` | [`Token`](Token.md)[] | +| `waitingTokens` | [`Token`](Token.md)[] | + +#### Defined in + +[elements/Gateway.ts:120](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L120) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Node](Node.md).[start](Node.md#start) + +#### Defined in + +[elements/Gateway.ts:149](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L149) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[validate](Node.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Node](Node.md).[doEvent](Node.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[setInput](Node.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getInput](Node.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getOutput](Node.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[enter](Node.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Node](Node.md).[execute](Node.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[continue](Node.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Node](Node.md).[run](Node.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelEBG](Node.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelBoundaryEvents](Node.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[end](Node.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[resume](Node.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[init](Node.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[startBoundaryEvents](Node.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Node](Node.md).[describe](Node.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/IOBehaviour.md b/docs/api/classes/IOBehaviour.md new file mode 100644 index 00000000..e4c695ec --- /dev/null +++ b/docs/api/classes/IOBehaviour.md @@ -0,0 +1,381 @@ +[bpmn-server](../API.md) / IOBehaviour + +# Class: IOBehaviour + +Behaviour + ioSpecification + timer + message + signal + + each behaviour is a class + it scans def and insert itself to perform actions as required + +## Hierarchy + +- [`Behaviour`](Behaviour.md) + + ↳ **`IOBehaviour`** + +## Table of contents + +### Constructors + +- [constructor](IOBehaviour.md#constructor) + +### Properties + +- [node](IOBehaviour.md#node) +- [definition](IOBehaviour.md#definition) +- [parameters](IOBehaviour.md#parameters) + +### Methods + +- [restored](IOBehaviour.md#restored) +- [start](IOBehaviour.md#start) +- [run](IOBehaviour.md#run) +- [end](IOBehaviour.md#end) +- [resume](IOBehaviour.md#resume) +- [getNodeAttributes](IOBehaviour.md#getnodeattributes) +- [getItemAttributes](IOBehaviour.md#getitemattributes) +- [init](IOBehaviour.md#init) +- [enter](IOBehaviour.md#enter) +- [process](IOBehaviour.md#process) +- [exit](IOBehaviour.md#exit) +- [describe](IOBehaviour.md#describe) + +## Constructors + +### constructor + +• **new IOBehaviour**(`node`, `definition`): [`IOBehaviour`](IOBehaviour.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `definition` | `any` | + +#### Returns + +[`IOBehaviour`](IOBehaviour.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[constructor](Behaviour.md#constructor) + +#### Defined in + +[elements/behaviours/Behaviour.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L40) + +## Properties + +### node + +• **node**: [`Node`](Node.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[node](Behaviour.md#node) + +#### Defined in + +[elements/behaviours/Behaviour.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L38) + +___ + +### definition + +• **definition**: `any` + +#### Inherited from + +[Behaviour](Behaviour.md).[definition](Behaviour.md#definition) + +#### Defined in + +[elements/behaviours/Behaviour.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L39) + +___ + +### parameters + +• **parameters**: `IOParameter`[] + +#### Defined in + +[elements/behaviours/IOBehaviour.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/IOBehaviour.ts#L87) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[restored](Behaviour.md#restored) + +#### Defined in + +[elements/behaviours/Behaviour.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L45) + +___ + +### start + +▸ **start**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[start](Behaviour.md#start) + +#### Defined in + +[elements/behaviours/Behaviour.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L49) + +___ + +### run + +▸ **run**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[run](Behaviour.md#run) + +#### Defined in + +[elements/behaviours/Behaviour.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L50) + +___ + +### end + +▸ **end**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[end](Behaviour.md#end) + +#### Defined in + +[elements/behaviours/Behaviour.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L51) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[resume](Behaviour.md#resume) + +#### Defined in + +[elements/behaviours/Behaviour.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L53) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getNodeAttributes](Behaviour.md#getnodeattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L54) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getItemAttributes](Behaviour.md#getitemattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L55) + +___ + +### init + +▸ **init**(): `void` + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[init](Behaviour.md#init) + +#### Defined in + +[elements/behaviours/IOBehaviour.ts:89](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/IOBehaviour.ts#L89) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[enter](Behaviour.md#enter) + +#### Defined in + +[elements/behaviours/IOBehaviour.ts:103](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/IOBehaviour.ts#L103) + +___ + +### process + +▸ **process**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Defined in + +[elements/behaviours/IOBehaviour.ts:133](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/IOBehaviour.ts#L133) + +___ + +### exit + +▸ **exit**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[exit](Behaviour.md#exit) + +#### Defined in + +[elements/behaviours/IOBehaviour.ts:144](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/IOBehaviour.ts#L144) + +___ + +### describe + +▸ **describe**(): `string`[][] + +#### Returns + +`string`[][] + +#### Overrides + +[Behaviour](Behaviour.md).[describe](Behaviour.md#describe) + +#### Defined in + +[elements/behaviours/IOBehaviour.ts:165](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/IOBehaviour.ts#L165) diff --git a/docs/api/classes/InstanceLocker.md b/docs/api/classes/InstanceLocker.md new file mode 100644 index 00000000..1a572c7b --- /dev/null +++ b/docs/api/classes/InstanceLocker.md @@ -0,0 +1,167 @@ +[bpmn-server](../API.md) / InstanceLocker + +# Class: InstanceLocker + +## Table of contents + +### Constructors + +- [constructor](InstanceLocker.md#constructor) + +### Properties + +- [dataStore](InstanceLocker.md#datastore) + +### Methods + +- [lock](InstanceLocker.md#lock) +- [try](InstanceLocker.md#try) +- [release](InstanceLocker.md#release) +- [delete](InstanceLocker.md#delete) +- [list](InstanceLocker.md#list) +- [delay](InstanceLocker.md#delay) + +## Constructors + +### constructor + +• **new InstanceLocker**(`dataStore`): [`InstanceLocker`](InstanceLocker.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dataStore` | `any` | + +#### Returns + +[`InstanceLocker`](InstanceLocker.md) + +#### Defined in + +[datastore/InstanceLocker.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/InstanceLocker.ts#L11) + +## Properties + +### dataStore + +• **dataStore**: `any` + +#### Defined in + +[datastore/InstanceLocker.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/InstanceLocker.ts#L9) + +## Methods + +### lock + +▸ **lock**(`id`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[datastore/InstanceLocker.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/InstanceLocker.ts#L14) + +___ + +### try + +▸ **try**(`id`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[datastore/InstanceLocker.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/InstanceLocker.ts#L35) + +___ + +### release + +▸ **release**(`id`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[datastore/InstanceLocker.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/InstanceLocker.ts#L52) + +___ + +### delete + +▸ **delete**(`query`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[datastore/InstanceLocker.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/InstanceLocker.ts#L58) + +___ + +### list + +▸ **list**(): `Promise`\<`any`\> + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[datastore/InstanceLocker.ts:63](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/InstanceLocker.ts#L63) + +___ + +### delay + +▸ **delay**(`time`, `result`): `Promise`\<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `time` | `any` | +| `result` | `any` | + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[datastore/InstanceLocker.ts:69](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/InstanceLocker.ts#L69) diff --git a/docs/api/classes/InstanceObject.md b/docs/api/classes/InstanceObject.md new file mode 100644 index 00000000..6c9b0a55 --- /dev/null +++ b/docs/api/classes/InstanceObject.md @@ -0,0 +1,271 @@ +[bpmn-server](../API.md) / InstanceObject + +# Class: InstanceObject + +as stored in MongoDB + +## Implements + +- [`IInstanceData`](../interfaces/IInstanceData.md) + +## Table of contents + +### Constructors + +- [constructor](InstanceObject.md#constructor) + +### Properties + +- [id](InstanceObject.md#id) +- [name](InstanceObject.md#name) +- [status](InstanceObject.md#status) +- [version](InstanceObject.md#version) +- [startedAt](InstanceObject.md#startedat) +- [endedAt](InstanceObject.md#endedat) +- [saved](InstanceObject.md#saved) +- [data](InstanceObject.md#data) +- [items](InstanceObject.md#items) +- [source](InstanceObject.md#source) +- [logs](InstanceObject.md#logs) +- [tokens](InstanceObject.md#tokens) +- [loops](InstanceObject.md#loops) +- [parentItemId](InstanceObject.md#parentitemid) +- [vars](InstanceObject.md#vars) +- [involvements](InstanceObject.md#involvements) +- [authorizations](InstanceObject.md#authorizations) + +## Constructors + +### constructor + +• **new InstanceObject**(): [`InstanceObject`](InstanceObject.md) + +#### Returns + +[`InstanceObject`](InstanceObject.md) + +## Properties + +### id + +• **id**: `any` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[id](../interfaces/IInstanceData.md#id) + +#### Defined in + +[engine/Model.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L9) + +___ + +### name + +• **name**: `any` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[name](../interfaces/IInstanceData.md#name) + +#### Defined in + +[engine/Model.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L10) + +___ + +### status + +• **status**: [`EXECUTION_STATUS`](../enums/EXECUTION_STATUS.md) + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[status](../interfaces/IInstanceData.md#status) + +#### Defined in + +[engine/Model.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L11) + +___ + +### version + +• **version**: `any` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[version](../interfaces/IInstanceData.md#version) + +#### Defined in + +[engine/Model.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L12) + +___ + +### startedAt + +• **startedAt**: `any` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[startedAt](../interfaces/IInstanceData.md#startedat) + +#### Defined in + +[engine/Model.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L13) + +___ + +### endedAt + +• **endedAt**: `any` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[endedAt](../interfaces/IInstanceData.md#endedat) + +#### Defined in + +[engine/Model.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L14) + +___ + +### saved + +• **saved**: `any` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[saved](../interfaces/IInstanceData.md#saved) + +#### Defined in + +[engine/Model.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L15) + +___ + +### data + +• **data**: `any` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[data](../interfaces/IInstanceData.md#data) + +#### Defined in + +[engine/Model.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L16) + +___ + +### items + +• **items**: `any`[] = `[]` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[items](../interfaces/IInstanceData.md#items) + +#### Defined in + +[engine/Model.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L17) + +___ + +### source + +• **source**: `any` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[source](../interfaces/IInstanceData.md#source) + +#### Defined in + +[engine/Model.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L18) + +___ + +### logs + +• **logs**: `any`[] = `[]` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[logs](../interfaces/IInstanceData.md#logs) + +#### Defined in + +[engine/Model.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L19) + +___ + +### tokens + +• **tokens**: `any`[] = `[]` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[tokens](../interfaces/IInstanceData.md#tokens) + +#### Defined in + +[engine/Model.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L20) + +___ + +### loops + +• **loops**: `any`[] = `[]` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[loops](../interfaces/IInstanceData.md#loops) + +#### Defined in + +[engine/Model.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L21) + +___ + +### parentItemId + +• **parentItemId**: `any` + +#### Implementation of + +[IInstanceData](../interfaces/IInstanceData.md).[parentItemId](../interfaces/IInstanceData.md#parentitemid) + +#### Defined in + +[engine/Model.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L22) + +___ + +### vars + +• **vars**: `any` + +#### Defined in + +[engine/Model.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L23) + +___ + +### involvements + +• **involvements**: `any` + +#### Defined in + +[engine/Model.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L24) + +___ + +### authorizations + +• **authorizations**: `any` + +#### Defined in + +[engine/Model.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L25) diff --git a/docs/api/classes/Item.md b/docs/api/classes/Item.md new file mode 100644 index 00000000..a0029802 --- /dev/null +++ b/docs/api/classes/Item.md @@ -0,0 +1,617 @@ +[bpmn-server](../API.md) / Item + +# Class: Item + +## Implements + +- [`IItem`](../interfaces/IItem.md) + +## Table of contents + +### Constructors + +- [constructor](Item.md#constructor) + +### Properties + +- [id](Item.md#id) +- [itemKey](Item.md#itemkey) +- [element](Item.md#element) +- [token](Item.md#token) +- [seq](Item.md#seq) +- [userName](Item.md#username) +- [startedAt](Item.md#startedat) +- [endedAt](Item.md#endedat) +- [instanceId](Item.md#instanceid) +- [input](Item.md#input) +- [output](Item.md#output) +- [vars](Item.md#vars) +- [assignee](Item.md#assignee) +- [candidateGroups](Item.md#candidategroups) +- [candidateUsers](Item.md#candidateusers) +- [dueDate](Item.md#duedate) +- [followUpDate](Item.md#followupdate) +- [priority](Item.md#priority) +- [status](Item.md#status) +- [timeDue](Item.md#timedue) +- [timerCount](Item.md#timercount) +- [messageId](Item.md#messageid) +- [signalId](Item.md#signalid) + +### Accessors + +- [data](Item.md#data) +- [options](Item.md#options) +- [context](Item.md#context) +- [elementId](Item.md#elementid) +- [name](Item.md#name) +- [tokenId](Item.md#tokenid) +- [type](Item.md#type) +- [node](Item.md#node) + +### Methods + +- [log](Item.md#log) +- [setData](Item.md#setdata) +- [save](Item.md#save) +- [load](Item.md#load) + +## Constructors + +### constructor + +• **new Item**(`element`, `token`, `status?`): [`Item`](Item.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `element` | `any` | `undefined` | +| `token` | `any` | `undefined` | +| `status` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | `ITEM_STATUS.start` | + +#### Returns + +[`Item`](Item.md) + +#### Defined in + +[engine/Item.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L55) + +## Properties + +### id + +• **id**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[id](../interfaces/IItem.md#id) + +#### Defined in + +[engine/Item.ts:8](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L8) + +___ + +### itemKey + +• **itemKey**: `string` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[itemKey](../interfaces/IItem.md#itemkey) + +#### Defined in + +[engine/Item.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L9) + +___ + +### element + +• **element**: [`Element`](Element.md) + +#### Implementation of + +[IItem](../interfaces/IItem.md).[element](../interfaces/IItem.md#element) + +#### Defined in + +[engine/Item.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L10) + +___ + +### token + +• **token**: [`Token`](Token.md) + +#### Implementation of + +[IItem](../interfaces/IItem.md).[token](../interfaces/IItem.md#token) + +#### Defined in + +[engine/Item.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L11) + +___ + +### seq + +• **seq**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[seq](../interfaces/IItem.md#seq) + +#### Defined in + +[engine/Item.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L12) + +___ + +### userName + +• **userName**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[userName](../interfaces/IItem.md#username) + +#### Defined in + +[engine/Item.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L13) + +___ + +### startedAt + +• **startedAt**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[startedAt](../interfaces/IItem.md#startedat) + +#### Defined in + +[engine/Item.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L14) + +___ + +### endedAt + +• **endedAt**: `any` = `null` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[endedAt](../interfaces/IItem.md#endedat) + +#### Defined in + +[engine/Item.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L15) + +___ + +### instanceId + +• **instanceId**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[instanceId](../interfaces/IItem.md#instanceid) + +#### Defined in + +[engine/Item.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L16) + +___ + +### input + +• **input**: `Object` = `{}` + +#### Defined in + +[engine/Item.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L17) + +___ + +### output + +• **output**: `Object` = `{}` + +#### Defined in + +[engine/Item.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L18) + +___ + +### vars + +• **vars**: `Object` = `{}` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[vars](../interfaces/IItem.md#vars) + +#### Defined in + +[engine/Item.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L19) + +___ + +### assignee + +• **assignee**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[assignee](../interfaces/IItem.md#assignee) + +#### Defined in + +[engine/Item.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L20) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[candidateGroups](../interfaces/IItem.md#candidategroups) + +#### Defined in + +[engine/Item.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L21) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[candidateUsers](../interfaces/IItem.md#candidateusers) + +#### Defined in + +[engine/Item.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L22) + +___ + +### dueDate + +• **dueDate**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[dueDate](../interfaces/IItem.md#duedate) + +#### Defined in + +[engine/Item.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L23) + +___ + +### followUpDate + +• **followUpDate**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[followUpDate](../interfaces/IItem.md#followupdate) + +#### Defined in + +[engine/Item.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L24) + +___ + +### priority + +• **priority**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[priority](../interfaces/IItem.md#priority) + +#### Defined in + +[engine/Item.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L25) + +___ + +### status + +• **status**: [`ITEM_STATUS`](../enums/ITEM_STATUS.md) + +#### Implementation of + +[IItem](../interfaces/IItem.md).[status](../interfaces/IItem.md#status) + +#### Defined in + +[engine/Item.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L28) + +___ + +### timeDue + +• **timeDue**: `Date` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[timeDue](../interfaces/IItem.md#timedue) + +#### Defined in + +[engine/Item.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L49) + +___ + +### timerCount + +• **timerCount**: `any` + +#### Defined in + +[engine/Item.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L50) + +___ + +### messageId + +• **messageId**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[messageId](../interfaces/IItem.md#messageid) + +#### Defined in + +[engine/Item.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L52) + +___ + +### signalId + +• **signalId**: `any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[signalId](../interfaces/IItem.md#signalid) + +#### Defined in + +[engine/Item.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L53) + +## Accessors + +### data + +• `get` **data**(): `any` + +#### Returns + +`any` + +#### Defined in + +[engine/Item.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L30) + +• `set` **data**(`val`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `any` | + +#### Returns + +`void` + +#### Defined in + +[engine/Item.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L31) + +___ + +### options + +• `get` **options**(): `any` + +#### Returns + +`any` + +#### Defined in + +[engine/Item.ts:33](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L33) + +___ + +### context + +• `get` **context**(): [`IExecution`](../interfaces/IExecution.md) + +#### Returns + +[`IExecution`](../interfaces/IExecution.md) + +#### Implementation of + +[IItem](../interfaces/IItem.md).[context](../interfaces/IItem.md#context) + +#### Defined in + +[engine/Item.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L34) + +___ + +### elementId + +• `get` **elementId**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[elementId](../interfaces/IItem.md#elementid) + +#### Defined in + +[engine/Item.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L35) + +___ + +### name + +• `get` **name**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[name](../interfaces/IItem.md#name) + +#### Defined in + +[engine/Item.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L36) + +___ + +### tokenId + +• `get` **tokenId**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[tokenId](../interfaces/IItem.md#tokenid) + +#### Defined in + +[engine/Item.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L39) + +___ + +### type + +• `get` **type**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IItem](../interfaces/IItem.md).[type](../interfaces/IItem.md#type) + +#### Defined in + +[engine/Item.ts:42](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L42) + +___ + +### node + +• `get` **node**(): [`Node`](Node.md) + +#### Returns + +[`Node`](Node.md) + +#### Implementation of + +[IItem](../interfaces/IItem.md).[node](../interfaces/IItem.md#node) + +#### Defined in + +[engine/Item.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L45) + +## Methods + +### log + +▸ **log**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `any` | + +#### Returns + +`void` + +#### Defined in + +[engine/Item.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L29) + +___ + +### setData + +▸ **setData**(`val`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `any` | + +#### Returns + +`void` + +#### Defined in + +[engine/Item.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L32) + +___ + +### save + +▸ **save**(): [`IItemData`](../interfaces/IItemData.md) + +#### Returns + +[`IItemData`](../interfaces/IItemData.md) + +#### Defined in + +[engine/Item.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L64) + +___ + +### load + +▸ **load**(`execution`, `dataObject`, `token`): [`Item`](Item.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`Execution`](Execution.md) | +| `dataObject` | [`IItemData`](../interfaces/IItemData.md) | +| `token` | `any` | + +#### Returns + +[`Item`](Item.md) + +#### Defined in + +[engine/Item.ts:80](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Item.ts#L80) diff --git a/docs/api/classes/ItemObject.md b/docs/api/classes/ItemObject.md new file mode 100644 index 00000000..637f45f3 --- /dev/null +++ b/docs/api/classes/ItemObject.md @@ -0,0 +1,419 @@ +[bpmn-server](../API.md) / ItemObject + +# Class: ItemObject + +as stroed in MongoDB + +## Implements + +- [`IItemData`](../interfaces/IItemData.md) + +## Table of contents + +### Constructors + +- [constructor](ItemObject.md#constructor) + +### Properties + +- [id](ItemObject.md#id) +- [seq](ItemObject.md#seq) +- [itemKey](ItemObject.md#itemkey) +- [name](ItemObject.md#name) +- [type](ItemObject.md#type) +- [status](ItemObject.md#status) +- [userName](ItemObject.md#username) +- [startedAt](ItemObject.md#startedat) +- [endedAt](ItemObject.md#endedat) +- [tokenId](ItemObject.md#tokenid) +- [elementId](ItemObject.md#elementid) +- [instanceId](ItemObject.md#instanceid) +- [processName](ItemObject.md#processname) +- [timeDue](ItemObject.md#timedue) +- [data](ItemObject.md#data) +- [vars](ItemObject.md#vars) +- [messageId](ItemObject.md#messageid) +- [signalId](ItemObject.md#signalid) +- [assignee](ItemObject.md#assignee) +- [candidateGroups](ItemObject.md#candidategroups) +- [candidateUsers](ItemObject.md#candidateusers) +- [dueDate](ItemObject.md#duedate) +- [followUpDate](ItemObject.md#followupdate) +- [priority](ItemObject.md#priority) +- [assignments](ItemObject.md#assignments) +- [authorizations](ItemObject.md#authorizations) +- [notifications](ItemObject.md#notifications) + +## Constructors + +### constructor + +• **new ItemObject**(): [`ItemObject`](ItemObject.md) + +#### Returns + +[`ItemObject`](ItemObject.md) + +## Properties + +### id + +• **id**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[id](../interfaces/IItemData.md#id) + +#### Defined in + +[engine/Model.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L32) + +___ + +### seq + +• **seq**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[seq](../interfaces/IItemData.md#seq) + +#### Defined in + +[engine/Model.ts:33](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L33) + +___ + +### itemKey + +• **itemKey**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[itemKey](../interfaces/IItemData.md#itemkey) + +#### Defined in + +[engine/Model.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L34) + +___ + +### name + +• **name**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[name](../interfaces/IItemData.md#name) + +#### Defined in + +[engine/Model.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L35) + +___ + +### type + +• **type**: [`BPMN_TYPE`](../enums/BPMN_TYPE.md) + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[type](../interfaces/IItemData.md#type) + +#### Defined in + +[engine/Model.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L36) + +___ + +### status + +• **status**: [`ITEM_STATUS`](../enums/ITEM_STATUS.md) + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[status](../interfaces/IItemData.md#status) + +#### Defined in + +[engine/Model.ts:37](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L37) + +___ + +### userName + +• **userName**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[userName](../interfaces/IItemData.md#username) + +#### Defined in + +[engine/Model.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L38) + +___ + +### startedAt + +• **startedAt**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[startedAt](../interfaces/IItemData.md#startedat) + +#### Defined in + +[engine/Model.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L39) + +___ + +### endedAt + +• **endedAt**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[endedAt](../interfaces/IItemData.md#endedat) + +#### Defined in + +[engine/Model.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L40) + +___ + +### tokenId + +• **tokenId**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[tokenId](../interfaces/IItemData.md#tokenid) + +#### Defined in + +[engine/Model.ts:42](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L42) + +___ + +### elementId + +• **elementId**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[elementId](../interfaces/IItemData.md#elementid) + +#### Defined in + +[engine/Model.ts:43](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L43) + +___ + +### instanceId + +• **instanceId**: `any` + +retrieved from findObjects + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[instanceId](../interfaces/IItemData.md#instanceid) + +#### Defined in + +[engine/Model.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L47) + +___ + +### processName + +• **processName**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[processName](../interfaces/IItemData.md#processname) + +#### Defined in + +[engine/Model.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L48) + +___ + +### timeDue + +• **timeDue**: `Date` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[timeDue](../interfaces/IItemData.md#timedue) + +#### Defined in + +[engine/Model.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L49) + +___ + +### data + +• **data**: `any` + +#### Defined in + +[engine/Model.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L50) + +___ + +### vars + +• **vars**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[vars](../interfaces/IItemData.md#vars) + +#### Defined in + +[engine/Model.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L51) + +___ + +### messageId + +• **messageId**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[messageId](../interfaces/IItemData.md#messageid) + +#### Defined in + +[engine/Model.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L52) + +___ + +### signalId + +• **signalId**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[signalId](../interfaces/IItemData.md#signalid) + +#### Defined in + +[engine/Model.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L53) + +___ + +### assignee + +• **assignee**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[assignee](../interfaces/IItemData.md#assignee) + +#### Defined in + +[engine/Model.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L54) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[candidateGroups](../interfaces/IItemData.md#candidategroups) + +#### Defined in + +[engine/Model.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L55) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[candidateUsers](../interfaces/IItemData.md#candidateusers) + +#### Defined in + +[engine/Model.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L56) + +___ + +### dueDate + +• **dueDate**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[dueDate](../interfaces/IItemData.md#duedate) + +#### Defined in + +[engine/Model.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L57) + +___ + +### followUpDate + +• **followUpDate**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[followUpDate](../interfaces/IItemData.md#followupdate) + +#### Defined in + +[engine/Model.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L58) + +___ + +### priority + +• **priority**: `any` + +#### Implementation of + +[IItemData](../interfaces/IItemData.md).[priority](../interfaces/IItemData.md#priority) + +#### Defined in + +[engine/Model.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L59) + +___ + +### assignments + +• **assignments**: `any` + +#### Defined in + +[engine/Model.ts:60](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L60) + +___ + +### authorizations + +• **authorizations**: `any` + +#### Defined in + +[engine/Model.ts:61](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L61) + +___ + +### notifications + +• **notifications**: `any` + +#### Defined in + +[engine/Model.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L62) diff --git a/docs/api/classes/Logger.md b/docs/api/classes/Logger.md new file mode 100644 index 00000000..cb74f441 --- /dev/null +++ b/docs/api/classes/Logger.md @@ -0,0 +1,401 @@ +[bpmn-server](../API.md) / Logger + +# Class: Logger + +A logging tool to take various message for monitoring and debugging + +it can also keep the message in memory till saved later through saveToFile +msgs can be cleared by the clean method + +## Implements + +- [`ILogger`](../interfaces/ILogger.md) + +## Table of contents + +### Constructors + +- [constructor](Logger.md#constructor) + +### Properties + +- [debugMsgs](Logger.md#debugmsgs) +- [toConsole](Logger.md#toconsole) +- [toFile](Logger.md#tofile) +- [callback](Logger.md#callback) + +### Methods + +- [setOptions](Logger.md#setoptions) +- [msg](Logger.md#msg) +- [clear](Logger.md#clear) +- [get](Logger.md#get) +- [info](Logger.md#info) +- [debug](Logger.md#debug) +- [warn](Logger.md#warn) +- [log](Logger.md#log) +- [toString](Logger.md#tostring) +- [reportError](Logger.md#reporterror) +- [error](Logger.md#error) +- [save](Logger.md#save) + +## Constructors + +### constructor + +• **new Logger**(`«destructured»`): [`Logger`](Logger.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `toConsole` | `boolean` | +| › `toFile` | `string` | +| › `callback` | `any` | + +#### Returns + +[`Logger`](Logger.md) + +#### Defined in + +[common/Logger.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L14) + +## Properties + +### debugMsgs + +• **debugMsgs**: `any`[] = `[]` + +#### Defined in + +[common/Logger.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L9) + +___ + +### toConsole + +• **toConsole**: `boolean` = `true` + +#### Defined in + +[common/Logger.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L10) + +___ + +### toFile + +• **toFile**: `any` = `null` + +#### Defined in + +[common/Logger.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L11) + +___ + +### callback + +• **callback**: `any` = `null` + +#### Defined in + +[common/Logger.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L12) + +## Methods + +### setOptions + +▸ **setOptions**(`«destructured»`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `toConsole` | `any` | +| › `toFile` | `any` | +| › `callback` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[ILogger](../interfaces/ILogger.md).[setOptions](../interfaces/ILogger.md#setoptions) + +#### Defined in + +[common/Logger.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L17) + +___ + +### msg + +▸ **msg**(`message`, `type?`): `Object` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `message` | `any` | `undefined` | +| `type` | `string` | `'log'` | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `date` | `Date` | +| `message` | `any` | +| `type` | `string` | + +#### Defined in + +[common/Logger.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L23) + +___ + +### clear + +▸ **clear**(): `void` + +#### Returns + +`void` + +#### Implementation of + +[ILogger](../interfaces/ILogger.md).[clear](../interfaces/ILogger.md#clear) + +#### Defined in + +[common/Logger.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L36) + +___ + +### get + +▸ **get**(): `any`[] + +#### Returns + +`any`[] + +#### Implementation of + +[ILogger](../interfaces/ILogger.md).[get](../interfaces/ILogger.md#get) + +#### Defined in + +[common/Logger.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L40) + +___ + +### info + +▸ **info**(`...message`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...message` | `any`[] | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `date` | `Date` | +| `message` | `any` | +| `type` | `string` | + +#### Defined in + +[common/Logger.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L44) + +___ + +### debug + +▸ **debug**(`...message`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...message` | `any`[] | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `date` | `Date` | +| `message` | `any` | +| `type` | `string` | + +#### Implementation of + +[ILogger](../interfaces/ILogger.md).[debug](../interfaces/ILogger.md#debug) + +#### Defined in + +[common/Logger.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L47) + +___ + +### warn + +▸ **warn**(`...message`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...message` | `any`[] | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `date` | `Date` | +| `message` | `any` | +| `type` | `string` | + +#### Implementation of + +[ILogger](../interfaces/ILogger.md).[warn](../interfaces/ILogger.md#warn) + +#### Defined in + +[common/Logger.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L51) + +___ + +### log + +▸ **log**(`...message`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...message` | `any`[] | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `date` | `Date` | +| `message` | `any` | +| `type` | `string` | + +#### Implementation of + +[ILogger](../interfaces/ILogger.md).[log](../interfaces/ILogger.md#log) + +#### Defined in + +[common/Logger.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L54) + +___ + +### toString + +▸ **toString**(`...args`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | `any`[] | + +#### Returns + +`string` + +#### Defined in + +[common/Logger.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L57) + +___ + +### reportError + +▸ **reportError**(`err`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[ILogger](../interfaces/ILogger.md).[reportError](../interfaces/ILogger.md#reporterror) + +#### Defined in + +[common/Logger.ts:77](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L77) + +___ + +### error + +▸ **error**(`err`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[ILogger](../interfaces/ILogger.md).[error](../interfaces/ILogger.md#error) + +#### Defined in + +[common/Logger.ts:94](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L94) + +___ + +### save + +▸ **save**(`filename`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `filename` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[ILogger](../interfaces/ILogger.md).[save](../interfaces/ILogger.md#save) + +#### Defined in + +[common/Logger.ts:97](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/Logger.ts#L97) diff --git a/docs/api/classes/Loop.md b/docs/api/classes/Loop.md new file mode 100644 index 00000000..7649d812 --- /dev/null +++ b/docs/api/classes/Loop.md @@ -0,0 +1,288 @@ +[bpmn-server](../API.md) / Loop + +# Class: Loop + +## Table of contents + +### Constructors + +- [constructor](Loop.md#constructor) + +### Properties + +- [id](Loop.md#id) +- [node](Loop.md#node) +- [ownerToken](Loop.md#ownertoken) +- [definition](Loop.md#definition) +- [sequence](Loop.md#sequence) +- [dataPath](Loop.md#datapath) +- [items](Loop.md#items) +- [completed](Loop.md#completed) + +### Methods + +- [isSequential](Loop.md#issequential) +- [isStandard](Loop.md#isstandard) +- [save](Loop.md#save) +- [load](Loop.md#load) +- [getKeyName](Loop.md#getkeyname) +- [isDone](Loop.md#isdone) +- [getNext](Loop.md#getnext) +- [checkStart](Loop.md#checkstart) +- [checkNext](Loop.md#checknext) + +## Constructors + +### constructor + +• **new Loop**(`node`, `token`, `dataObject?`): [`Loop`](Loop.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `token` | [`Token`](Token.md) | +| `dataObject?` | `any` | + +#### Returns + +[`Loop`](Loop.md) + +#### Defined in + +[engine/Loop.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L19) + +## Properties + +### id + +• **id**: `any` + +#### Defined in + +[engine/Loop.ts:8](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L8) + +___ + +### node + +• **node**: `any` + +#### Defined in + +[engine/Loop.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L9) + +___ + +### ownerToken + +• **ownerToken**: `any` + +#### Defined in + +[engine/Loop.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L10) + +___ + +### definition + +• **definition**: [`LoopBehaviour`](LoopBehaviour.md) + +#### Defined in + +[engine/Loop.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L11) + +___ + +### sequence + +• **sequence**: `any` + +#### Defined in + +[engine/Loop.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L12) + +___ + +### dataPath + +• **dataPath**: `any` + +#### Defined in + +[engine/Loop.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L13) + +___ + +### items + +• **items**: `any`[] + +#### Defined in + +[engine/Loop.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L14) + +___ + +### completed + +• **completed**: `any` + +#### Defined in + +[engine/Loop.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L15) + +## Methods + +### isSequential + +▸ **isSequential**(): `any` + +#### Returns + +`any` + +#### Defined in + +[engine/Loop.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L16) + +___ + +### isStandard + +▸ **isStandard**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[engine/Loop.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L17) + +___ + +### save + +▸ **save**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `nodeId` | `any` | +| `ownerTokenId` | `any` | +| `dataPath` | `any` | +| `completed` | `any` | +| `sequence` | `any` | + +#### Defined in + +[engine/Loop.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L45) + +___ + +### load + +▸ **load**(`execution`, `dataObject`): [`Loop`](Loop.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | `any` | +| `dataObject` | `any` | + +#### Returns + +[`Loop`](Loop.md) + +#### Defined in + +[engine/Loop.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L52) + +___ + +### getKeyName + +▸ **getKeyName**(): `string` + +#### Returns + +`string` + +#### Defined in + +[engine/Loop.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L62) + +___ + +### isDone + +▸ **isDone**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[engine/Loop.ts:65](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L65) + +___ + +### getNext + +▸ **getNext**(): `any` + +#### Returns + +`any` + +#### Defined in + +[engine/Loop.ts:68](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L68) + +___ + +### checkStart + +▸ **checkStart**(`token`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `any` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[engine/Loop.ts:75](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L75) + +___ + +### checkNext + +▸ **checkNext**(`token`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | [`Token`](Token.md) | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[engine/Loop.ts:142](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Loop.ts#L142) diff --git a/docs/api/classes/LoopBehaviour.md b/docs/api/classes/LoopBehaviour.md new file mode 100644 index 00000000..ff742585 --- /dev/null +++ b/docs/api/classes/LoopBehaviour.md @@ -0,0 +1,395 @@ +[bpmn-server](../API.md) / LoopBehaviour + +# Class: LoopBehaviour + +1. sequential: + +2. parallel + +3. repeater + + +## Hierarchy + +- [`Behaviour`](Behaviour.md) + + ↳ **`LoopBehaviour`** + +## Table of contents + +### Constructors + +- [constructor](LoopBehaviour.md#constructor) + +### Properties + +- [node](LoopBehaviour.md#node) +- [definition](LoopBehaviour.md#definition) + +### Accessors + +- [collection](LoopBehaviour.md#collection) + +### Methods + +- [restored](LoopBehaviour.md#restored) +- [enter](LoopBehaviour.md#enter) +- [start](LoopBehaviour.md#start) +- [run](LoopBehaviour.md#run) +- [end](LoopBehaviour.md#end) +- [exit](LoopBehaviour.md#exit) +- [resume](LoopBehaviour.md#resume) +- [getNodeAttributes](LoopBehaviour.md#getnodeattributes) +- [getItemAttributes](LoopBehaviour.md#getitemattributes) +- [init](LoopBehaviour.md#init) +- [isStandard](LoopBehaviour.md#isstandard) +- [isSequential](LoopBehaviour.md#issequential) +- [describe](LoopBehaviour.md#describe) + +## Constructors + +### constructor + +• **new LoopBehaviour**(`node`, `definition`): [`LoopBehaviour`](LoopBehaviour.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `definition` | `any` | + +#### Returns + +[`LoopBehaviour`](LoopBehaviour.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[constructor](Behaviour.md#constructor) + +#### Defined in + +[elements/behaviours/Behaviour.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L40) + +## Properties + +### node + +• **node**: [`Node`](Node.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[node](Behaviour.md#node) + +#### Defined in + +[elements/behaviours/Behaviour.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L38) + +___ + +### definition + +• **definition**: `any` + +#### Inherited from + +[Behaviour](Behaviour.md).[definition](Behaviour.md#definition) + +#### Defined in + +[elements/behaviours/Behaviour.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L39) + +## Accessors + +### collection + +• `get` **collection**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Loop.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Loop.ts#L20) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[restored](Behaviour.md#restored) + +#### Defined in + +[elements/behaviours/Behaviour.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L45) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[enter](Behaviour.md#enter) + +#### Defined in + +[elements/behaviours/Behaviour.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L48) + +___ + +### start + +▸ **start**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[start](Behaviour.md#start) + +#### Defined in + +[elements/behaviours/Behaviour.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L49) + +___ + +### run + +▸ **run**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[run](Behaviour.md#run) + +#### Defined in + +[elements/behaviours/Behaviour.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L50) + +___ + +### end + +▸ **end**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[end](Behaviour.md#end) + +#### Defined in + +[elements/behaviours/Behaviour.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L51) + +___ + +### exit + +▸ **exit**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[exit](Behaviour.md#exit) + +#### Defined in + +[elements/behaviours/Behaviour.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L52) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[resume](Behaviour.md#resume) + +#### Defined in + +[elements/behaviours/Behaviour.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L53) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getNodeAttributes](Behaviour.md#getnodeattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L54) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getItemAttributes](Behaviour.md#getitemattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L55) + +___ + +### init + +▸ **init**(): `void` + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[init](Behaviour.md#init) + +#### Defined in + +[elements/behaviours/Loop.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Loop.ts#L17) + +___ + +### isStandard + +▸ **isStandard**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[elements/behaviours/Loop.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Loop.ts#L29) + +___ + +### isSequential + +▸ **isSequential**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Loop.ts:33](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Loop.ts#L33) + +___ + +### describe + +▸ **describe**(): `string`[][] + +#### Returns + +`string`[][] + +#### Overrides + +[Behaviour](Behaviour.md).[describe](Behaviour.md#describe) + +#### Defined in + +[elements/behaviours/Loop.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Loop.ts#L39) diff --git a/docs/api/classes/LoopObject.md b/docs/api/classes/LoopObject.md new file mode 100644 index 00000000..21ade9b9 --- /dev/null +++ b/docs/api/classes/LoopObject.md @@ -0,0 +1,66 @@ +[bpmn-server](../API.md) / LoopObject + +# Class: LoopObject + +## Table of contents + +### Constructors + +- [constructor](LoopObject.md#constructor) + +### Properties + +- [nodeId](LoopObject.md#nodeid) +- [ownerTokenId](LoopObject.md#ownertokenid) +- [dataPath](LoopObject.md#datapath) +- [sequence](LoopObject.md#sequence) + +## Constructors + +### constructor + +• **new LoopObject**(): [`LoopObject`](LoopObject.md) + +#### Returns + +[`LoopObject`](LoopObject.md) + +## Properties + +### nodeId + +• **nodeId**: `any` + +#### Defined in + +[engine/Model.ts:77](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L77) + +___ + +### ownerTokenId + +• **ownerTokenId**: `any` + +#### Defined in + +[engine/Model.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L78) + +___ + +### dataPath + +• **dataPath**: `any` + +#### Defined in + +[engine/Model.ts:79](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L79) + +___ + +### sequence + +• **sequence**: `any` + +#### Defined in + +[engine/Model.ts:80](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L80) diff --git a/docs/api/classes/MessageEventBehaviour.md b/docs/api/classes/MessageEventBehaviour.md new file mode 100644 index 00000000..b680b880 --- /dev/null +++ b/docs/api/classes/MessageEventBehaviour.md @@ -0,0 +1,364 @@ +[bpmn-server](../API.md) / MessageEventBehaviour + +# Class: MessageEventBehaviour + +it is part of the following: + + events + sendTask + receiveTask + +## Hierarchy + +- [`Behaviour`](Behaviour.md) + + ↳ **`MessageEventBehaviour`** + +## Table of contents + +### Constructors + +- [constructor](MessageEventBehaviour.md#constructor) + +### Properties + +- [node](MessageEventBehaviour.md#node) +- [definition](MessageEventBehaviour.md#definition) + +### Accessors + +- [messageId](MessageEventBehaviour.md#messageid) + +### Methods + +- [restored](MessageEventBehaviour.md#restored) +- [enter](MessageEventBehaviour.md#enter) +- [run](MessageEventBehaviour.md#run) +- [exit](MessageEventBehaviour.md#exit) +- [resume](MessageEventBehaviour.md#resume) +- [getNodeAttributes](MessageEventBehaviour.md#getnodeattributes) +- [getItemAttributes](MessageEventBehaviour.md#getitemattributes) +- [init](MessageEventBehaviour.md#init) +- [start](MessageEventBehaviour.md#start) +- [end](MessageEventBehaviour.md#end) +- [describe](MessageEventBehaviour.md#describe) + +## Constructors + +### constructor + +• **new MessageEventBehaviour**(`node`, `definition`): [`MessageEventBehaviour`](MessageEventBehaviour.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `definition` | `any` | + +#### Returns + +[`MessageEventBehaviour`](MessageEventBehaviour.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[constructor](Behaviour.md#constructor) + +#### Defined in + +[elements/behaviours/Behaviour.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L40) + +## Properties + +### node + +• **node**: [`Node`](Node.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[node](Behaviour.md#node) + +#### Defined in + +[elements/behaviours/Behaviour.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L38) + +___ + +### definition + +• **definition**: `any` + +#### Inherited from + +[Behaviour](Behaviour.md).[definition](Behaviour.md#definition) + +#### Defined in + +[elements/behaviours/Behaviour.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L39) + +## Accessors + +### messageId + +• `get` **messageId**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/MessageSignal.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L38) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[restored](Behaviour.md#restored) + +#### Defined in + +[elements/behaviours/Behaviour.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L45) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[enter](Behaviour.md#enter) + +#### Defined in + +[elements/behaviours/Behaviour.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L48) + +___ + +### run + +▸ **run**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[run](Behaviour.md#run) + +#### Defined in + +[elements/behaviours/Behaviour.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L50) + +___ + +### exit + +▸ **exit**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[exit](Behaviour.md#exit) + +#### Defined in + +[elements/behaviours/Behaviour.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L52) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[resume](Behaviour.md#resume) + +#### Defined in + +[elements/behaviours/Behaviour.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L53) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getNodeAttributes](Behaviour.md#getnodeattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L54) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getItemAttributes](Behaviour.md#getitemattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L55) + +___ + +### init + +▸ **init**(): `void` + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[init](Behaviour.md#init) + +#### Defined in + +[elements/behaviours/MessageSignal.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L17) + +___ + +### start + +▸ **start**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[Behaviour](Behaviour.md).[start](Behaviour.md#start) + +#### Defined in + +[elements/behaviours/MessageSignal.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L22) + +___ + +### end + +▸ **end**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[end](Behaviour.md#end) + +#### Defined in + +[elements/behaviours/MessageSignal.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L35) + +___ + +### describe + +▸ **describe**(): `string`[][] + +#### Returns + +`string`[][] + +#### Overrides + +[Behaviour](Behaviour.md).[describe](Behaviour.md#describe) + +#### Defined in + +[elements/behaviours/MessageSignal.ts:42](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L42) diff --git a/docs/api/classes/MessageFlow.md b/docs/api/classes/MessageFlow.md new file mode 100644 index 00000000..6eb48517 --- /dev/null +++ b/docs/api/classes/MessageFlow.md @@ -0,0 +1,474 @@ +[bpmn-server](../API.md) / MessageFlow + +# Class: MessageFlow + +```xml +MessageFlow: can only be sent to active node in waiting + * or to a start event + +``` + +## Hierarchy + +- [`Flow`](Flow.md) + + ↳ **`MessageFlow`** + +## Table of contents + +### Constructors + +- [constructor](MessageFlow.md#constructor) + +### Properties + +- [id](MessageFlow.md#id) +- [type](MessageFlow.md#type) +- [subType](MessageFlow.md#subtype) +- [name](MessageFlow.md#name) +- [behaviours](MessageFlow.md#behaviours) +- [isFlow](MessageFlow.md#isflow) +- [lane](MessageFlow.md#lane) +- [from](MessageFlow.md#from) +- [to](MessageFlow.md#to) +- [def](MessageFlow.md#def) +- [isMessageFlow](MessageFlow.md#ismessageflow) + +### Methods + +- [continue](MessageFlow.md#continue) +- [restored](MessageFlow.md#restored) +- [resume](MessageFlow.md#resume) +- [hasBehaviour](MessageFlow.md#hasbehaviour) +- [getBehaviour](MessageFlow.md#getbehaviour) +- [addBehaviour](MessageFlow.md#addbehaviour) +- [describe](MessageFlow.md#describe) +- [run](MessageFlow.md#run) +- [evaluateCondition](MessageFlow.md#evaluatecondition) +- [execute](MessageFlow.md#execute) + +## Constructors + +### constructor + +• **new MessageFlow**(`id`, `type`, `from`, `to`, `def`): [`MessageFlow`](MessageFlow.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `type` | `any` | +| `from` | `any` | +| `to` | `any` | +| `def` | `any` | + +#### Returns + +[`MessageFlow`](MessageFlow.md) + +#### Inherited from + +[Flow](Flow.md).[constructor](Flow.md#constructor) + +#### Defined in + +[elements/Flow.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L16) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Flow](Flow.md).[id](Flow.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Flow](Flow.md).[type](Flow.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Flow](Flow.md).[subType](Flow.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Flow](Flow.md).[name](Flow.md#name) + +#### Defined in + +[elements/Element.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L16) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Flow](Flow.md).[behaviours](Flow.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Flow](Flow.md).[isFlow](Flow.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Flow](Flow.md).[lane](Flow.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### from + +• **from**: [`Node`](Node.md) + +#### Inherited from + +[Flow](Flow.md).[from](Flow.md#from) + +#### Defined in + +[elements/Flow.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L12) + +___ + +### to + +• **to**: [`Node`](Node.md) + +#### Inherited from + +[Flow](Flow.md).[to](Flow.md#to) + +#### Defined in + +[elements/Flow.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Flow](Flow.md).[def](Flow.md#def) + +#### Defined in + +[elements/Flow.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L14) + +___ + +### isMessageFlow + +• **isMessageFlow**: `boolean` = `true` + +#### Overrides + +[Flow](Flow.md).[isMessageFlow](Flow.md#ismessageflow) + +#### Defined in + +[elements/Flow.ts:80](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L80) + +## Methods + +### continue + +▸ **continue**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Flow](Flow.md).[continue](Flow.md#continue) + +#### Defined in + +[elements/Element.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L20) + +___ + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Flow](Flow.md).[restored](Flow.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Flow](Flow.md).[resume](Flow.md#resume) + +#### Defined in + +[elements/Element.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L27) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Flow](Flow.md).[hasBehaviour](Flow.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Flow](Flow.md).[getBehaviour](Flow.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Flow](Flow.md).[addBehaviour](Flow.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### describe + +▸ **describe**(): `any`[][] + +#### Returns + +`any`[][] + +#### Inherited from + +[Flow](Flow.md).[describe](Flow.md#describe) + +#### Defined in + +[elements/Flow.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L26) + +___ + +### run + +▸ **run**(`item`): [`FLOW_ACTION`](../enums/FLOW_ACTION.md) + +```xml + if flow has a condition, it must be evaluated and if result is true flow will continue + otherwise, flow will be discarded. + +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`FLOW_ACTION`](../enums/FLOW_ACTION.md) + +#### Inherited from + +[Flow](Flow.md).[run](Flow.md#run) + +#### Defined in + +[elements/Flow.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L44) + +___ + +### evaluateCondition + +▸ **evaluateCondition**(`item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Flow](Flow.md).[evaluateCondition](Flow.md#evaluatecondition) + +#### Defined in + +[elements/Flow.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L54) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[Flow](Flow.md).[execute](Flow.md#execute) + +#### Defined in + +[elements/Flow.ts:82](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Flow.ts#L82) diff --git a/docs/api/classes/ModelsDatastore.md b/docs/api/classes/ModelsDatastore.md new file mode 100644 index 00000000..485824c1 --- /dev/null +++ b/docs/api/classes/ModelsDatastore.md @@ -0,0 +1,813 @@ +[bpmn-server](../API.md) / ModelsDatastore + +# Class: ModelsDatastore + +super class for various objects that are part of the server + +## Hierarchy + +- [`ModelsDatastoreDB`](ModelsDatastoreDB.md) + + ↳ **`ModelsDatastore`** + +## Implements + +- [`IModelsDatastore`](../interfaces/IModelsDatastore.md) + +## Table of contents + +### Constructors + +- [constructor](ModelsDatastore.md#constructor) + +### Properties + +- [definitionsPath](ModelsDatastore.md#definitionspath) +- [dbConfiguration](ModelsDatastore.md#dbconfiguration) +- [db](ModelsDatastore.md#db) +- [server](ModelsDatastore.md#server) + +### Accessors + +- [configuration](ModelsDatastore.md#configuration) +- [logger](ModelsDatastore.md#logger) +- [cron](ModelsDatastore.md#cron) +- [cache](ModelsDatastore.md#cache) +- [appDelegate](ModelsDatastore.md#appdelegate) +- [engine](ModelsDatastore.md#engine) +- [dataStore](ModelsDatastore.md#datastore) +- [definitions](ModelsDatastore.md#definitions) +- [listener](ModelsDatastore.md#listener) + +### Methods + +- [import](ModelsDatastore.md#import) +- [getList](ModelsDatastore.md#getlist) +- [load](ModelsDatastore.md#load) +- [getPath](ModelsDatastore.md#getpath) +- [getFile](ModelsDatastore.md#getfile) +- [saveFile](ModelsDatastore.md#savefile) +- [getSource](ModelsDatastore.md#getsource) +- [getSVG](ModelsDatastore.md#getsvg) +- [save](ModelsDatastore.md#save) +- [deleteModel](ModelsDatastore.md#deletemodel) +- [renameModel](ModelsDatastore.md#renamemodel) +- [rebuild](ModelsDatastore.md#rebuild) +- [rebuildModel](ModelsDatastore.md#rebuildmodel) +- [loadModel](ModelsDatastore.md#loadmodel) +- [findEvents](ModelsDatastore.md#findevents) +- [install](ModelsDatastore.md#install) +- [updateTimer](ModelsDatastore.md#updatetimer) +- [saveModel](ModelsDatastore.md#savemodel) +- [export](ModelsDatastore.md#export) + +## Constructors + +### constructor + +• **new ModelsDatastore**(`server`): [`ModelsDatastore`](ModelsDatastore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | [`BPMNServer`](BPMNServer.md) | + +#### Returns + +[`ModelsDatastore`](ModelsDatastore.md) + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[constructor](ModelsDatastoreDB.md#constructor) + +#### Defined in + +[datastore/ModelsDatastore.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L19) + +## Properties + +### definitionsPath + +• **definitionsPath**: `any` + +#### Defined in + +[datastore/ModelsDatastore.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L18) + +___ + +### dbConfiguration + +• **dbConfiguration**: `any` + +#### Inherited from + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[dbConfiguration](ModelsDatastoreDB.md#dbconfiguration) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L24) + +___ + +### db + +• **db**: `any` + +#### Inherited from + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[db](ModelsDatastoreDB.md#db) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L25) + +___ + +### server + +• **server**: `any` + +#### Inherited from + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[server](ModelsDatastoreDB.md#server) + +#### Defined in + +[server/ServerComponent.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L9) + +## Accessors + +### configuration + +• `get` **configuration**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ModelsDatastoreDB.configuration + +#### Defined in + +[server/ServerComponent.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L14) + +___ + +### logger + +• `get` **logger**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ModelsDatastoreDB.logger + +#### Defined in + +[server/ServerComponent.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L15) + +___ + +### cron + +• `get` **cron**(): [`Cron`](Cron.md) + +#### Returns + +[`Cron`](Cron.md) + +#### Inherited from + +ModelsDatastoreDB.cron + +#### Defined in + +[server/ServerComponent.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L16) + +___ + +### cache + +• `get` **cache**(): [`CacheManager`](CacheManager.md) + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Inherited from + +ModelsDatastoreDB.cache + +#### Defined in + +[server/ServerComponent.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L17) + +___ + +### appDelegate + +• `get` **appDelegate**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ModelsDatastoreDB.appDelegate + +#### Defined in + +[server/ServerComponent.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L18) + +___ + +### engine + +• `get` **engine**(): [`IEngine`](../interfaces/IEngine.md) + +#### Returns + +[`IEngine`](../interfaces/IEngine.md) + +#### Inherited from + +ModelsDatastoreDB.engine + +#### Defined in + +[server/ServerComponent.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L19) + +___ + +### dataStore + +• `get` **dataStore**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ModelsDatastoreDB.dataStore + +#### Defined in + +[server/ServerComponent.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L20) + +___ + +### definitions + +• `get` **definitions**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ModelsDatastoreDB.definitions + +#### Defined in + +[server/ServerComponent.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L21) + +___ + +### listener + +• `get` **listener**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ModelsDatastoreDB.listener + +#### Defined in + +[server/ServerComponent.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L22) + +## Methods + +### import + +▸ **import**(`data`, `owner?`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `data` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[import](../interfaces/IModelsDatastore.md#import) + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[import](ModelsDatastoreDB.md#import) + +#### Defined in + +[datastore/ModelsDatastore.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L25) + +___ + +### getList + +▸ **getList**(`query?`): `Promise`\<`string`[]\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `query` | `any` | `null` | + +#### Returns + +`Promise`\<`string`[]\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[getList](../interfaces/IModelsDatastore.md#getlist) + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[getList](ModelsDatastoreDB.md#getlist) + +#### Defined in + +[datastore/ModelsDatastore.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L30) + +___ + +### load + +▸ **load**(`name`, `owner?`): `Promise`\<[`Definition`](Definition.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<[`Definition`](Definition.md)\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[load](../interfaces/IModelsDatastore.md#load) + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[load](ModelsDatastoreDB.md#load) + +#### Defined in + +[datastore/ModelsDatastore.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L49) + +___ + +### getPath + +▸ **getPath**(`name`, `type`, `owner?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `type` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`string` + +#### Defined in + +[datastore/ModelsDatastore.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L59) + +___ + +### getFile + +▸ **getFile**(`name`, `type`, `owner?`): `any` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `type` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`any` + +#### Defined in + +[datastore/ModelsDatastore.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L64) + +___ + +### saveFile + +▸ **saveFile**(`name`, `type`, `data`, `owner?`): `void` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `type` | `any` | `undefined` | +| `data` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`void` + +#### Defined in + +[datastore/ModelsDatastore.ts:71](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L71) + +___ + +### getSource + +▸ **getSource**(`name`, `owner?`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`string`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[getSource](../interfaces/IModelsDatastore.md#getsource) + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[getSource](ModelsDatastoreDB.md#getsource) + +#### Defined in + +[datastore/ModelsDatastore.ts:79](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L79) + +___ + +### getSVG + +▸ **getSVG**(`name`, `owner?`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`string`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[getSVG](../interfaces/IModelsDatastore.md#getsvg) + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[getSVG](ModelsDatastoreDB.md#getsvg) + +#### Defined in + +[datastore/ModelsDatastore.ts:84](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L84) + +___ + +### save + +▸ **save**(`name`, `bpmn`, `svg?`, `owner?`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `bpmn` | `any` | `undefined` | +| `svg?` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[save](../interfaces/IModelsDatastore.md#save) + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[save](ModelsDatastoreDB.md#save) + +#### Defined in + +[datastore/ModelsDatastore.ts:88](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L88) + +___ + +### deleteModel + +▸ **deleteModel**(`name`, `owner?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[deleteModel](../interfaces/IModelsDatastore.md#deletemodel) + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[deleteModel](ModelsDatastoreDB.md#deletemodel) + +#### Defined in + +[datastore/ModelsDatastore.ts:100](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L100) + +___ + +### renameModel + +▸ **renameModel**(`name`, `newName`, `owner?`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `newName` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[renameModel](../interfaces/IModelsDatastore.md#renamemodel) + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[renameModel](ModelsDatastoreDB.md#renamemodel) + +#### Defined in + +[datastore/ModelsDatastore.ts:110](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L110) + +___ + +### rebuild + +▸ **rebuild**(`model?`): `Promise`\<`void`\> + +reconstruct the models database from files + +use when modifying the files manually or importing new environment + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `model` | `any` | `null` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[rebuild](ModelsDatastoreDB.md#rebuild) + +#### Defined in + +[datastore/ModelsDatastore.ts:128](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L128) + +___ + +### rebuildModel + +▸ **rebuildModel**(`name`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[datastore/ModelsDatastore.ts:170](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastore.ts#L170) + +___ + +### loadModel + +▸ **loadModel**(`name`, `owner?`): `Promise`\<[`BpmnModelData`](BpmnModelData.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<[`BpmnModelData`](BpmnModelData.md)\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[loadModel](../interfaces/IModelsDatastore.md#loadmodel) + +#### Inherited from + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[loadModel](ModelsDatastoreDB.md#loadmodel) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:68](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L68) + +___ + +### findEvents + +▸ **findEvents**(`query`, `owner?`): `Promise`\<[`IEventData`](../interfaces/IEventData.md)[]\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `query` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<[`IEventData`](../interfaces/IEventData.md)[]\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[findEvents](../interfaces/IModelsDatastore.md#findevents) + +#### Inherited from + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[findEvents](ModelsDatastoreDB.md#findevents) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:97](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L97) + +___ + +### install + +▸ **install**(): `Promise`\<`any`\> + +first time installation of DB + +creates a new collection and add an index + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[install](../interfaces/IModelsDatastore.md#install) + +#### Inherited from + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[install](ModelsDatastoreDB.md#install) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:157](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L157) + +___ + +### updateTimer + +▸ **updateTimer**(`name`, `owner?`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Inherited from + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[updateTimer](ModelsDatastoreDB.md#updatetimer) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:164](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L164) + +___ + +### saveModel + +▸ **saveModel**(`model`, `owner?`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `model` | [`IBpmnModelData`](../interfaces/IBpmnModelData.md) | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[saveModel](../interfaces/IModelsDatastore.md#savemodel) + +#### Inherited from + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[saveModel](ModelsDatastoreDB.md#savemodel) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:190](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L190) + +___ + +### export + +▸ **export**(`name`, `folderPath`, `owner?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `folderPath` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ModelsDatastoreDB](ModelsDatastoreDB.md).[export](ModelsDatastoreDB.md#export) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:233](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L233) diff --git a/docs/api/classes/ModelsDatastoreDB.md b/docs/api/classes/ModelsDatastoreDB.md new file mode 100644 index 00000000..9eced104 --- /dev/null +++ b/docs/api/classes/ModelsDatastoreDB.md @@ -0,0 +1,662 @@ +[bpmn-server](../API.md) / ModelsDatastoreDB + +# Class: ModelsDatastoreDB + +super class for various objects that are part of the server + +## Hierarchy + +- [`ServerComponent`](ServerComponent.md) + + ↳ **`ModelsDatastoreDB`** + + ↳↳ [`ModelsDatastore`](ModelsDatastore.md) + +## Implements + +- [`IModelsDatastore`](../interfaces/IModelsDatastore.md) + +## Table of contents + +### Constructors + +- [constructor](ModelsDatastoreDB.md#constructor) + +### Properties + +- [dbConfiguration](ModelsDatastoreDB.md#dbconfiguration) +- [db](ModelsDatastoreDB.md#db) +- [server](ModelsDatastoreDB.md#server) + +### Accessors + +- [configuration](ModelsDatastoreDB.md#configuration) +- [logger](ModelsDatastoreDB.md#logger) +- [cron](ModelsDatastoreDB.md#cron) +- [cache](ModelsDatastoreDB.md#cache) +- [appDelegate](ModelsDatastoreDB.md#appdelegate) +- [engine](ModelsDatastoreDB.md#engine) +- [dataStore](ModelsDatastoreDB.md#datastore) +- [definitions](ModelsDatastoreDB.md#definitions) +- [listener](ModelsDatastoreDB.md#listener) + +### Methods + +- [getList](ModelsDatastoreDB.md#getlist) +- [load](ModelsDatastoreDB.md#load) +- [getSource](ModelsDatastoreDB.md#getsource) +- [getSVG](ModelsDatastoreDB.md#getsvg) +- [loadModel](ModelsDatastoreDB.md#loadmodel) +- [save](ModelsDatastoreDB.md#save) +- [findEvents](ModelsDatastoreDB.md#findevents) +- [getProjection](ModelsDatastoreDB.md#getprojection) +- [install](ModelsDatastoreDB.md#install) +- [import](ModelsDatastoreDB.md#import) +- [updateTimer](ModelsDatastoreDB.md#updatetimer) +- [saveModel](ModelsDatastoreDB.md#savemodel) +- [deleteModel](ModelsDatastoreDB.md#deletemodel) +- [renameModel](ModelsDatastoreDB.md#renamemodel) +- [export](ModelsDatastoreDB.md#export) +- [rebuild](ModelsDatastoreDB.md#rebuild) + +## Constructors + +### constructor + +• **new ModelsDatastoreDB**(`server`): [`ModelsDatastoreDB`](ModelsDatastoreDB.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | [`BPMNServer`](BPMNServer.md) | + +#### Returns + +[`ModelsDatastoreDB`](ModelsDatastoreDB.md) + +#### Overrides + +[ServerComponent](ServerComponent.md).[constructor](ServerComponent.md#constructor) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L27) + +## Properties + +### dbConfiguration + +• **dbConfiguration**: `any` + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L24) + +___ + +### db + +• **db**: `any` + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L25) + +___ + +### server + +• **server**: `any` + +#### Inherited from + +[ServerComponent](ServerComponent.md).[server](ServerComponent.md#server) + +#### Defined in + +[server/ServerComponent.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L9) + +## Accessors + +### configuration + +• `get` **configuration**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.configuration + +#### Defined in + +[server/ServerComponent.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L14) + +___ + +### logger + +• `get` **logger**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.logger + +#### Defined in + +[server/ServerComponent.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L15) + +___ + +### cron + +• `get` **cron**(): [`Cron`](Cron.md) + +#### Returns + +[`Cron`](Cron.md) + +#### Inherited from + +ServerComponent.cron + +#### Defined in + +[server/ServerComponent.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L16) + +___ + +### cache + +• `get` **cache**(): [`CacheManager`](CacheManager.md) + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Inherited from + +ServerComponent.cache + +#### Defined in + +[server/ServerComponent.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L17) + +___ + +### appDelegate + +• `get` **appDelegate**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.appDelegate + +#### Defined in + +[server/ServerComponent.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L18) + +___ + +### engine + +• `get` **engine**(): [`IEngine`](../interfaces/IEngine.md) + +#### Returns + +[`IEngine`](../interfaces/IEngine.md) + +#### Inherited from + +ServerComponent.engine + +#### Defined in + +[server/ServerComponent.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L19) + +___ + +### dataStore + +• `get` **dataStore**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.dataStore + +#### Defined in + +[server/ServerComponent.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L20) + +___ + +### definitions + +• `get` **definitions**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.definitions + +#### Defined in + +[server/ServerComponent.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L21) + +___ + +### listener + +• `get` **listener**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.listener + +#### Defined in + +[server/ServerComponent.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L22) + +## Methods + +### getList + +▸ **getList**(`query?`): `Promise`\<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `Object` | + +#### Returns + +`Promise`\<`string`[]\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[getList](../interfaces/IModelsDatastore.md#getlist) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L34) + +___ + +### load + +▸ **load**(`name`, `owner?`): `Promise`\<[`Definition`](Definition.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<[`Definition`](Definition.md)\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[load](../interfaces/IModelsDatastore.md#load) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L47) + +___ + +### getSource + +▸ **getSource**(`name`, `owner?`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[getSource](../interfaces/IModelsDatastore.md#getsource) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L54) + +___ + +### getSVG + +▸ **getSVG**(`name`, `owner?`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[getSVG](../interfaces/IModelsDatastore.md#getsvg) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L59) + +___ + +### loadModel + +▸ **loadModel**(`name`, `owner?`): `Promise`\<[`BpmnModelData`](BpmnModelData.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<[`BpmnModelData`](BpmnModelData.md)\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[loadModel](../interfaces/IModelsDatastore.md#loadmodel) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:68](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L68) + +___ + +### save + +▸ **save**(`name`, `source`, `svg`, `owner?`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `source` | `any` | `undefined` | +| `svg` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[save](../interfaces/IModelsDatastore.md#save) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L78) + +___ + +### findEvents + +▸ **findEvents**(`query`, `owner?`): `Promise`\<[`IEventData`](../interfaces/IEventData.md)[]\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `query` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<[`IEventData`](../interfaces/IEventData.md)[]\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[findEvents](../interfaces/IModelsDatastore.md#findevents) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:97](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L97) + +___ + +### getProjection + +▸ **getProjection**(`query`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`Object` + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:131](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L131) + +___ + +### install + +▸ **install**(): `Promise`\<`any`\> + +first time installation of DB + +creates a new collection and add an index + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[install](../interfaces/IModelsDatastore.md#install) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:157](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L157) + +___ + +### import + +▸ **import**(`data`, `owner?`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `data` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`any`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[import](../interfaces/IModelsDatastore.md#import) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:160](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L160) + +___ + +### updateTimer + +▸ **updateTimer**(`name`, `owner?`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:164](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L164) + +___ + +### saveModel + +▸ **saveModel**(`model`, `owner?`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `model` | [`IBpmnModelData`](../interfaces/IBpmnModelData.md) | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[saveModel](../interfaces/IModelsDatastore.md#savemodel) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:190](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L190) + +___ + +### deleteModel + +▸ **deleteModel**(`name`, `owner?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[deleteModel](../interfaces/IModelsDatastore.md#deletemodel) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:210](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L210) + +___ + +### renameModel + +▸ **renameModel**(`name`, `newName`, `owner?`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `newName` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[IModelsDatastore](../interfaces/IModelsDatastore.md).[renameModel](../interfaces/IModelsDatastore.md#renamemodel) + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:215](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L215) + +___ + +### export + +▸ **export**(`name`, `folderPath`, `owner?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `name` | `any` | `undefined` | +| `folderPath` | `any` | `undefined` | +| `owner` | `any` | `null` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:233](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L233) + +___ + +### rebuild + +▸ **rebuild**(`model?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `model` | `any` | `null` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[datastore/ModelsDatastoreDB.ts:251](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsDatastoreDB.ts#L251) diff --git a/docs/api/classes/MongoDB.md b/docs/api/classes/MongoDB.md new file mode 100644 index 00000000..7a16baeb --- /dev/null +++ b/docs/api/classes/MongoDB.md @@ -0,0 +1,266 @@ +[bpmn-server](../API.md) / MongoDB + +# Class: MongoDB + +## Table of contents + +### Constructors + +- [constructor](MongoDB.md#constructor) + +### Properties + +- [client](MongoDB.md#client) +- [dbConfig](MongoDB.md#dbconfig) +- [logger](MongoDB.md#logger) + +### Methods + +- [getClient](MongoDB.md#getclient) +- [find](MongoDB.md#find) +- [createIndex](MongoDB.md#createindex) +- [insert](MongoDB.md#insert) +- [update](MongoDB.md#update) +- [update2](MongoDB.md#update2) +- [remove](MongoDB.md#remove) +- [removeById](MongoDB.md#removebyid) +- [connect](MongoDB.md#connect) + +## Constructors + +### constructor + +• **new MongoDB**(`dbConfig`, `logger`): [`MongoDB`](MongoDB.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dbConfig` | `any` | +| `logger` | `any` | + +#### Returns + +[`MongoDB`](MongoDB.md) + +#### Defined in + +[datastore/MongoDB.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L22) + +## Properties + +### client + +• **client**: `any` + +#### Defined in + +[datastore/MongoDB.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L19) + +___ + +### dbConfig + +• **dbConfig**: `any` + +#### Defined in + +[datastore/MongoDB.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L20) + +___ + +### logger + +• **logger**: `any` + +#### Defined in + +[datastore/MongoDB.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L21) + +## Methods + +### getClient + +▸ **getClient**(): `Promise`\<`any`\> + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[datastore/MongoDB.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L26) + +___ + +### find + +▸ **find**(`dbName`, `collName`, `qry`, `projection?`): `Promise`\<`unknown`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `dbName` | `any` | `undefined` | +| `collName` | `any` | `undefined` | +| `qry` | `any` | `undefined` | +| `projection` | `any` | `null` | + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[datastore/MongoDB.ts:33](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L33) + +___ + +### createIndex + +▸ **createIndex**(`dbName`, `collName`, `index`, `unique?`): `Promise`\<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dbName` | `any` | +| `collName` | `any` | +| `index` | `any` | +| `unique` | `Object` | + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[datastore/MongoDB.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L59) + +___ + +### insert + +▸ **insert**(`dbName`, `collName`, `docs`): `Promise`\<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dbName` | `any` | +| `collName` | `any` | +| `docs` | `any` | + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[datastore/MongoDB.ts:84](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L84) + +___ + +### update + +▸ **update**(`dbName`, `collName`, `query`, `updateObject`, `options?`): `Promise`\<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dbName` | `any` | +| `collName` | `any` | +| `query` | `any` | +| `updateObject` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[datastore/MongoDB.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L109) + +___ + +### update2 + +▸ **update2**(`dbName`, `collName`, `query`, `updateObject`, `options?`): `Promise`\<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dbName` | `any` | +| `collName` | `any` | +| `query` | `any` | +| `updateObject` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[datastore/MongoDB.ts:131](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L131) + +___ + +### remove + +▸ **remove**(`dbName`, `collName`, `query`): `Promise`\<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dbName` | `any` | +| `collName` | `any` | +| `query` | `any` | + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[datastore/MongoDB.ts:154](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L154) + +___ + +### removeById + +▸ **removeById**(`dbName`, `collName`, `id`): `Promise`\<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dbName` | `any` | +| `collName` | `any` | +| `id` | `any` | + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[datastore/MongoDB.ts:182](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L182) + +___ + +### connect + +▸ **connect**(): `Promise`\<`unknown`\> + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[datastore/MongoDB.ts:210](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/MongoDB.ts#L210) diff --git a/docs/api/classes/NoCacheManager.md b/docs/api/classes/NoCacheManager.md new file mode 100644 index 00000000..b8d21578 --- /dev/null +++ b/docs/api/classes/NoCacheManager.md @@ -0,0 +1,364 @@ +[bpmn-server](../API.md) / NoCacheManager + +# Class: NoCacheManager + +super class for various objects that are part of the server + +## Hierarchy + +- [`ServerComponent`](ServerComponent.md) + + ↳ **`NoCacheManager`** + +## Implements + +- [`ICacheManager`](../interfaces/ICacheManager.md) + +## Table of contents + +### Constructors + +- [constructor](NoCacheManager.md#constructor) + +### Properties + +- [server](NoCacheManager.md#server) + +### Accessors + +- [configuration](NoCacheManager.md#configuration) +- [logger](NoCacheManager.md#logger) +- [cron](NoCacheManager.md#cron) +- [cache](NoCacheManager.md#cache) +- [appDelegate](NoCacheManager.md#appdelegate) +- [engine](NoCacheManager.md#engine) +- [dataStore](NoCacheManager.md#datastore) +- [definitions](NoCacheManager.md#definitions) +- [listener](NoCacheManager.md#listener) + +### Methods + +- [list](NoCacheManager.md#list) +- [getInstance](NoCacheManager.md#getinstance) +- [add](NoCacheManager.md#add) +- [remove](NoCacheManager.md#remove) +- [shutdown](NoCacheManager.md#shutdown) +- [restart](NoCacheManager.md#restart) + +## Constructors + +### constructor + +• **new NoCacheManager**(`server`): [`NoCacheManager`](NoCacheManager.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`NoCacheManager`](NoCacheManager.md) + +#### Overrides + +[ServerComponent](ServerComponent.md).[constructor](ServerComponent.md#constructor) + +#### Defined in + +[server/CacheManager.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L13) + +## Properties + +### server + +• **server**: `any` + +#### Inherited from + +[ServerComponent](ServerComponent.md).[server](ServerComponent.md#server) + +#### Defined in + +[server/ServerComponent.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L9) + +## Accessors + +### configuration + +• `get` **configuration**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.configuration + +#### Defined in + +[server/ServerComponent.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L14) + +___ + +### logger + +• `get` **logger**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.logger + +#### Defined in + +[server/ServerComponent.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L15) + +___ + +### cron + +• `get` **cron**(): [`Cron`](Cron.md) + +#### Returns + +[`Cron`](Cron.md) + +#### Inherited from + +ServerComponent.cron + +#### Defined in + +[server/ServerComponent.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L16) + +___ + +### cache + +• `get` **cache**(): [`CacheManager`](CacheManager.md) + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Inherited from + +ServerComponent.cache + +#### Defined in + +[server/ServerComponent.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L17) + +___ + +### appDelegate + +• `get` **appDelegate**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.appDelegate + +#### Defined in + +[server/ServerComponent.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L18) + +___ + +### engine + +• `get` **engine**(): [`IEngine`](../interfaces/IEngine.md) + +#### Returns + +[`IEngine`](../interfaces/IEngine.md) + +#### Inherited from + +ServerComponent.engine + +#### Defined in + +[server/ServerComponent.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L19) + +___ + +### dataStore + +• `get` **dataStore**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.dataStore + +#### Defined in + +[server/ServerComponent.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L20) + +___ + +### definitions + +• `get` **definitions**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.definitions + +#### Defined in + +[server/ServerComponent.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L21) + +___ + +### listener + +• `get` **listener**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServerComponent.listener + +#### Defined in + +[server/ServerComponent.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L22) + +## Methods + +### list + +▸ **list**(): `any`[] + +#### Returns + +`any`[] + +#### Implementation of + +[ICacheManager](../interfaces/ICacheManager.md).[list](../interfaces/ICacheManager.md#list) + +#### Defined in + +[server/CacheManager.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L17) + +___ + +### getInstance + +▸ **getInstance**(`instanceId`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | + +#### Returns + +`any` + +#### Defined in + +[server/CacheManager.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L20) + +___ + +### add + +▸ **add**(`execution`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`IExecution`](../interfaces/IExecution.md) | + +#### Returns + +`any` + +#### Implementation of + +[ICacheManager](../interfaces/ICacheManager.md).[add](../interfaces/ICacheManager.md#add) + +#### Defined in + +[server/CacheManager.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L22) + +___ + +### remove + +▸ **remove**(`instanceId`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | + +#### Returns + +`any` + +#### Implementation of + +[ICacheManager](../interfaces/ICacheManager.md).[remove](../interfaces/ICacheManager.md#remove) + +#### Defined in + +[server/CacheManager.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L23) + +___ + +### shutdown + +▸ **shutdown**(): `void` + +#### Returns + +`void` + +#### Implementation of + +[ICacheManager](../interfaces/ICacheManager.md).[shutdown](../interfaces/ICacheManager.md#shutdown) + +#### Defined in + +[server/CacheManager.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L25) + +___ + +### restart + +▸ **restart**(): `void` + +#### Returns + +`void` + +#### Defined in + +[server/CacheManager.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/CacheManager.ts#L26) diff --git a/docs/api/classes/Node.md b/docs/api/classes/Node.md new file mode 100644 index 00000000..23ac0203 --- /dev/null +++ b/docs/api/classes/Node.md @@ -0,0 +1,887 @@ +[bpmn-server](../API.md) / Node + +# Class: Node + +## Hierarchy + +- [`Element`](Element.md) + + ↳ **`Node`** + + ↳↳ [`UserTask`](UserTask.md) + + ↳↳ [`ScriptTask`](ScriptTask.md) + + ↳↳ [`ServiceTask`](ServiceTask.md) + + ↳↳ [`ReceiveTask`](ReceiveTask.md) + + ↳↳ [`SubProcess`](SubProcess.md) + + ↳↳ [`CallActivity`](CallActivity.md) + + ↳↳ [`Event`](Event.md) + + ↳↳ [`Gateway`](Gateway.md) + +## Table of contents + +### Constructors + +- [constructor](Node.md#constructor) + +### Properties + +- [id](Node.md#id) +- [type](Node.md#type) +- [subType](Node.md#subtype) +- [behaviours](Node.md#behaviours) +- [isFlow](Node.md#isflow) +- [lane](Node.md#lane) +- [name](Node.md#name) +- [process](Node.md#process) +- [def](Node.md#def) +- [outbounds](Node.md#outbounds) +- [inbounds](Node.md#inbounds) +- [attachments](Node.md#attachments) +- [attachedTo](Node.md#attachedto) +- [messageId](Node.md#messageid) +- [signalId](Node.md#signalid) +- [initiator](Node.md#initiator) +- [assignee](Node.md#assignee) +- [candidateGroups](Node.md#candidategroups) +- [candidateUsers](Node.md#candidateusers) +- [scripts](Node.md#scripts) + +### Accessors + +- [processId](Node.md#processid) +- [requiresWait](Node.md#requireswait) +- [canBeInvoked](Node.md#canbeinvoked) +- [isCatching](Node.md#iscatching) + +### Methods + +- [restored](Node.md#restored) +- [hasBehaviour](Node.md#hasbehaviour) +- [getBehaviour](Node.md#getbehaviour) +- [addBehaviour](Node.md#addbehaviour) +- [validate](Node.md#validate) +- [doEvent](Node.md#doevent) +- [setInput](Node.md#setinput) +- [getInput](Node.md#getinput) +- [getOutput](Node.md#getoutput) +- [enter](Node.md#enter) +- [execute](Node.md#execute) +- [continue](Node.md#continue) +- [start](Node.md#start) +- [run](Node.md#run) +- [cancelEBG](Node.md#cancelebg) +- [cancelBoundaryEvents](Node.md#cancelboundaryevents) +- [end](Node.md#end) +- [resume](Node.md#resume) +- [init](Node.md#init) +- [getOutbounds](Node.md#getoutbounds) +- [startBoundaryEvents](Node.md#startboundaryevents) +- [describe](Node.md#describe) + +## Constructors + +### constructor + +• **new Node**(`id`, `process`, `type`, `def`): [`Node`](Node.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`Node`](Node.md) + +#### Overrides + +[Element](Element.md).[constructor](Element.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Element](Element.md).[id](Element.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Element](Element.md).[type](Element.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Element](Element.md).[subType](Element.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Element](Element.md).[behaviours](Element.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Element](Element.md).[isFlow](Element.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Element](Element.md).[lane](Element.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Overrides + +[Element](Element.md).[name](Element.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[elements/Node.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L127) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Element](Element.md).[restored](Element.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Element](Element.md).[hasBehaviour](Element.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Element](Element.md).[getBehaviour](Element.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Element](Element.md).[addBehaviour](Element.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[Element](Element.md).[continue](Element.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Defined in + +[elements/Node.ts:217](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L217) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Overrides + +[Element](Element.md).[resume](Element.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Overrides + +[Element](Element.md).[describe](Element.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/NodeLoader.md b/docs/api/classes/NodeLoader.md new file mode 100644 index 00000000..98209550 --- /dev/null +++ b/docs/api/classes/NodeLoader.md @@ -0,0 +1,44 @@ +[bpmn-server](../API.md) / NodeLoader + +# Class: NodeLoader + +## Table of contents + +### Constructors + +- [constructor](NodeLoader.md#constructor) + +### Methods + +- [loadNode](NodeLoader.md#loadnode) + +## Constructors + +### constructor + +• **new NodeLoader**(): [`NodeLoader`](NodeLoader.md) + +#### Returns + +[`NodeLoader`](NodeLoader.md) + +## Methods + +### loadNode + +▸ **loadNode**(`el`, `process`): [`Node`](Node.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `el` | `any` | +| `process` | `any` | + +#### Returns + +[`Node`](Node.md) + +#### Defined in + +[elements/NodeLoader.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/NodeLoader.ts#L13) diff --git a/docs/api/classes/Process.md b/docs/api/classes/Process.md new file mode 100644 index 00000000..16db6193 --- /dev/null +++ b/docs/api/classes/Process.md @@ -0,0 +1,298 @@ +[bpmn-server](../API.md) / Process + +# Class: Process + +## Table of contents + +### Constructors + +- [constructor](Process.md#constructor) + +### Properties + +- [id](Process.md#id) +- [name](Process.md#name) +- [isExecutable](Process.md#isexecutable) +- [def](Process.md#def) +- [parent](Process.md#parent) +- [childrenNodes](Process.md#childrennodes) +- [eventSubProcesses](Process.md#eventsubprocesses) +- [subProcessEvents](Process.md#subprocessevents) +- [scripts](Process.md#scripts) + +### Methods + +- [init](Process.md#init) +- [start](Process.md#start) +- [end](Process.md#end) +- [getStartNode](Process.md#getstartnode) +- [getStartNodes](Process.md#getstartnodes) +- [getEventSubProcessStart](Process.md#geteventsubprocessstart) +- [doEvent](Process.md#doevent) +- [describe](Process.md#describe) + +## Constructors + +### constructor + +• **new Process**(`definition`, `parent?`): [`Process`](Process.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `definition` | `any` | `undefined` | +| `parent` | `any` | `null` | + +#### Returns + +[`Process`](Process.md) + +#### Defined in + +[elements/Process.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L22) + +## Properties + +### id + +• **id**: `any` + +#### Defined in + +[elements/Process.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L12) + +___ + +### name + +• **name**: `any` + +#### Defined in + +[elements/Process.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L13) + +___ + +### isExecutable + +• **isExecutable**: `any` + +#### Defined in + +[elements/Process.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L14) + +___ + +### def + +• **def**: [`Definition`](Definition.md) + +#### Defined in + +[elements/Process.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L15) + +___ + +### parent + +• **parent**: [`Process`](Process.md) + +#### Defined in + +[elements/Process.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L16) + +___ + +### childrenNodes + +• **childrenNodes**: [`Node`](Node.md)[] + +#### Defined in + +[elements/Process.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L17) + +___ + +### eventSubProcesses + +• **eventSubProcesses**: `any`[] + +#### Defined in + +[elements/Process.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L18) + +___ + +### subProcessEvents + +• **subProcessEvents**: `any`[] + +#### Defined in + +[elements/Process.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L19) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Defined in + +[elements/Process.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L20) + +## Methods + +### init + +▸ **init**(`children`, `eventSubProcesses`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | `any` | +| `eventSubProcesses` | `any` | + +#### Returns + +`void` + +#### Defined in + +[elements/Process.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L29) + +___ + +### start + +▸ **start**(`execution`, `parentToken`): `Promise`\<`void`\> + +Notify process that it started + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`Execution`](Execution.md) | +| `parentToken` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Process.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L36) + +___ + +### end + +▸ **end**(`execution`): `Promise`\<`void`\> + +Notify process that it ended + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`IExecution`](../interfaces/IExecution.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Process.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L57) + +___ + +### getStartNode + +▸ **getStartNode**(`userInvokable?`): `any` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `userInvokable` | `boolean` | `false` | + +#### Returns + +`any` + +#### Defined in + +[elements/Process.ts:67](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L67) + +___ + +### getStartNodes + +▸ **getStartNodes**(`userInvokable?`): `any`[] + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `userInvokable` | `boolean` | `false` | + +#### Returns + +`any`[] + +#### Defined in + +[elements/Process.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L70) + +___ + +### getEventSubProcessStart + +▸ **getEventSubProcessStart**(): [`Node`](Node.md)[] + +#### Returns + +[`Node`](Node.md)[] + +#### Defined in + +[elements/Process.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L87) + +___ + +### doEvent + +▸ **doEvent**(`execution`, `event`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | `any` | +| `event` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Process.ts:100](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L100) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Defined in + +[elements/Process.ts:111](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Process.ts#L111) diff --git a/docs/api/classes/ProcessData.md b/docs/api/classes/ProcessData.md new file mode 100644 index 00000000..61076483 --- /dev/null +++ b/docs/api/classes/ProcessData.md @@ -0,0 +1,71 @@ +[bpmn-server](../API.md) / ProcessData + +# Class: ProcessData + +## Implements + +- [`IProcessData`](../interfaces/IProcessData.md) + +## Table of contents + +### Constructors + +- [constructor](ProcessData.md#constructor) + +### Properties + +- [id](ProcessData.md#id) +- [name](ProcessData.md#name) +- [isExecutable](ProcessData.md#isexecutable) + +## Constructors + +### constructor + +• **new ProcessData**(): [`ProcessData`](ProcessData.md) + +#### Returns + +[`ProcessData`](ProcessData.md) + +## Properties + +### id + +• **id**: `any` + +#### Implementation of + +[IProcessData](../interfaces/IProcessData.md).[id](../interfaces/IProcessData.md#id) + +#### Defined in + +[datastore/ModelsData.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L78) + +___ + +### name + +• **name**: `any` + +#### Implementation of + +[IProcessData](../interfaces/IProcessData.md).[name](../interfaces/IProcessData.md#name) + +#### Defined in + +[datastore/ModelsData.ts:79](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L79) + +___ + +### isExecutable + +• **isExecutable**: `any` + +#### Implementation of + +[IProcessData](../interfaces/IProcessData.md).[isExecutable](../interfaces/IProcessData.md#isexecutable) + +#### Defined in + +[datastore/ModelsData.ts:80](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/datastore/ModelsData.ts#L80) diff --git a/docs/api/classes/Query.md b/docs/api/classes/Query.md new file mode 100644 index 00000000..4aa4bebe --- /dev/null +++ b/docs/api/classes/Query.md @@ -0,0 +1,440 @@ +[bpmn-server](../API.md) / Query + +# Class: Query + +## Table of contents + +### Constructors + +- [constructor](Query.md#constructor) + +### Properties + +- [\_instanceId](Query.md#_instanceid) +- [\_instanceName](Query.md#_instancename) +- [\_instanceStatus](Query.md#_instancestatus) +- [\_instanceStartedAt](Query.md#_instancestartedat) +- [\_instanceEndedAt](Query.md#_instanceendedat) +- [\_instanceSaved](Query.md#_instancesaved) +- [\_instanceData](Query.md#_instancedata) +- [\_instanceSource](Query.md#_instancesource) +- [\_instanceParentNodeId](Query.md#_instanceparentnodeid) +- [\_data](Query.md#_data) +- [\_itemId](Query.md#_itemid) +- [\_itemSeq](Query.md#_itemseq) +- [\_itemKey](Query.md#_itemkey) +- [\_itemName](Query.md#_itemname) +- [\_itemType](Query.md#_itemtype) +- [\_itemStatus](Query.md#_itemstatus) +- [\_itemStartedAt](Query.md#_itemstartedat) +- [\_itemEndedAt](Query.md#_itemendedat) +- [\_itemTokenId](Query.md#_itemtokenid) +- [\_itemElementId](Query.md#_itemelementid) + +### Methods + +- [instanceId](Query.md#instanceid) +- [instanceName](Query.md#instancename) +- [instanceStatus](Query.md#instancestatus) +- [data](Query.md#data) +- [itemId](Query.md#itemid) +- [itemName](Query.md#itemname) +- [itemStatus](Query.md#itemstatus) +- [itemElementId](Query.md#itemelementid) + +## Constructors + +### constructor + +• **new Query**(`«destructured»?`): [`Query`](Query.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `instanceId?` | `any` | +| › `instanceName?` | `any` | +| › `instanceStatus?` | [`EXECUTION_STATUS`](../enums/EXECUTION_STATUS.md) | +| › `instanceStartedAt?` | `any` | +| › `instanceEndedAt?` | `any` | +| › `instanceSaved?` | `any` | +| › `data?` | `any` | +| › `itemId?` | `any` | +| › `itemSeq?` | `any` | +| › `itemKey?` | `any` | +| › `itemName?` | `any` | +| › `itemType?` | [`BPMN_TYPE`](../enums/BPMN_TYPE.md) | +| › `itemStatus?` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | +| › `itemStartedAt?` | `any` | +| › `itemEndedAt?` | `any` | +| › `itemTokenId?` | `any` | +| › `itemElementId?` | `any` | + +#### Returns + +[`Query`](Query.md) + +#### Defined in + +[engine/Model.ts:118](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L118) + +## Properties + +### \_instanceId + +• `Private` **\_instanceId**: `any` + +#### Defined in + +[engine/Model.ts:97](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L97) + +___ + +### \_instanceName + +• `Private` **\_instanceName**: `any` + +#### Defined in + +[engine/Model.ts:98](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L98) + +___ + +### \_instanceStatus + +• `Private` **\_instanceStatus**: [`EXECUTION_STATUS`](../enums/EXECUTION_STATUS.md) + +#### Defined in + +[engine/Model.ts:99](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L99) + +___ + +### \_instanceStartedAt + +• `Private` **\_instanceStartedAt**: `any` + +#### Defined in + +[engine/Model.ts:100](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L100) + +___ + +### \_instanceEndedAt + +• `Private` **\_instanceEndedAt**: `any` + +#### Defined in + +[engine/Model.ts:101](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L101) + +___ + +### \_instanceSaved + +• `Private` **\_instanceSaved**: `any` + +#### Defined in + +[engine/Model.ts:102](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L102) + +___ + +### \_instanceData + +• `Private` **\_instanceData**: `any` + +#### Defined in + +[engine/Model.ts:103](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L103) + +___ + +### \_instanceSource + +• `Private` **\_instanceSource**: `any` + +#### Defined in + +[engine/Model.ts:104](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L104) + +___ + +### \_instanceParentNodeId + +• `Private` **\_instanceParentNodeId**: `any` + +#### Defined in + +[engine/Model.ts:105](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L105) + +___ + +### \_data + +• `Private` **\_data**: `any` + +#### Defined in + +[engine/Model.ts:106](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L106) + +___ + +### \_itemId + +• `Private` **\_itemId**: `any` + +#### Defined in + +[engine/Model.ts:107](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L107) + +___ + +### \_itemSeq + +• `Private` **\_itemSeq**: `any` + +#### Defined in + +[engine/Model.ts:108](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L108) + +___ + +### \_itemKey + +• `Private` **\_itemKey**: `any` + +#### Defined in + +[engine/Model.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L109) + +___ + +### \_itemName + +• `Private` **\_itemName**: `any` + +#### Defined in + +[engine/Model.ts:110](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L110) + +___ + +### \_itemType + +• `Private` **\_itemType**: [`BPMN_TYPE`](../enums/BPMN_TYPE.md) + +#### Defined in + +[engine/Model.ts:111](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L111) + +___ + +### \_itemStatus + +• `Private` **\_itemStatus**: [`ITEM_STATUS`](../enums/ITEM_STATUS.md) + +#### Defined in + +[engine/Model.ts:112](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L112) + +___ + +### \_itemStartedAt + +• `Private` **\_itemStartedAt**: `any` + +#### Defined in + +[engine/Model.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L113) + +___ + +### \_itemEndedAt + +• `Private` **\_itemEndedAt**: `any` + +#### Defined in + +[engine/Model.ts:114](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L114) + +___ + +### \_itemTokenId + +• `Private` **\_itemTokenId**: `any` + +#### Defined in + +[engine/Model.ts:115](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L115) + +___ + +### \_itemElementId + +• `Private` **\_itemElementId**: `any` + +#### Defined in + +[engine/Model.ts:116](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L116) + +## Methods + +### instanceId + +▸ **instanceId**(`val`): [`Query`](Query.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `any` | + +#### Returns + +[`Query`](Query.md) + +#### Defined in + +[engine/Model.ts:160](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L160) + +___ + +### instanceName + +▸ **instanceName**(`val`): [`Query`](Query.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `any` | + +#### Returns + +[`Query`](Query.md) + +#### Defined in + +[engine/Model.ts:161](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L161) + +___ + +### instanceStatus + +▸ **instanceStatus**(`val`): [`Query`](Query.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | [`EXECUTION_STATUS`](../enums/EXECUTION_STATUS.md) | + +#### Returns + +[`Query`](Query.md) + +#### Defined in + +[engine/Model.ts:162](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L162) + +___ + +### data + +▸ **data**(`val`): [`Query`](Query.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `any` | + +#### Returns + +[`Query`](Query.md) + +#### Defined in + +[engine/Model.ts:163](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L163) + +___ + +### itemId + +▸ **itemId**(`val`): [`Query`](Query.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `any` | + +#### Returns + +[`Query`](Query.md) + +#### Defined in + +[engine/Model.ts:164](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L164) + +___ + +### itemName + +▸ **itemName**(`val`): [`Query`](Query.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `any` | + +#### Returns + +[`Query`](Query.md) + +#### Defined in + +[engine/Model.ts:165](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L165) + +___ + +### itemStatus + +▸ **itemStatus**(`val`): [`Query`](Query.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +[`Query`](Query.md) + +#### Defined in + +[engine/Model.ts:166](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L166) + +___ + +### itemElementId + +▸ **itemElementId**(`val`): [`Query`](Query.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `any` | + +#### Returns + +[`Query`](Query.md) + +#### Defined in + +[engine/Model.ts:167](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L167) diff --git a/docs/api/classes/ReceiveTask.md b/docs/api/classes/ReceiveTask.md new file mode 100644 index 00000000..3a31e0e3 --- /dev/null +++ b/docs/api/classes/ReceiveTask.md @@ -0,0 +1,999 @@ +[bpmn-server](../API.md) / ReceiveTask + +# Class: ReceiveTask + +## Hierarchy + +- [`Node`](Node.md) + + ↳ **`ReceiveTask`** + +## Table of contents + +### Constructors + +- [constructor](ReceiveTask.md#constructor) + +### Properties + +- [id](ReceiveTask.md#id) +- [type](ReceiveTask.md#type) +- [subType](ReceiveTask.md#subtype) +- [behaviours](ReceiveTask.md#behaviours) +- [isFlow](ReceiveTask.md#isflow) +- [lane](ReceiveTask.md#lane) +- [name](ReceiveTask.md#name) +- [process](ReceiveTask.md#process) +- [def](ReceiveTask.md#def) +- [outbounds](ReceiveTask.md#outbounds) +- [inbounds](ReceiveTask.md#inbounds) +- [attachments](ReceiveTask.md#attachments) +- [attachedTo](ReceiveTask.md#attachedto) +- [messageId](ReceiveTask.md#messageid) +- [signalId](ReceiveTask.md#signalid) +- [initiator](ReceiveTask.md#initiator) +- [assignee](ReceiveTask.md#assignee) +- [candidateGroups](ReceiveTask.md#candidategroups) +- [candidateUsers](ReceiveTask.md#candidateusers) +- [scripts](ReceiveTask.md#scripts) + +### Accessors + +- [processId](ReceiveTask.md#processid) +- [isCatching](ReceiveTask.md#iscatching) +- [requiresWait](ReceiveTask.md#requireswait) +- [canBeInvoked](ReceiveTask.md#canbeinvoked) + +### Methods + +- [restored](ReceiveTask.md#restored) +- [hasBehaviour](ReceiveTask.md#hasbehaviour) +- [getBehaviour](ReceiveTask.md#getbehaviour) +- [addBehaviour](ReceiveTask.md#addbehaviour) +- [validate](ReceiveTask.md#validate) +- [doEvent](ReceiveTask.md#doevent) +- [setInput](ReceiveTask.md#setinput) +- [getInput](ReceiveTask.md#getinput) +- [getOutput](ReceiveTask.md#getoutput) +- [enter](ReceiveTask.md#enter) +- [execute](ReceiveTask.md#execute) +- [continue](ReceiveTask.md#continue) +- [start](ReceiveTask.md#start) +- [run](ReceiveTask.md#run) +- [cancelEBG](ReceiveTask.md#cancelebg) +- [cancelBoundaryEvents](ReceiveTask.md#cancelboundaryevents) +- [end](ReceiveTask.md#end) +- [resume](ReceiveTask.md#resume) +- [init](ReceiveTask.md#init) +- [getOutbounds](ReceiveTask.md#getoutbounds) +- [startBoundaryEvents](ReceiveTask.md#startboundaryevents) +- [describe](ReceiveTask.md#describe) + +## Constructors + +### constructor + +• **new ReceiveTask**(`id`, `process`, `type`, `def`): [`ReceiveTask`](ReceiveTask.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`ReceiveTask`](ReceiveTask.md) + +#### Inherited from + +[Node](Node.md).[constructor](Node.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Node](Node.md).[id](Node.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Node](Node.md).[type](Node.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Node](Node.md).[subType](Node.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[behaviours](Node.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Node](Node.md).[isFlow](Node.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Node](Node.md).[lane](Node.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Node](Node.md).[name](Node.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Node](Node.md).[process](Node.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Node](Node.md).[def](Node.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[outbounds](Node.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[inbounds](Node.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Node](Node.md).[attachments](Node.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Node](Node.md).[attachedTo](Node.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Node](Node.md).[messageId](Node.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Node](Node.md).[signalId](Node.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Node](Node.md).[initiator](Node.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Node](Node.md).[assignee](Node.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Node](Node.md).[candidateGroups](Node.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Node](Node.md).[candidateUsers](Node.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[scripts](Node.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Node.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.isCatching + +#### Defined in + +[elements/Tasks.ts:218](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L218) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.requiresWait + +#### Defined in + +[elements/Tasks.ts:219](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L219) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.canBeInvoked + +#### Defined in + +[elements/Tasks.ts:220](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L220) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[restored](Node.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Node](Node.md).[hasBehaviour](Node.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Node](Node.md).[getBehaviour](Node.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[addBehaviour](Node.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[validate](Node.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Node](Node.md).[doEvent](Node.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[setInput](Node.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getInput](Node.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getOutput](Node.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[enter](Node.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Node](Node.md).[execute](Node.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[continue](Node.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Node](Node.md).[start](Node.md#start) + +#### Defined in + +[elements/Node.ts:217](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L217) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Node](Node.md).[run](Node.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelEBG](Node.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelBoundaryEvents](Node.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[end](Node.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[resume](Node.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[init](Node.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Node](Node.md).[getOutbounds](Node.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[startBoundaryEvents](Node.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Node](Node.md).[describe](Node.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/ScriptBehaviour.md b/docs/api/classes/ScriptBehaviour.md new file mode 100644 index 00000000..d813872c --- /dev/null +++ b/docs/api/classes/ScriptBehaviour.md @@ -0,0 +1,360 @@ +[bpmn-server](../API.md) / ScriptBehaviour + +# Class: ScriptBehaviour + +Behaviour + ioSpecification + timer + message + signal + + each behaviour is a class + it scans def and insert itself to perform actions as required + +## Hierarchy + +- [`Behaviour`](Behaviour.md) + + ↳ **`ScriptBehaviour`** + +## Table of contents + +### Constructors + +- [constructor](ScriptBehaviour.md#constructor) + +### Properties + +- [node](ScriptBehaviour.md#node) +- [definition](ScriptBehaviour.md#definition) +- [scripts](ScriptBehaviour.md#scripts) + +### Methods + +- [restored](ScriptBehaviour.md#restored) +- [enter](ScriptBehaviour.md#enter) +- [start](ScriptBehaviour.md#start) +- [run](ScriptBehaviour.md#run) +- [end](ScriptBehaviour.md#end) +- [exit](ScriptBehaviour.md#exit) +- [resume](ScriptBehaviour.md#resume) +- [getNodeAttributes](ScriptBehaviour.md#getnodeattributes) +- [getItemAttributes](ScriptBehaviour.md#getitemattributes) +- [init](ScriptBehaviour.md#init) +- [describe](ScriptBehaviour.md#describe) + +## Constructors + +### constructor + +• **new ScriptBehaviour**(`node`, `definition`): [`ScriptBehaviour`](ScriptBehaviour.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `definition` | `any` | + +#### Returns + +[`ScriptBehaviour`](ScriptBehaviour.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[constructor](Behaviour.md#constructor) + +#### Defined in + +[elements/behaviours/Behaviour.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L40) + +## Properties + +### node + +• **node**: [`Node`](Node.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[node](Behaviour.md#node) + +#### Defined in + +[elements/behaviours/Behaviour.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L38) + +___ + +### definition + +• **definition**: `any` + +#### Inherited from + +[Behaviour](Behaviour.md).[definition](Behaviour.md#definition) + +#### Defined in + +[elements/behaviours/Behaviour.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L39) + +___ + +### scripts + +• **scripts**: `string`[] + +#### Defined in + +[elements/behaviours/Script.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Script.ts#L30) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[restored](Behaviour.md#restored) + +#### Defined in + +[elements/behaviours/Behaviour.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L45) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[enter](Behaviour.md#enter) + +#### Defined in + +[elements/behaviours/Behaviour.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L48) + +___ + +### start + +▸ **start**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[start](Behaviour.md#start) + +#### Defined in + +[elements/behaviours/Behaviour.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L49) + +___ + +### run + +▸ **run**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[run](Behaviour.md#run) + +#### Defined in + +[elements/behaviours/Behaviour.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L50) + +___ + +### end + +▸ **end**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[end](Behaviour.md#end) + +#### Defined in + +[elements/behaviours/Behaviour.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L51) + +___ + +### exit + +▸ **exit**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[exit](Behaviour.md#exit) + +#### Defined in + +[elements/behaviours/Behaviour.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L52) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[resume](Behaviour.md#resume) + +#### Defined in + +[elements/behaviours/Behaviour.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L53) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getNodeAttributes](Behaviour.md#getnodeattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L54) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getItemAttributes](Behaviour.md#getitemattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L55) + +___ + +### init + +▸ **init**(): `void` + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[init](Behaviour.md#init) + +#### Defined in + +[elements/behaviours/Script.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Script.ts#L31) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Overrides + +[Behaviour](Behaviour.md).[describe](Behaviour.md#describe) + +#### Defined in + +[elements/behaviours/Script.ts:63](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Script.ts#L63) diff --git a/docs/api/classes/ScriptHandler.md b/docs/api/classes/ScriptHandler.md new file mode 100644 index 00000000..5e8b1ab2 --- /dev/null +++ b/docs/api/classes/ScriptHandler.md @@ -0,0 +1,128 @@ +[bpmn-server](../API.md) / ScriptHandler + +# Class: ScriptHandler + +## Table of contents + +### Constructors + +- [constructor](ScriptHandler.md#constructor) + +### Methods + +- [evaluateInputExpression](ScriptHandler.md#evaluateinputexpression) +- [evaluateExpression](ScriptHandler.md#evaluateexpression) +- [executeScript](ScriptHandler.md#executescript) +- [getJSvars](ScriptHandler.md#getjsvars) + +## Constructors + +### constructor + +• **new ScriptHandler**(): [`ScriptHandler`](ScriptHandler.md) + +#### Returns + +[`ScriptHandler`](ScriptHandler.md) + +## Methods + +### evaluateInputExpression + +▸ **evaluateInputExpression**(`item`, `exp`, `dateFormat?`): `Promise`\<`any`\> + +* these expression are strings with $ + * scenarios: + * String =>as is + * $javaScript =>evaulated + * a , b , c =>array + * dateString =>convert to date + * Examples: + * ['T', `user1`], + ['T', `$(appServices.test1(100))`], + ['T', `$(appServices.getSupervisorUser('user1'))`], + ['T', `abc,xyz,user group`], + ['TD', `2022-10-11`], +* + * + * appDelegate.scopeEval -->evaluateExpression + * appDelegate.scopeJS -->executeScript + * + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | `any` | `undefined` | +| `exp` | `any` | `undefined` | +| `dateFormat` | `boolean` | `false` | + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[engine/ScriptHandler.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/ScriptHandler.ts#L24) + +___ + +### evaluateExpression + +▸ **evaluateExpression**(`scope`, `expression`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | `any` | +| `expression` | `any` | + +#### Returns + +`any` + +#### Defined in + +[engine/ScriptHandler.ts:46](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/ScriptHandler.ts#L46) + +___ + +### executeScript + +▸ **executeScript**(`scope`, `script`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | `any` | +| `script` | `any` | + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[engine/ScriptHandler.ts:75](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/ScriptHandler.ts#L75) + +___ + +### getJSvars + +▸ **getJSvars**(`scope`): ``"\n var data=this.data;\n var input=this.input;\n var output=this.output;\n var appDelegate=this.execution.appDelegate;\n var appServices=this.execution.servicesProvider;\n var appUtils=appDelegate.appUtils;\n var item=this; // for backward support only\n "`` \| ``"\n var appDelegate=this.appDelegate;\n var appServices=this.servicesProvider;\n var appUtils=appDelegate.appUtils;\n "`` \| ``"\n var item=this;\n var data=this.data;\n var input=this.input;\n var output=this.output;\n var appDelegate=this.token.execution.appDelegate;\n var appServices=this.token.execution.servicesProvider;\n var appUtils=appDelegate.appUtils;\n "`` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | `any` | + +#### Returns + +``"\n var data=this.data;\n var input=this.input;\n var output=this.output;\n var appDelegate=this.execution.appDelegate;\n var appServices=this.execution.servicesProvider;\n var appUtils=appDelegate.appUtils;\n var item=this; // for backward support only\n "`` \| ``"\n var appDelegate=this.appDelegate;\n var appServices=this.servicesProvider;\n var appUtils=appDelegate.appUtils;\n "`` \| ``"\n var item=this;\n var data=this.data;\n var input=this.input;\n var output=this.output;\n var appDelegate=this.token.execution.appDelegate;\n var appServices=this.token.execution.servicesProvider;\n var appUtils=appDelegate.appUtils;\n "`` + +#### Defined in + +[engine/ScriptHandler.ts:116](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/ScriptHandler.ts#L116) diff --git a/docs/api/classes/ScriptTask.md b/docs/api/classes/ScriptTask.md new file mode 100644 index 00000000..5474af66 --- /dev/null +++ b/docs/api/classes/ScriptTask.md @@ -0,0 +1,999 @@ +[bpmn-server](../API.md) / ScriptTask + +# Class: ScriptTask + +## Hierarchy + +- [`Node`](Node.md) + + ↳ **`ScriptTask`** + +## Table of contents + +### Constructors + +- [constructor](ScriptTask.md#constructor) + +### Properties + +- [id](ScriptTask.md#id) +- [type](ScriptTask.md#type) +- [subType](ScriptTask.md#subtype) +- [behaviours](ScriptTask.md#behaviours) +- [isFlow](ScriptTask.md#isflow) +- [lane](ScriptTask.md#lane) +- [name](ScriptTask.md#name) +- [process](ScriptTask.md#process) +- [def](ScriptTask.md#def) +- [outbounds](ScriptTask.md#outbounds) +- [inbounds](ScriptTask.md#inbounds) +- [attachments](ScriptTask.md#attachments) +- [attachedTo](ScriptTask.md#attachedto) +- [messageId](ScriptTask.md#messageid) +- [signalId](ScriptTask.md#signalid) +- [initiator](ScriptTask.md#initiator) +- [assignee](ScriptTask.md#assignee) +- [candidateGroups](ScriptTask.md#candidategroups) +- [candidateUsers](ScriptTask.md#candidateusers) +- [scripts](ScriptTask.md#scripts) + +### Accessors + +- [processId](ScriptTask.md#processid) +- [requiresWait](ScriptTask.md#requireswait) +- [canBeInvoked](ScriptTask.md#canbeinvoked) +- [isCatching](ScriptTask.md#iscatching) + +### Methods + +- [restored](ScriptTask.md#restored) +- [hasBehaviour](ScriptTask.md#hasbehaviour) +- [getBehaviour](ScriptTask.md#getbehaviour) +- [addBehaviour](ScriptTask.md#addbehaviour) +- [validate](ScriptTask.md#validate) +- [doEvent](ScriptTask.md#doevent) +- [setInput](ScriptTask.md#setinput) +- [getInput](ScriptTask.md#getinput) +- [getOutput](ScriptTask.md#getoutput) +- [enter](ScriptTask.md#enter) +- [execute](ScriptTask.md#execute) +- [continue](ScriptTask.md#continue) +- [start](ScriptTask.md#start) +- [cancelEBG](ScriptTask.md#cancelebg) +- [cancelBoundaryEvents](ScriptTask.md#cancelboundaryevents) +- [end](ScriptTask.md#end) +- [resume](ScriptTask.md#resume) +- [init](ScriptTask.md#init) +- [getOutbounds](ScriptTask.md#getoutbounds) +- [startBoundaryEvents](ScriptTask.md#startboundaryevents) +- [describe](ScriptTask.md#describe) +- [run](ScriptTask.md#run) + +## Constructors + +### constructor + +• **new ScriptTask**(`id`, `process`, `type`, `def`): [`ScriptTask`](ScriptTask.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`ScriptTask`](ScriptTask.md) + +#### Inherited from + +[Node](Node.md).[constructor](Node.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Node](Node.md).[id](Node.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Node](Node.md).[type](Node.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Node](Node.md).[subType](Node.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[behaviours](Node.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Node](Node.md).[isFlow](Node.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Node](Node.md).[lane](Node.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Node](Node.md).[name](Node.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Node](Node.md).[process](Node.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Node](Node.md).[def](Node.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[outbounds](Node.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[inbounds](Node.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Node](Node.md).[attachments](Node.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Node](Node.md).[attachedTo](Node.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Node](Node.md).[messageId](Node.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Node](Node.md).[signalId](Node.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Node](Node.md).[initiator](Node.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Node](Node.md).[assignee](Node.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Node](Node.md).[candidateGroups](Node.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Node](Node.md).[candidateUsers](Node.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[scripts](Node.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Node.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.canBeInvoked + +#### Defined in + +[elements/Node.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L127) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[restored](Node.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Node](Node.md).[hasBehaviour](Node.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Node](Node.md).[getBehaviour](Node.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[addBehaviour](Node.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[validate](Node.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Node](Node.md).[doEvent](Node.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[setInput](Node.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getInput](Node.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getOutput](Node.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[enter](Node.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Node](Node.md).[execute](Node.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[continue](Node.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Node](Node.md).[start](Node.md#start) + +#### Defined in + +[elements/Node.ts:217](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L217) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelEBG](Node.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelBoundaryEvents](Node.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[end](Node.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[resume](Node.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[init](Node.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Node](Node.md).[getOutbounds](Node.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[startBoundaryEvents](Node.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Node](Node.md).[describe](Node.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Node](Node.md).[run](Node.md#run) + +#### Defined in + +[elements/Tasks.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L16) diff --git a/docs/api/classes/SecureUser.md b/docs/api/classes/SecureUser.md new file mode 100644 index 00000000..ea863280 --- /dev/null +++ b/docs/api/classes/SecureUser.md @@ -0,0 +1,478 @@ +[bpmn-server](../API.md) / SecureUser + +# Class: SecureUser + +## Implements + +- [`ISecureUser`](../interfaces/ISecureUser.md) + +## Table of contents + +### Constructors + +- [constructor](SecureUser.md#constructor) + +### Properties + +- [userName](SecureUser.md#username) +- [userGroups](SecureUser.md#usergroups) +- [tenantId](SecureUser.md#tenantid) +- [modelsOwner](SecureUser.md#modelsowner) + +### Methods + +- [SystemUser](SecureUser.md#systemuser) +- [isAdmin](SecureUser.md#isadmin) +- [isSystem](SecureUser.md#issystem) +- [inGroup](SecureUser.md#ingroup) +- [qualifyInstances](SecureUser.md#qualifyinstances) +- [qualifyItems](SecureUser.md#qualifyitems) +- [qualifyStartEvents](SecureUser.md#qualifystartevents) +- [qualifyDeleteInstances](SecureUser.md#qualifydeleteinstances) +- [qualifyModels](SecureUser.md#qualifymodels) +- [canModifyModel](SecureUser.md#canmodifymodel) +- [canDeleteModel](SecureUser.md#candeletemodel) +- [qualifyViewItems](SecureUser.md#qualifyviewitems) +- [canInvoke](SecureUser.md#caninvoke) +- [canAssign](SecureUser.md#canassign) +- [canStart](SecureUser.md#canstart) + +## Constructors + +### constructor + +• **new SecureUser**(`params`): [`SecureUser`](SecureUser.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | [`IUserInfo`](../interfaces/IUserInfo.md) | + +#### Returns + +[`SecureUser`](SecureUser.md) + +#### Defined in + +[API/SecureUser.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L40) + +## Properties + +### userName + +• **userName**: `any` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[userName](../interfaces/ISecureUser.md#username) + +#### Defined in + +[API/SecureUser.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L36) + +___ + +### userGroups + +• **userGroups**: `any` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[userGroups](../interfaces/ISecureUser.md#usergroups) + +#### Defined in + +[API/SecureUser.ts:37](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L37) + +___ + +### tenantId + +• `Optional` **tenantId**: `any` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[tenantId](../interfaces/ISecureUser.md#tenantid) + +#### Defined in + +[API/SecureUser.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L38) + +___ + +### modelsOwner + +• `Optional` **modelsOwner**: `any` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[modelsOwner](../interfaces/ISecureUser.md#modelsowner) + +#### Defined in + +[API/SecureUser.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L39) + +## Methods + +### SystemUser + +▸ **SystemUser**(): [`SecureUser`](SecureUser.md) + +#### Returns + +[`SecureUser`](SecureUser.md) + +#### Defined in + +[API/SecureUser.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L53) + +___ + +### isAdmin + +▸ **isAdmin**(): `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[isAdmin](../interfaces/ISecureUser.md#isadmin) + +#### Defined in + +[API/SecureUser.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L56) + +___ + +### isSystem + +▸ **isSystem**(): `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[isSystem](../interfaces/ISecureUser.md#issystem) + +#### Defined in + +[API/SecureUser.ts:61](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L61) + +___ + +### inGroup + +▸ **inGroup**(`userGroup`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userGroup` | `any` | + +#### Returns + +`boolean` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[inGroup](../interfaces/ISecureUser.md#ingroup) + +#### Defined in + +[API/SecureUser.ts:66](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L66) + +___ + +### qualifyInstances + +▸ **qualifyInstances**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[qualifyInstances](../interfaces/ISecureUser.md#qualifyinstances) + +#### Defined in + +[API/SecureUser.ts:76](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L76) + +___ + +### qualifyItems + +▸ **qualifyItems**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[qualifyItems](../interfaces/ISecureUser.md#qualifyitems) + +#### Defined in + +[API/SecureUser.ts:115](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L115) + +___ + +### qualifyStartEvents + +▸ **qualifyStartEvents**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[qualifyStartEvents](../interfaces/ISecureUser.md#qualifystartevents) + +#### Defined in + +[API/SecureUser.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L127) + +___ + +### qualifyDeleteInstances + +▸ **qualifyDeleteInstances**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[qualifyDeleteInstances](../interfaces/ISecureUser.md#qualifydeleteinstances) + +#### Defined in + +[API/SecureUser.ts:149](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L149) + +___ + +### qualifyModels + +▸ **qualifyModels**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[qualifyModels](../interfaces/ISecureUser.md#qualifymodels) + +#### Defined in + +[API/SecureUser.ts:160](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L160) + +___ + +### canModifyModel + +▸ **canModifyModel**(`name`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[canModifyModel](../interfaces/ISecureUser.md#canmodifymodel) + +#### Defined in + +[API/SecureUser.ts:170](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L170) + +___ + +### canDeleteModel + +▸ **canDeleteModel**(`name`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[canDeleteModel](../interfaces/ISecureUser.md#candeletemodel) + +#### Defined in + +[API/SecureUser.ts:178](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L178) + +___ + +### qualifyViewItems + +▸ **qualifyViewItems**(`query`): `Promise`\<`void`\> + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`Promise`\<`void`\> + +query + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[qualifyViewItems](../interfaces/ISecureUser.md#qualifyviewitems) + +#### Defined in + +[API/SecureUser.ts:189](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L189) + +___ + +### canInvoke + +▸ **canInvoke**(`item`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`boolean` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[canInvoke](../interfaces/ISecureUser.md#caninvoke) + +#### Defined in + +[API/SecureUser.ts:192](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L192) + +___ + +### canAssign + +▸ **canAssign**(`item`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`boolean` + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[canAssign](../interfaces/ISecureUser.md#canassign) + +#### Defined in + +[API/SecureUser.ts:201](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L201) + +___ + +### canStart + +▸ **canStart**(`name`, `startNodeId`, `user`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `startNodeId` | `any` | +| `user` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[ISecureUser](../interfaces/ISecureUser.md).[canStart](../interfaces/ISecureUser.md#canstart) + +#### Defined in + +[API/SecureUser.ts:228](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L228) diff --git a/docs/api/classes/SendTask.md b/docs/api/classes/SendTask.md new file mode 100644 index 00000000..fecb5fdc --- /dev/null +++ b/docs/api/classes/SendTask.md @@ -0,0 +1,1028 @@ +[bpmn-server](../API.md) / SendTask + +# Class: SendTask + +```ts + foo[method](); + + await this.token.appDelegate[serviceName](data); + + + service signature: + output= service (input,context) +``` + +## Hierarchy + +- [`ServiceTask`](ServiceTask.md) + + ↳ **`SendTask`** + +## Table of contents + +### Constructors + +- [constructor](SendTask.md#constructor) + +### Properties + +- [id](SendTask.md#id) +- [type](SendTask.md#type) +- [subType](SendTask.md#subtype) +- [behaviours](SendTask.md#behaviours) +- [isFlow](SendTask.md#isflow) +- [lane](SendTask.md#lane) +- [name](SendTask.md#name) +- [process](SendTask.md#process) +- [def](SendTask.md#def) +- [outbounds](SendTask.md#outbounds) +- [inbounds](SendTask.md#inbounds) +- [attachments](SendTask.md#attachments) +- [attachedTo](SendTask.md#attachedto) +- [messageId](SendTask.md#messageid) +- [signalId](SendTask.md#signalid) +- [initiator](SendTask.md#initiator) +- [assignee](SendTask.md#assignee) +- [candidateGroups](SendTask.md#candidategroups) +- [candidateUsers](SendTask.md#candidateusers) +- [scripts](SendTask.md#scripts) + +### Accessors + +- [processId](SendTask.md#processid) +- [requiresWait](SendTask.md#requireswait) +- [canBeInvoked](SendTask.md#canbeinvoked) +- [serviceName](SendTask.md#servicename) +- [isCatching](SendTask.md#iscatching) + +### Methods + +- [restored](SendTask.md#restored) +- [hasBehaviour](SendTask.md#hasbehaviour) +- [getBehaviour](SendTask.md#getbehaviour) +- [addBehaviour](SendTask.md#addbehaviour) +- [validate](SendTask.md#validate) +- [doEvent](SendTask.md#doevent) +- [setInput](SendTask.md#setinput) +- [getInput](SendTask.md#getinput) +- [getOutput](SendTask.md#getoutput) +- [enter](SendTask.md#enter) +- [execute](SendTask.md#execute) +- [continue](SendTask.md#continue) +- [start](SendTask.md#start) +- [cancelEBG](SendTask.md#cancelebg) +- [cancelBoundaryEvents](SendTask.md#cancelboundaryevents) +- [end](SendTask.md#end) +- [resume](SendTask.md#resume) +- [init](SendTask.md#init) +- [getOutbounds](SendTask.md#getoutbounds) +- [startBoundaryEvents](SendTask.md#startboundaryevents) +- [run](SendTask.md#run) +- [describe](SendTask.md#describe) + +## Constructors + +### constructor + +• **new SendTask**(`id`, `process`, `type`, `def`): [`SendTask`](SendTask.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`SendTask`](SendTask.md) + +#### Inherited from + +[ServiceTask](ServiceTask.md).[constructor](ServiceTask.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[id](ServiceTask.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[type](ServiceTask.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[subType](ServiceTask.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[behaviours](ServiceTask.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[isFlow](ServiceTask.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[lane](ServiceTask.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[name](ServiceTask.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[process](ServiceTask.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[def](ServiceTask.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[outbounds](ServiceTask.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[inbounds](ServiceTask.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[attachments](ServiceTask.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[ServiceTask](ServiceTask.md).[attachedTo](ServiceTask.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[messageId](ServiceTask.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[signalId](ServiceTask.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[initiator](ServiceTask.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[assignee](ServiceTask.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[candidateGroups](ServiceTask.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[candidateUsers](ServiceTask.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[scripts](ServiceTask.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServiceTask.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +ServiceTask.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +ServiceTask.canBeInvoked + +#### Defined in + +[elements/Node.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L127) + +___ + +### serviceName + +• `get` **serviceName**(): `any` + +#### Returns + +`any` + +#### Inherited from + +ServiceTask.serviceName + +#### Defined in + +[elements/Tasks.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L38) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +ServiceTask.isCatching + +#### Defined in + +[elements/Tasks.ts:135](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L135) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[restored](ServiceTask.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[hasBehaviour](ServiceTask.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[getBehaviour](ServiceTask.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[addBehaviour](ServiceTask.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[validate](ServiceTask.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[doEvent](ServiceTask.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[setInput](ServiceTask.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[getInput](ServiceTask.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[getOutput](ServiceTask.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[enter](ServiceTask.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[execute](ServiceTask.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[continue](ServiceTask.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[start](ServiceTask.md#start) + +#### Defined in + +[elements/Node.ts:217](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L217) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[cancelEBG](ServiceTask.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[cancelBoundaryEvents](ServiceTask.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[end](ServiceTask.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[resume](ServiceTask.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[ServiceTask](ServiceTask.md).[init](ServiceTask.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[getOutbounds](ServiceTask.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[startBoundaryEvents](ServiceTask.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[ServiceTask](ServiceTask.md).[run](ServiceTask.md#run) + +#### Defined in + +[elements/Tasks.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L47) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[ServiceTask](ServiceTask.md).[describe](ServiceTask.md#describe) + +#### Defined in + +[elements/Tasks.ts:94](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L94) diff --git a/docs/api/classes/ServerComponent.md b/docs/api/classes/ServerComponent.md new file mode 100644 index 00000000..3ff490e1 --- /dev/null +++ b/docs/api/classes/ServerComponent.md @@ -0,0 +1,201 @@ +[bpmn-server](../API.md) / ServerComponent + +# Class: ServerComponent + +super class for various objects that are part of the server + +## Hierarchy + +- **`ServerComponent`** + + ↳ [`Execution`](Execution.md) + + ↳ [`Cron`](Cron.md) + + ↳ [`CacheManager`](CacheManager.md) + + ↳ [`NoCacheManager`](NoCacheManager.md) + + ↳ [`Engine`](Engine.md) + + ↳ [`DataStore`](DataStore.md) + + ↳ [`ModelsDatastoreDB`](ModelsDatastoreDB.md) + +## Table of contents + +### Constructors + +- [constructor](ServerComponent.md#constructor) + +### Properties + +- [server](ServerComponent.md#server) + +### Accessors + +- [configuration](ServerComponent.md#configuration) +- [logger](ServerComponent.md#logger) +- [cron](ServerComponent.md#cron) +- [cache](ServerComponent.md#cache) +- [appDelegate](ServerComponent.md#appdelegate) +- [engine](ServerComponent.md#engine) +- [dataStore](ServerComponent.md#datastore) +- [definitions](ServerComponent.md#definitions) +- [listener](ServerComponent.md#listener) + +## Constructors + +### constructor + +• **new ServerComponent**(`server`): [`ServerComponent`](ServerComponent.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | [`IBPMNServer`](../interfaces/IBPMNServer.md) | + +#### Returns + +[`ServerComponent`](ServerComponent.md) + +#### Defined in + +[server/ServerComponent.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L10) + +## Properties + +### server + +• **server**: `any` + +#### Defined in + +[server/ServerComponent.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L9) + +## Accessors + +### configuration + +• `get` **configuration**(): `any` + +#### Returns + +`any` + +#### Defined in + +[server/ServerComponent.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L14) + +___ + +### logger + +• `get` **logger**(): `any` + +#### Returns + +`any` + +#### Defined in + +[server/ServerComponent.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L15) + +___ + +### cron + +• `get` **cron**(): [`Cron`](Cron.md) + +#### Returns + +[`Cron`](Cron.md) + +#### Defined in + +[server/ServerComponent.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L16) + +___ + +### cache + +• `get` **cache**(): [`CacheManager`](CacheManager.md) + +#### Returns + +[`CacheManager`](CacheManager.md) + +#### Defined in + +[server/ServerComponent.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L17) + +___ + +### appDelegate + +• `get` **appDelegate**(): `any` + +#### Returns + +`any` + +#### Defined in + +[server/ServerComponent.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L18) + +___ + +### engine + +• `get` **engine**(): [`IEngine`](../interfaces/IEngine.md) + +#### Returns + +[`IEngine`](../interfaces/IEngine.md) + +#### Defined in + +[server/ServerComponent.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L19) + +___ + +### dataStore + +• `get` **dataStore**(): `any` + +#### Returns + +`any` + +#### Defined in + +[server/ServerComponent.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L20) + +___ + +### definitions + +• `get` **definitions**(): `any` + +#### Returns + +`any` + +#### Defined in + +[server/ServerComponent.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L21) + +___ + +### listener + +• `get` **listener**(): `any` + +#### Returns + +`any` + +#### Defined in + +[server/ServerComponent.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/server/ServerComponent.ts#L22) diff --git a/docs/api/classes/ServiceTask.md b/docs/api/classes/ServiceTask.md new file mode 100644 index 00000000..d9095187 --- /dev/null +++ b/docs/api/classes/ServiceTask.md @@ -0,0 +1,1028 @@ +[bpmn-server](../API.md) / ServiceTask + +# Class: ServiceTask + +```ts + foo[method](); + + await this.token.appDelegate[serviceName](data); + + + service signature: + output= service (input,context) +``` + +## Hierarchy + +- [`Node`](Node.md) + + ↳ **`ServiceTask`** + + ↳↳ [`BusinessRuleTask`](BusinessRuleTask.md) + + ↳↳ [`SendTask`](SendTask.md) + +## Table of contents + +### Constructors + +- [constructor](ServiceTask.md#constructor) + +### Properties + +- [id](ServiceTask.md#id) +- [type](ServiceTask.md#type) +- [subType](ServiceTask.md#subtype) +- [behaviours](ServiceTask.md#behaviours) +- [isFlow](ServiceTask.md#isflow) +- [lane](ServiceTask.md#lane) +- [name](ServiceTask.md#name) +- [process](ServiceTask.md#process) +- [def](ServiceTask.md#def) +- [outbounds](ServiceTask.md#outbounds) +- [inbounds](ServiceTask.md#inbounds) +- [attachments](ServiceTask.md#attachments) +- [attachedTo](ServiceTask.md#attachedto) +- [messageId](ServiceTask.md#messageid) +- [signalId](ServiceTask.md#signalid) +- [initiator](ServiceTask.md#initiator) +- [assignee](ServiceTask.md#assignee) +- [candidateGroups](ServiceTask.md#candidategroups) +- [candidateUsers](ServiceTask.md#candidateusers) +- [scripts](ServiceTask.md#scripts) + +### Accessors + +- [processId](ServiceTask.md#processid) +- [requiresWait](ServiceTask.md#requireswait) +- [canBeInvoked](ServiceTask.md#canbeinvoked) +- [isCatching](ServiceTask.md#iscatching) +- [serviceName](ServiceTask.md#servicename) + +### Methods + +- [restored](ServiceTask.md#restored) +- [hasBehaviour](ServiceTask.md#hasbehaviour) +- [getBehaviour](ServiceTask.md#getbehaviour) +- [addBehaviour](ServiceTask.md#addbehaviour) +- [validate](ServiceTask.md#validate) +- [doEvent](ServiceTask.md#doevent) +- [setInput](ServiceTask.md#setinput) +- [getInput](ServiceTask.md#getinput) +- [getOutput](ServiceTask.md#getoutput) +- [enter](ServiceTask.md#enter) +- [execute](ServiceTask.md#execute) +- [continue](ServiceTask.md#continue) +- [start](ServiceTask.md#start) +- [cancelEBG](ServiceTask.md#cancelebg) +- [cancelBoundaryEvents](ServiceTask.md#cancelboundaryevents) +- [end](ServiceTask.md#end) +- [resume](ServiceTask.md#resume) +- [init](ServiceTask.md#init) +- [getOutbounds](ServiceTask.md#getoutbounds) +- [startBoundaryEvents](ServiceTask.md#startboundaryevents) +- [run](ServiceTask.md#run) +- [describe](ServiceTask.md#describe) + +## Constructors + +### constructor + +• **new ServiceTask**(`id`, `process`, `type`, `def`): [`ServiceTask`](ServiceTask.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`ServiceTask`](ServiceTask.md) + +#### Inherited from + +[Node](Node.md).[constructor](Node.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Node](Node.md).[id](Node.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Node](Node.md).[type](Node.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Node](Node.md).[subType](Node.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[behaviours](Node.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Node](Node.md).[isFlow](Node.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Node](Node.md).[lane](Node.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Node](Node.md).[name](Node.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Node](Node.md).[process](Node.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Node](Node.md).[def](Node.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[outbounds](Node.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[inbounds](Node.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Node](Node.md).[attachments](Node.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Node](Node.md).[attachedTo](Node.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Node](Node.md).[messageId](Node.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Node](Node.md).[signalId](Node.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Node](Node.md).[initiator](Node.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Node](Node.md).[assignee](Node.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Node](Node.md).[candidateGroups](Node.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Node](Node.md).[candidateUsers](Node.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[scripts](Node.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Node.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.canBeInvoked + +#### Defined in + +[elements/Node.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L127) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +___ + +### serviceName + +• `get` **serviceName**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/Tasks.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L38) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[restored](Node.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Node](Node.md).[hasBehaviour](Node.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Node](Node.md).[getBehaviour](Node.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[addBehaviour](Node.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[validate](Node.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Node](Node.md).[doEvent](Node.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[setInput](Node.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getInput](Node.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getOutput](Node.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[enter](Node.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Node](Node.md).[execute](Node.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[continue](Node.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Node](Node.md).[start](Node.md#start) + +#### Defined in + +[elements/Node.ts:217](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L217) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelEBG](Node.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelBoundaryEvents](Node.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[end](Node.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[resume](Node.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[init](Node.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Node](Node.md).[getOutbounds](Node.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[startBoundaryEvents](Node.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Node](Node.md).[run](Node.md#run) + +#### Defined in + +[elements/Tasks.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L47) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Overrides + +[Node](Node.md).[describe](Node.md#describe) + +#### Defined in + +[elements/Tasks.ts:94](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L94) diff --git a/docs/api/classes/SignalEventBehaviour.md b/docs/api/classes/SignalEventBehaviour.md new file mode 100644 index 00000000..df97348c --- /dev/null +++ b/docs/api/classes/SignalEventBehaviour.md @@ -0,0 +1,367 @@ +[bpmn-server](../API.md) / SignalEventBehaviour + +# Class: SignalEventBehaviour + +Behaviour + ioSpecification + timer + message + signal + + each behaviour is a class + it scans def and insert itself to perform actions as required + +## Hierarchy + +- [`Behaviour`](Behaviour.md) + + ↳ **`SignalEventBehaviour`** + +## Table of contents + +### Constructors + +- [constructor](SignalEventBehaviour.md#constructor) + +### Properties + +- [node](SignalEventBehaviour.md#node) +- [definition](SignalEventBehaviour.md#definition) + +### Accessors + +- [signalId](SignalEventBehaviour.md#signalid) + +### Methods + +- [restored](SignalEventBehaviour.md#restored) +- [enter](SignalEventBehaviour.md#enter) +- [run](SignalEventBehaviour.md#run) +- [exit](SignalEventBehaviour.md#exit) +- [resume](SignalEventBehaviour.md#resume) +- [getNodeAttributes](SignalEventBehaviour.md#getnodeattributes) +- [getItemAttributes](SignalEventBehaviour.md#getitemattributes) +- [init](SignalEventBehaviour.md#init) +- [start](SignalEventBehaviour.md#start) +- [end](SignalEventBehaviour.md#end) +- [describe](SignalEventBehaviour.md#describe) + +## Constructors + +### constructor + +• **new SignalEventBehaviour**(`node`, `definition`): [`SignalEventBehaviour`](SignalEventBehaviour.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `definition` | `any` | + +#### Returns + +[`SignalEventBehaviour`](SignalEventBehaviour.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[constructor](Behaviour.md#constructor) + +#### Defined in + +[elements/behaviours/Behaviour.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L40) + +## Properties + +### node + +• **node**: [`Node`](Node.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[node](Behaviour.md#node) + +#### Defined in + +[elements/behaviours/Behaviour.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L38) + +___ + +### definition + +• **definition**: `any` + +#### Inherited from + +[Behaviour](Behaviour.md).[definition](Behaviour.md#definition) + +#### Defined in + +[elements/behaviours/Behaviour.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L39) + +## Accessors + +### signalId + +• `get` **signalId**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/MessageSignal.ts:76](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L76) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[restored](Behaviour.md#restored) + +#### Defined in + +[elements/behaviours/Behaviour.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L45) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[enter](Behaviour.md#enter) + +#### Defined in + +[elements/behaviours/Behaviour.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L48) + +___ + +### run + +▸ **run**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[run](Behaviour.md#run) + +#### Defined in + +[elements/behaviours/Behaviour.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L50) + +___ + +### exit + +▸ **exit**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[exit](Behaviour.md#exit) + +#### Defined in + +[elements/behaviours/Behaviour.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L52) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[resume](Behaviour.md#resume) + +#### Defined in + +[elements/behaviours/Behaviour.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L53) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getNodeAttributes](Behaviour.md#getnodeattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L54) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getItemAttributes](Behaviour.md#getitemattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L55) + +___ + +### init + +▸ **init**(): `void` + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[init](Behaviour.md#init) + +#### Defined in + +[elements/behaviours/MessageSignal.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L50) + +___ + +### start + +▸ **start**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[Behaviour](Behaviour.md).[start](Behaviour.md#start) + +#### Defined in + +[elements/behaviours/MessageSignal.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L54) + +___ + +### end + +▸ **end**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[end](Behaviour.md#end) + +#### Defined in + +[elements/behaviours/MessageSignal.ts:68](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L68) + +___ + +### describe + +▸ **describe**(): `string`[] + +#### Returns + +`string`[] + +#### Overrides + +[Behaviour](Behaviour.md).[describe](Behaviour.md#describe) + +#### Defined in + +[elements/behaviours/MessageSignal.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/MessageSignal.ts#L70) diff --git a/docs/api/classes/StartEvent.md b/docs/api/classes/StartEvent.md new file mode 100644 index 00000000..c7bbdba1 --- /dev/null +++ b/docs/api/classes/StartEvent.md @@ -0,0 +1,1058 @@ +[bpmn-server](../API.md) / StartEvent + +# Class: StartEvent + +## Hierarchy + +- [`Event`](Event.md) + + ↳ **`StartEvent`** + +## Table of contents + +### Constructors + +- [constructor](StartEvent.md#constructor) + +### Properties + +- [id](StartEvent.md#id) +- [type](StartEvent.md#type) +- [subType](StartEvent.md#subtype) +- [behaviours](StartEvent.md#behaviours) +- [isFlow](StartEvent.md#isflow) +- [lane](StartEvent.md#lane) +- [name](StartEvent.md#name) +- [process](StartEvent.md#process) +- [def](StartEvent.md#def) +- [outbounds](StartEvent.md#outbounds) +- [inbounds](StartEvent.md#inbounds) +- [attachments](StartEvent.md#attachments) +- [attachedTo](StartEvent.md#attachedto) +- [messageId](StartEvent.md#messageid) +- [signalId](StartEvent.md#signalid) +- [initiator](StartEvent.md#initiator) +- [assignee](StartEvent.md#assignee) +- [candidateGroups](StartEvent.md#candidategroups) +- [candidateUsers](StartEvent.md#candidateusers) +- [scripts](StartEvent.md#scripts) + +### Accessors + +- [canBeInvoked](StartEvent.md#canbeinvoked) +- [isCatching](StartEvent.md#iscatching) +- [processId](StartEvent.md#processid) +- [requiresWait](StartEvent.md#requireswait) + +### Methods + +- [restored](StartEvent.md#restored) +- [hasBehaviour](StartEvent.md#hasbehaviour) +- [getBehaviour](StartEvent.md#getbehaviour) +- [addBehaviour](StartEvent.md#addbehaviour) +- [hasMessage](StartEvent.md#hasmessage) +- [hasSignal](StartEvent.md#hassignal) +- [hasTimer](StartEvent.md#hastimer) +- [end](StartEvent.md#end) +- [start](StartEvent.md#start) +- [validate](StartEvent.md#validate) +- [doEvent](StartEvent.md#doevent) +- [setInput](StartEvent.md#setinput) +- [getInput](StartEvent.md#getinput) +- [getOutput](StartEvent.md#getoutput) +- [enter](StartEvent.md#enter) +- [execute](StartEvent.md#execute) +- [continue](StartEvent.md#continue) +- [run](StartEvent.md#run) +- [cancelEBG](StartEvent.md#cancelebg) +- [cancelBoundaryEvents](StartEvent.md#cancelboundaryevents) +- [resume](StartEvent.md#resume) +- [init](StartEvent.md#init) +- [getOutbounds](StartEvent.md#getoutbounds) +- [startBoundaryEvents](StartEvent.md#startboundaryevents) +- [describe](StartEvent.md#describe) + +## Constructors + +### constructor + +• **new StartEvent**(`id`, `process`, `type`, `def`): [`StartEvent`](StartEvent.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`StartEvent`](StartEvent.md) + +#### Overrides + +[Event](Event.md).[constructor](Event.md#constructor) + +#### Defined in + +[elements/Events.ts:119](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L119) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Event](Event.md).[id](Event.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Event](Event.md).[type](Event.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Event](Event.md).[subType](Event.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[behaviours](Event.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Event](Event.md).[isFlow](Event.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Event](Event.md).[lane](Event.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Event](Event.md).[name](Event.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Event](Event.md).[process](Event.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Event](Event.md).[def](Event.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[outbounds](Event.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[inbounds](Event.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Event](Event.md).[attachments](Event.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Event](Event.md).[attachedTo](Event.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Event](Event.md).[messageId](Event.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Event](Event.md).[signalId](Event.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Event](Event.md).[initiator](Event.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Event](Event.md).[assignee](Event.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Event](Event.md).[candidateGroups](Event.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Event](Event.md).[candidateUsers](Event.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[scripts](Event.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Event.canBeInvoked + +#### Defined in + +[elements/Events.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L32) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Event.isCatching + +#### Defined in + +[elements/Events.ts:136](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L136) + +___ + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Event.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Event.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[restored](Event.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Event](Event.md).[hasBehaviour](Event.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[getBehaviour](Event.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[addBehaviour](Event.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### hasMessage + +▸ **hasMessage**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasMessage](Event.md#hasmessage) + +#### Defined in + +[elements/Events.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L9) + +___ + +### hasSignal + +▸ **hasSignal**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasSignal](Event.md#hassignal) + +#### Defined in + +[elements/Events.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L12) + +___ + +### hasTimer + +▸ **hasTimer**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasTimer](Event.md#hastimer) + +#### Defined in + +[elements/Events.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L15) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[end](Event.md#end) + +#### Defined in + +[elements/Events.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L28) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +using token: check if fromEventBasedGateway; if yes cancel all other events + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Event](Event.md).[start](Event.md#start) + +#### Defined in + +[elements/Events.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L127) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[validate](Event.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Event](Event.md).[doEvent](Event.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[setInput](Event.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getInput](Event.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getOutput](Event.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[enter](Event.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Event](Event.md).[execute](Event.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[continue](Event.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Event](Event.md).[run](Event.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelEBG](Event.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelBoundaryEvents](Event.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[resume](Event.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[init](Event.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Event](Event.md).[getOutbounds](Event.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[startBoundaryEvents](Event.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Event](Event.md).[describe](Event.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/SubProcess.md b/docs/api/classes/SubProcess.md new file mode 100644 index 00000000..e8642eed --- /dev/null +++ b/docs/api/classes/SubProcess.md @@ -0,0 +1,1012 @@ +[bpmn-server](../API.md) / SubProcess + +# Class: SubProcess + +## Hierarchy + +- [`Node`](Node.md) + + ↳ **`SubProcess`** + + ↳↳ [`Transaction`](Transaction.md) + +## Table of contents + +### Constructors + +- [constructor](SubProcess.md#constructor) + +### Properties + +- [id](SubProcess.md#id) +- [type](SubProcess.md#type) +- [subType](SubProcess.md#subtype) +- [behaviours](SubProcess.md#behaviours) +- [isFlow](SubProcess.md#isflow) +- [lane](SubProcess.md#lane) +- [name](SubProcess.md#name) +- [process](SubProcess.md#process) +- [def](SubProcess.md#def) +- [outbounds](SubProcess.md#outbounds) +- [inbounds](SubProcess.md#inbounds) +- [attachments](SubProcess.md#attachments) +- [attachedTo](SubProcess.md#attachedto) +- [messageId](SubProcess.md#messageid) +- [signalId](SubProcess.md#signalid) +- [initiator](SubProcess.md#initiator) +- [assignee](SubProcess.md#assignee) +- [candidateGroups](SubProcess.md#candidategroups) +- [candidateUsers](SubProcess.md#candidateusers) +- [scripts](SubProcess.md#scripts) +- [childProcess](SubProcess.md#childprocess) + +### Accessors + +- [processId](SubProcess.md#processid) +- [isCatching](SubProcess.md#iscatching) +- [requiresWait](SubProcess.md#requireswait) +- [canBeInvoked](SubProcess.md#canbeinvoked) + +### Methods + +- [restored](SubProcess.md#restored) +- [hasBehaviour](SubProcess.md#hasbehaviour) +- [getBehaviour](SubProcess.md#getbehaviour) +- [addBehaviour](SubProcess.md#addbehaviour) +- [validate](SubProcess.md#validate) +- [doEvent](SubProcess.md#doevent) +- [setInput](SubProcess.md#setinput) +- [getInput](SubProcess.md#getinput) +- [getOutput](SubProcess.md#getoutput) +- [enter](SubProcess.md#enter) +- [execute](SubProcess.md#execute) +- [continue](SubProcess.md#continue) +- [run](SubProcess.md#run) +- [cancelEBG](SubProcess.md#cancelebg) +- [cancelBoundaryEvents](SubProcess.md#cancelboundaryevents) +- [end](SubProcess.md#end) +- [resume](SubProcess.md#resume) +- [init](SubProcess.md#init) +- [getOutbounds](SubProcess.md#getoutbounds) +- [startBoundaryEvents](SubProcess.md#startboundaryevents) +- [describe](SubProcess.md#describe) +- [start](SubProcess.md#start) + +## Constructors + +### constructor + +• **new SubProcess**(`id`, `process`, `type`, `def`): [`SubProcess`](SubProcess.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`SubProcess`](SubProcess.md) + +#### Inherited from + +[Node](Node.md).[constructor](Node.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Node](Node.md).[id](Node.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Node](Node.md).[type](Node.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Node](Node.md).[subType](Node.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[behaviours](Node.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Node](Node.md).[isFlow](Node.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Node](Node.md).[lane](Node.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Node](Node.md).[name](Node.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Node](Node.md).[process](Node.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Node](Node.md).[def](Node.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[outbounds](Node.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[inbounds](Node.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Node](Node.md).[attachments](Node.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Node](Node.md).[attachedTo](Node.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Node](Node.md).[messageId](Node.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Node](Node.md).[signalId](Node.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Node](Node.md).[initiator](Node.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Node](Node.md).[assignee](Node.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Node](Node.md).[candidateGroups](Node.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Node](Node.md).[candidateUsers](Node.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[scripts](Node.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +___ + +### childProcess + +• **childProcess**: [`Process`](Process.md) + +#### Defined in + +[elements/Tasks.ts:224](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L224) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Node.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.requiresWait + +#### Defined in + +[elements/Tasks.ts:225](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L225) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.canBeInvoked + +#### Defined in + +[elements/Tasks.ts:226](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L226) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[restored](Node.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Node](Node.md).[hasBehaviour](Node.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Node](Node.md).[getBehaviour](Node.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[addBehaviour](Node.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[validate](Node.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Node](Node.md).[doEvent](Node.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[setInput](Node.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getInput](Node.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getOutput](Node.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[enter](Node.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Node](Node.md).[execute](Node.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[continue](Node.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Node](Node.md).[run](Node.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelEBG](Node.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelBoundaryEvents](Node.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[end](Node.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[resume](Node.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[init](Node.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Node](Node.md).[getOutbounds](Node.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[startBoundaryEvents](Node.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Node](Node.md).[describe](Node.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Node](Node.md).[start](Node.md#start) + +#### Defined in + +[elements/Tasks.ts:228](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L228) diff --git a/docs/api/classes/TerminateBehaviour.md b/docs/api/classes/TerminateBehaviour.md new file mode 100644 index 00000000..69354910 --- /dev/null +++ b/docs/api/classes/TerminateBehaviour.md @@ -0,0 +1,349 @@ +[bpmn-server](../API.md) / TerminateBehaviour + +# Class: TerminateBehaviour + +Behaviour + ioSpecification + timer + message + signal + + each behaviour is a class + it scans def and insert itself to perform actions as required + +## Hierarchy + +- [`Behaviour`](Behaviour.md) + + ↳ **`TerminateBehaviour`** + +## Table of contents + +### Constructors + +- [constructor](TerminateBehaviour.md#constructor) + +### Properties + +- [node](TerminateBehaviour.md#node) +- [definition](TerminateBehaviour.md#definition) + +### Methods + +- [restored](TerminateBehaviour.md#restored) +- [init](TerminateBehaviour.md#init) +- [enter](TerminateBehaviour.md#enter) +- [run](TerminateBehaviour.md#run) +- [exit](TerminateBehaviour.md#exit) +- [resume](TerminateBehaviour.md#resume) +- [getNodeAttributes](TerminateBehaviour.md#getnodeattributes) +- [getItemAttributes](TerminateBehaviour.md#getitemattributes) +- [start](TerminateBehaviour.md#start) +- [end](TerminateBehaviour.md#end) +- [describe](TerminateBehaviour.md#describe) + +## Constructors + +### constructor + +• **new TerminateBehaviour**(`node`, `definition`): [`TerminateBehaviour`](TerminateBehaviour.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `definition` | `any` | + +#### Returns + +[`TerminateBehaviour`](TerminateBehaviour.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[constructor](Behaviour.md#constructor) + +#### Defined in + +[elements/behaviours/Behaviour.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L40) + +## Properties + +### node + +• **node**: [`Node`](Node.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[node](Behaviour.md#node) + +#### Defined in + +[elements/behaviours/Behaviour.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L38) + +___ + +### definition + +• **definition**: `any` + +#### Inherited from + +[Behaviour](Behaviour.md).[definition](Behaviour.md#definition) + +#### Defined in + +[elements/behaviours/Behaviour.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L39) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[restored](Behaviour.md#restored) + +#### Defined in + +[elements/behaviours/Behaviour.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L45) + +___ + +### init + +▸ **init**(): `void` + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[init](Behaviour.md#init) + +#### Defined in + +[elements/behaviours/Behaviour.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L47) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[enter](Behaviour.md#enter) + +#### Defined in + +[elements/behaviours/Behaviour.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L48) + +___ + +### run + +▸ **run**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[run](Behaviour.md#run) + +#### Defined in + +[elements/behaviours/Behaviour.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L50) + +___ + +### exit + +▸ **exit**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[exit](Behaviour.md#exit) + +#### Defined in + +[elements/behaviours/Behaviour.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L52) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[resume](Behaviour.md#resume) + +#### Defined in + +[elements/behaviours/Behaviour.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L53) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getNodeAttributes](Behaviour.md#getnodeattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L54) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getItemAttributes](Behaviour.md#getitemattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L55) + +___ + +### start + +▸ **start**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[start](Behaviour.md#start) + +#### Defined in + +[elements/behaviours/Terminate.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Terminate.ts#L11) + +___ + +### end + +▸ **end**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[end](Behaviour.md#end) + +#### Defined in + +[elements/behaviours/Terminate.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Terminate.ts#L12) + +___ + +### describe + +▸ **describe**(): `string`[][] + +#### Returns + +`string`[][] + +#### Overrides + +[Behaviour](Behaviour.md).[describe](Behaviour.md#describe) + +#### Defined in + +[elements/behaviours/Terminate.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Terminate.ts#L18) diff --git a/docs/api/classes/ThrowEvent.md b/docs/api/classes/ThrowEvent.md new file mode 100644 index 00000000..ba41bc1d --- /dev/null +++ b/docs/api/classes/ThrowEvent.md @@ -0,0 +1,1060 @@ +[bpmn-server](../API.md) / ThrowEvent + +# Class: ThrowEvent + +## Hierarchy + +- [`Event`](Event.md) + + ↳ **`ThrowEvent`** + +## Table of contents + +### Constructors + +- [constructor](ThrowEvent.md#constructor) + +### Properties + +- [id](ThrowEvent.md#id) +- [type](ThrowEvent.md#type) +- [subType](ThrowEvent.md#subtype) +- [behaviours](ThrowEvent.md#behaviours) +- [isFlow](ThrowEvent.md#isflow) +- [lane](ThrowEvent.md#lane) +- [name](ThrowEvent.md#name) +- [process](ThrowEvent.md#process) +- [def](ThrowEvent.md#def) +- [outbounds](ThrowEvent.md#outbounds) +- [inbounds](ThrowEvent.md#inbounds) +- [attachments](ThrowEvent.md#attachments) +- [attachedTo](ThrowEvent.md#attachedto) +- [messageId](ThrowEvent.md#messageid) +- [signalId](ThrowEvent.md#signalid) +- [initiator](ThrowEvent.md#initiator) +- [assignee](ThrowEvent.md#assignee) +- [candidateGroups](ThrowEvent.md#candidategroups) +- [candidateUsers](ThrowEvent.md#candidateusers) +- [scripts](ThrowEvent.md#scripts) + +### Accessors + +- [canBeInvoked](ThrowEvent.md#canbeinvoked) +- [isCatching](ThrowEvent.md#iscatching) +- [processId](ThrowEvent.md#processid) +- [requiresWait](ThrowEvent.md#requireswait) + +### Methods + +- [restored](ThrowEvent.md#restored) +- [hasBehaviour](ThrowEvent.md#hasbehaviour) +- [getBehaviour](ThrowEvent.md#getbehaviour) +- [addBehaviour](ThrowEvent.md#addbehaviour) +- [hasMessage](ThrowEvent.md#hasmessage) +- [hasSignal](ThrowEvent.md#hassignal) +- [hasTimer](ThrowEvent.md#hastimer) +- [end](ThrowEvent.md#end) +- [start](ThrowEvent.md#start) +- [run](ThrowEvent.md#run) +- [validate](ThrowEvent.md#validate) +- [doEvent](ThrowEvent.md#doevent) +- [setInput](ThrowEvent.md#setinput) +- [getInput](ThrowEvent.md#getinput) +- [getOutput](ThrowEvent.md#getoutput) +- [enter](ThrowEvent.md#enter) +- [execute](ThrowEvent.md#execute) +- [continue](ThrowEvent.md#continue) +- [cancelEBG](ThrowEvent.md#cancelebg) +- [cancelBoundaryEvents](ThrowEvent.md#cancelboundaryevents) +- [resume](ThrowEvent.md#resume) +- [init](ThrowEvent.md#init) +- [getOutbounds](ThrowEvent.md#getoutbounds) +- [startBoundaryEvents](ThrowEvent.md#startboundaryevents) +- [describe](ThrowEvent.md#describe) + +## Constructors + +### constructor + +• **new ThrowEvent**(`id`, `process`, `type`, `def`): [`ThrowEvent`](ThrowEvent.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`ThrowEvent`](ThrowEvent.md) + +#### Inherited from + +[Event](Event.md).[constructor](Event.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Event](Event.md).[id](Event.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Event](Event.md).[type](Event.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Event](Event.md).[subType](Event.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[behaviours](Event.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Event](Event.md).[isFlow](Event.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Event](Event.md).[lane](Event.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Event](Event.md).[name](Event.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Event](Event.md).[process](Event.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Event](Event.md).[def](Event.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[outbounds](Event.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Event](Event.md).[inbounds](Event.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Event](Event.md).[attachments](Event.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Event](Event.md).[attachedTo](Event.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Event](Event.md).[messageId](Event.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Event](Event.md).[signalId](Event.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Event](Event.md).[initiator](Event.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Event](Event.md).[assignee](Event.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Event](Event.md).[candidateGroups](Event.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Event](Event.md).[candidateUsers](Event.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Event](Event.md).[scripts](Event.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Event.canBeInvoked + +#### Defined in + +[elements/Events.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L32) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +using token: check if fromEventBasedGateway; if yes cancel all other events + +#### Returns + +`boolean` + +#### Overrides + +Event.isCatching + +#### Defined in + +[elements/Events.ts:100](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L100) + +___ + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Event.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Event.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[restored](Event.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Event](Event.md).[hasBehaviour](Event.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[getBehaviour](Event.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[addBehaviour](Event.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### hasMessage + +▸ **hasMessage**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasMessage](Event.md#hasmessage) + +#### Defined in + +[elements/Events.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L9) + +___ + +### hasSignal + +▸ **hasSignal**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasSignal](Event.md#hassignal) + +#### Defined in + +[elements/Events.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L12) + +___ + +### hasTimer + +▸ **hasTimer**(): `any` + +#### Returns + +`any` + +#### Inherited from + +[Event](Event.md).[hasTimer](Event.md#hastimer) + +#### Defined in + +[elements/Events.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L15) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[end](Event.md#end) + +#### Defined in + +[elements/Events.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L28) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +using token: check if fromEventBasedGateway; if yes cancel all other events + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Event](Event.md).[start](Event.md#start) + +#### Defined in + +[elements/Events.ts:102](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L102) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Event](Event.md).[run](Event.md#run) + +#### Defined in + +[elements/Events.ts:105](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Events.ts#L105) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[validate](Event.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Event](Event.md).[doEvent](Event.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[setInput](Event.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getInput](Event.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Event](Event.md).[getOutput](Event.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[enter](Event.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Event](Event.md).[execute](Event.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[continue](Event.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelEBG](Event.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[cancelBoundaryEvents](Event.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[resume](Event.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Event](Event.md).[init](Event.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Event](Event.md).[getOutbounds](Event.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Event](Event.md).[startBoundaryEvents](Event.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Event](Event.md).[describe](Event.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/classes/TimerBehaviour.md b/docs/api/classes/TimerBehaviour.md new file mode 100644 index 00000000..4593dcdc --- /dev/null +++ b/docs/api/classes/TimerBehaviour.md @@ -0,0 +1,469 @@ +[bpmn-server](../API.md) / TimerBehaviour + +# Class: TimerBehaviour + +Behaviour + ioSpecification + timer + message + signal + + each behaviour is a class + it scans def and insert itself to perform actions as required + +## Hierarchy + +- [`Behaviour`](Behaviour.md) + + ↳ **`TimerBehaviour`** + +## Table of contents + +### Constructors + +- [constructor](TimerBehaviour.md#constructor) + +### Properties + +- [node](TimerBehaviour.md#node) +- [definition](TimerBehaviour.md#definition) +- [duration](TimerBehaviour.md#duration) +- [repeat](TimerBehaviour.md#repeat) +- [timeCycle](TimerBehaviour.md#timecycle) +- [timeDate](TimerBehaviour.md#timedate) + +### Methods + +- [restored](TimerBehaviour.md#restored) +- [enter](TimerBehaviour.md#enter) +- [run](TimerBehaviour.md#run) +- [exit](TimerBehaviour.md#exit) +- [getNodeAttributes](TimerBehaviour.md#getnodeattributes) +- [getItemAttributes](TimerBehaviour.md#getitemattributes) +- [init](TimerBehaviour.md#init) +- [describe](TimerBehaviour.md#describe) +- [timeDue](TimerBehaviour.md#timedue) +- [getRepeat](TimerBehaviour.md#getrepeat) +- [start](TimerBehaviour.md#start) +- [startTimer](TimerBehaviour.md#starttimer) +- [expires](TimerBehaviour.md#expires) +- [end](TimerBehaviour.md#end) +- [resume](TimerBehaviour.md#resume) + +## Constructors + +### constructor + +• **new TimerBehaviour**(`node`, `definition`): [`TimerBehaviour`](TimerBehaviour.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | [`Node`](Node.md) | +| `definition` | `any` | + +#### Returns + +[`TimerBehaviour`](TimerBehaviour.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[constructor](Behaviour.md#constructor) + +#### Defined in + +[elements/behaviours/Behaviour.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L40) + +## Properties + +### node + +• **node**: [`Node`](Node.md) + +#### Inherited from + +[Behaviour](Behaviour.md).[node](Behaviour.md#node) + +#### Defined in + +[elements/behaviours/Behaviour.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L38) + +___ + +### definition + +• **definition**: `any` + +#### Inherited from + +[Behaviour](Behaviour.md).[definition](Behaviour.md#definition) + +#### Defined in + +[elements/behaviours/Behaviour.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L39) + +___ + +### duration + +• **duration**: `any` + +#### Defined in + +[elements/behaviours/Timer.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L55) + +___ + +### repeat + +• **repeat**: `number` = `1` + +#### Defined in + +[elements/behaviours/Timer.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L56) + +___ + +### timeCycle + +• **timeCycle**: `any` + +#### Defined in + +[elements/behaviours/Timer.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L57) + +___ + +### timeDate + +• **timeDate**: `any` + +#### Defined in + +[elements/behaviours/Timer.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L58) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[restored](Behaviour.md#restored) + +#### Defined in + +[elements/behaviours/Behaviour.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L45) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[enter](Behaviour.md#enter) + +#### Defined in + +[elements/behaviours/Behaviour.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L48) + +___ + +### run + +▸ **run**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[run](Behaviour.md#run) + +#### Defined in + +[elements/behaviours/Behaviour.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L50) + +___ + +### exit + +▸ **exit**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[exit](Behaviour.md#exit) + +#### Defined in + +[elements/behaviours/Behaviour.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L52) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getNodeAttributes](Behaviour.md#getnodeattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L54) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `attributes` | `any`[] | + +#### Returns + +`void` + +#### Inherited from + +[Behaviour](Behaviour.md).[getItemAttributes](Behaviour.md#getitemattributes) + +#### Defined in + +[elements/behaviours/Behaviour.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L55) + +___ + +### init + +▸ **init**(): `void` + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[init](Behaviour.md#init) + +#### Defined in + +[elements/behaviours/Timer.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L59) + +___ + +### describe + +▸ **describe**(): `string`[][] + +#### Returns + +`string`[][] + +#### Overrides + +[Behaviour](Behaviour.md).[describe](Behaviour.md#describe) + +#### Defined in + +[elements/behaviours/Timer.ts:82](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L82) + +___ + +### timeDue + +▸ **timeDue**(`item`, `timerModifier?`): `any` + +return the next time the timer is due +format is time format + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `item` | `any` | `undefined` | - | +| `timerModifier` | `any` | `null` | for testing purposes configuration can alter the timer | + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Timer.ts:99](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L99) + +___ + +### getRepeat + +▸ **getRepeat**(`input`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | `any` | + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Timer.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L129) + +___ + +### start + +▸ **start**(`item`): [`NODE_ACTION`](../enums/NODE_ACTION.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`NODE_ACTION`](../enums/NODE_ACTION.md) + +#### Overrides + +[Behaviour](Behaviour.md).[start](Behaviour.md#start) + +#### Defined in + +[elements/behaviours/Timer.ts:137](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L137) + +___ + +### startTimer + +▸ **startTimer**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`void` + +#### Defined in + +[elements/behaviours/Timer.ts:148](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L148) + +___ + +### expires + +▸ **expires**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/behaviours/Timer.ts:166](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L166) + +___ + +### end + +▸ **end**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[end](Behaviour.md#end) + +#### Defined in + +[elements/behaviours/Timer.ts:202](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L202) + +___ + +### resume + +▸ **resume**(): `void` + +#### Returns + +`void` + +#### Overrides + +[Behaviour](Behaviour.md).[resume](Behaviour.md#resume) + +#### Defined in + +[elements/behaviours/Timer.ts:206](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Timer.ts#L206) diff --git a/docs/api/classes/Token.md b/docs/api/classes/Token.md new file mode 100644 index 00000000..8ed58c19 --- /dev/null +++ b/docs/api/classes/Token.md @@ -0,0 +1,912 @@ +[bpmn-server](../API.md) / Token + +# Class: Token + +## Implements + +- [`IToken`](../interfaces/IToken.md) + +## Table of contents + +### Constructors + +- [constructor](Token.md#constructor) + +### Properties + +- [id](Token.md#id) +- [type](Token.md#type) +- [execution](Token.md#execution) +- [dataPath](Token.md#datapath) +- [startNodeId](Token.md#startnodeid) +- [parentToken](Token.md#parenttoken) +- [originItem](Token.md#originitem) +- [path](Token.md#path) +- [loop](Token.md#loop) +- [currentNode](Token.md#currentnode) +- [processId](Token.md#processid) +- [status](Token.md#status) +- [input](Token.md#input) +- [output](Token.md#output) +- [messageMatchingKey](Token.md#messagematchingkey) + +### Accessors + +- [data](Token.md#data) +- [currentItem](Token.md#currentitem) +- [firstItem](Token.md#firstitem) +- [lastItem](Token.md#lastitem) +- [childrenTokens](Token.md#childrentokens) + +### Methods + +- [hasNode](Token.md#hasnode) +- [getFullPath](Token.md#getfullpath) +- [startNewToken](Token.md#startnewtoken) +- [save](Token.md#save) +- [load](Token.md#load) +- [stop](Token.md#stop) +- [resume](Token.md#resume) +- [restored](Token.md#restored) +- [getSubProcessToken](Token.md#getsubprocesstoken) +- [getChildrenTokens](Token.md#getchildrentokens) +- [preExecute](Token.md#preexecute) +- [preNext](Token.md#prenext) +- [execute](Token.md#execute) +- [processError](Token.md#processerror) +- [processEscalation](Token.md#processescalation) +- [appendData](Token.md#appenddata) +- [terminate](Token.md#terminate) +- [continue](Token.md#continue) +- [signal](Token.md#signal) +- [end](Token.md#end) +- [setCurrentNode](Token.md#setcurrentnode) +- [goNext](Token.md#gonext) +- [log](Token.md#log) +- [info](Token.md#info) +- [error](Token.md#error) + +## Constructors + +### constructor + +• **new Token**(`type`, `execution`, `startNode`, `dataPath?`, `parentToken?`, `originItem?`): [`Token`](Token.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`TOKEN_TYPE`](../enums/TOKEN_TYPE.md) | +| `execution` | [`Execution`](Execution.md) | +| `startNode` | [`Node`](Node.md) | +| `dataPath?` | `any` | +| `parentToken?` | [`Token`](Token.md) | +| `originItem?` | [`Item`](Item.md) | + +#### Returns + +[`Token`](Token.md) + +#### Defined in + +[engine/Token.ts:115](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L115) + +## Properties + +### id + +• **id**: `any` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[id](../interfaces/IToken.md#id) + +#### Defined in + +[engine/Token.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L58) + +___ + +### type + +• **type**: [`TOKEN_TYPE`](../enums/TOKEN_TYPE.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[type](../interfaces/IToken.md#type) + +#### Defined in + +[engine/Token.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L59) + +___ + +### execution + +• **execution**: [`IExecution`](../interfaces/IExecution.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[execution](../interfaces/IToken.md#execution) + +#### Defined in + +[engine/Token.ts:60](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L60) + +___ + +### dataPath + +• **dataPath**: `string` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[dataPath](../interfaces/IToken.md#datapath) + +#### Defined in + +[engine/Token.ts:61](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L61) + +___ + +### startNodeId + +• **startNodeId**: `any` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[startNodeId](../interfaces/IToken.md#startnodeid) + +#### Defined in + +[engine/Token.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L62) + +___ + +### parentToken + +• `Optional` **parentToken**: [`Token`](Token.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[parentToken](../interfaces/IToken.md#parenttoken) + +#### Defined in + +[engine/Token.ts:63](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L63) + +___ + +### originItem + +• **originItem**: [`Item`](Item.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[originItem](../interfaces/IToken.md#originitem) + +#### Defined in + +[engine/Token.ts:65](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L65) + +___ + +### path + +• **path**: [`Item`](Item.md)[] + +#### Implementation of + +[IToken](../interfaces/IToken.md).[path](../interfaces/IToken.md#path) + +#### Defined in + +[engine/Token.ts:66](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L66) + +___ + +### loop + +• **loop**: [`Loop`](Loop.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[loop](../interfaces/IToken.md#loop) + +#### Defined in + +[engine/Token.ts:67](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L67) + +___ + +### currentNode + +• **currentNode**: [`Node`](Node.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[currentNode](../interfaces/IToken.md#currentnode) + +#### Defined in + +[engine/Token.ts:68](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L68) + +___ + +### processId + +• **processId**: `any` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[processId](../interfaces/IToken.md#processid) + +#### Defined in + +[engine/Token.ts:69](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L69) + +___ + +### status + +• **status**: [`TOKEN_STATUS`](../enums/TOKEN_STATUS.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[status](../interfaces/IToken.md#status) + +#### Defined in + +[engine/Token.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L70) + +___ + +### input + +• **input**: `Object` + +#### Defined in + +[engine/Token.ts:71](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L71) + +___ + +### output + +• **output**: `Object` + +#### Defined in + +[engine/Token.ts:72](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L72) + +___ + +### messageMatchingKey + +• **messageMatchingKey**: `Object` + +#### Defined in + +[engine/Token.ts:73](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L73) + +## Accessors + +### data + +• `get` **data**(): `any` + +#### Returns + +`any` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[data](../interfaces/IToken.md#data) + +#### Defined in + +[engine/Token.ts:75](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L75) + +___ + +### currentItem + +• `get` **currentItem**(): [`Item`](Item.md) + +#### Returns + +[`Item`](Item.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[currentItem](../interfaces/IToken.md#currentitem) + +#### Defined in + +[engine/Token.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L78) + +___ + +### firstItem + +• `get` **firstItem**(): [`Item`](Item.md) + +#### Returns + +[`Item`](Item.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[firstItem](../interfaces/IToken.md#firstitem) + +#### Defined in + +[engine/Token.ts:81](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L81) + +___ + +### lastItem + +• `get` **lastItem**(): [`Item`](Item.md) + +#### Returns + +[`Item`](Item.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[lastItem](../interfaces/IToken.md#lastitem) + +#### Defined in + +[engine/Token.ts:93](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L93) + +___ + +### childrenTokens + +• `get` **childrenTokens**(): [`Token`](Token.md)[] + +#### Returns + +[`Token`](Token.md)[] + +#### Implementation of + +[IToken](../interfaces/IToken.md).[childrenTokens](../interfaces/IToken.md#childrentokens) + +#### Defined in + +[engine/Token.ts:103](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L103) + +## Methods + +### hasNode + +▸ **hasNode**(`nodeId`): `Boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | `any` | + +#### Returns + +`Boolean` + +#### Defined in + +[engine/Token.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L85) + +___ + +### getFullPath + +▸ **getFullPath**(`path?`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `path` | `any`[] | `[]` | + +#### Returns + +[`Item`](Item.md)[] + +#### Implementation of + +[IToken](../interfaces/IToken.md).[getFullPath](../interfaces/IToken.md#getfullpath) + +#### Defined in + +[engine/Token.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L109) + +___ + +### startNewToken + +▸ **startNewToken**(`type`, `execution`, `startNode`, `dataPath`, `parentToken`, `originItem`, `loop`, `data?`, `noExecute?`): `Promise`\<[`Token`](Token.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `type` | [`TOKEN_TYPE`](../enums/TOKEN_TYPE.md) | `undefined` | +| `execution` | `any` | `undefined` | +| `startNode` | `any` | `undefined` | +| `dataPath` | `any` | `undefined` | +| `parentToken` | [`Token`](Token.md) | `undefined` | +| `originItem` | [`Item`](Item.md) | `undefined` | +| `loop` | [`Loop`](Loop.md) | `undefined` | +| `data` | `any` | `null` | +| `noExecute` | `boolean` | `false` | + +#### Returns + +`Promise`\<[`Token`](Token.md)\> + +#### Defined in + +[engine/Token.ts:141](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L141) + +___ + +### save + +▸ **save**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `type` | [`TOKEN_TYPE`](../enums/TOKEN_TYPE.md) | +| `status` | [`TOKEN_STATUS`](../enums/TOKEN_STATUS.md) | +| `dataPath` | `string` | +| `loopId` | `any` | +| `parentToken` | `any` | +| `originItem` | `any` | +| `startNodeId` | `any` | +| `currentNode` | `any` | + +#### Implementation of + +[IToken](../interfaces/IToken.md).[save](../interfaces/IToken.md#save) + +#### Defined in + +[engine/Token.ts:153](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L153) + +___ + +### load + +▸ **load**(`execution`, `da`): [`Token`](Token.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`Execution`](Execution.md) | +| `da` | `any` | + +#### Returns + +[`Token`](Token.md) + +#### Defined in + +[engine/Token.ts:168](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L168) + +___ + +### stop + +▸ **stop**(): `void` + +#### Returns + +`void` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[stop](../interfaces/IToken.md#stop) + +#### Defined in + +[engine/Token.ts:181](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L181) + +___ + +### resume + +▸ **resume**(): `void` + +#### Returns + +`void` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[resume](../interfaces/IToken.md#resume) + +#### Defined in + +[engine/Token.ts:190](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L190) + +___ + +### restored + +▸ **restored**(): `void` + +#### Returns + +`void` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[restored](../interfaces/IToken.md#restored) + +#### Defined in + +[engine/Token.ts:194](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L194) + +___ + +### getSubProcessToken + +▸ **getSubProcessToken**(): [`Token`](Token.md) + +#### Returns + +[`Token`](Token.md) + +#### Implementation of + +[IToken](../interfaces/IToken.md).[getSubProcessToken](../interfaces/IToken.md#getsubprocesstoken) + +#### Defined in + +[engine/Token.ts:199](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L199) + +___ + +### getChildrenTokens + +▸ **getChildrenTokens**(): `any`[] + +#### Returns + +`any`[] + +#### Implementation of + +[IToken](../interfaces/IToken.md).[getChildrenTokens](../interfaces/IToken.md#getchildrentokens) + +#### Defined in + +[engine/Token.ts:208](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L208) + +___ + +### preExecute + +▸ **preExecute**(): `Promise`\<`boolean`\> + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[IToken](../interfaces/IToken.md).[preExecute](../interfaces/IToken.md#preexecute) + +#### Defined in + +[engine/Token.ts:220](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L220) + +___ + +### preNext + +▸ **preNext**(): `Promise`\<`boolean`\> + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[IToken](../interfaces/IToken.md).[preNext](../interfaces/IToken.md#prenext) + +#### Defined in + +[engine/Token.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L227) + +___ + +### execute + +▸ **execute**(`input`): `Promise`\<`void`\> + +this is the primary exectuion method for a token +Pre-Conditions: + currentNode is set + status!= end + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IToken](../interfaces/IToken.md).[execute](../interfaces/IToken.md#execute) + +#### Defined in + +[engine/Token.ts:238](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L238) + +___ + +### processError + +▸ **processError**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IToken](../interfaces/IToken.md).[processError](../interfaces/IToken.md#processerror) + +#### Defined in + +[engine/Token.ts:300](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L300) + +___ + +### processEscalation + +▸ **processEscalation**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[engine/Token.ts:330](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L330) + +___ + +### appendData + +▸ **appendData**(`inputData`, `item`): `void` + +renamed from applyInput to appendData + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inputData` | `any` | +| `item` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[appendData](../interfaces/IToken.md#appenddata) + +#### Defined in + +[engine/Token.ts:358](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L358) + +___ + +### terminate + +▸ **terminate**(): `Promise`\<`void`\> + +is called by Gateways to cancel current token + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IToken](../interfaces/IToken.md).[terminate](../interfaces/IToken.md#terminate) + +#### Defined in + +[engine/Token.ts:365](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L365) + +___ + +### continue + +▸ **continue**(): `Promise`\<`void`\> + +is called by events to cancel current token + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[engine/Token.ts:375](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L375) + +___ + +### signal + +▸ **signal**(`data`, `options?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `any` | +| `options` | `Object` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IToken](../interfaces/IToken.md).[signal](../interfaces/IToken.md#signal) + +#### Defined in + +[engine/Token.ts:384](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L384) + +___ + +### end + +▸ **end**(`cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IToken](../interfaces/IToken.md).[end](../interfaces/IToken.md#end) + +#### Defined in + +[engine/Token.ts:416](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L416) + +___ + +### setCurrentNode + +▸ **setCurrentNode**(`newCurrentNode`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `newCurrentNode` | [`Node`](Node.md) | + +#### Returns + +`void` + +#### Defined in + +[engine/Token.ts:444](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L444) + +___ + +### goNext + +▸ **goNext**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[IToken](../interfaces/IToken.md).[goNext](../interfaces/IToken.md#gonext) + +#### Defined in + +[engine/Token.ts:454](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L454) + +___ + +### log + +▸ **log**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[log](../interfaces/IToken.md#log) + +#### Defined in + +[engine/Token.ts:523](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L523) + +___ + +### info + +▸ **info**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[info](../interfaces/IToken.md#info) + +#### Defined in + +[engine/Token.ts:526](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L526) + +___ + +### error + +▸ **error**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `any` | + +#### Returns + +`void` + +#### Implementation of + +[IToken](../interfaces/IToken.md).[error](../interfaces/IToken.md#error) + +#### Defined in + +[engine/Token.ts:529](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L529) diff --git a/docs/api/classes/TokenObject.md b/docs/api/classes/TokenObject.md new file mode 100644 index 00000000..4e4b6d0c --- /dev/null +++ b/docs/api/classes/TokenObject.md @@ -0,0 +1,110 @@ +[bpmn-server](../API.md) / TokenObject + +# Class: TokenObject + +## Table of contents + +### Constructors + +- [constructor](TokenObject.md#constructor) + +### Properties + +- [id](TokenObject.md#id) +- [status](TokenObject.md#status) +- [dataPath](TokenObject.md#datapath) +- [loopId](TokenObject.md#loopid) +- [parentTokenId](TokenObject.md#parenttokenid) +- [branchNodeId](TokenObject.md#branchnodeid) +- [startNodeId](TokenObject.md#startnodeid) +- [currentNodeId](TokenObject.md#currentnodeid) + +## Constructors + +### constructor + +• **new TokenObject**(): [`TokenObject`](TokenObject.md) + +#### Returns + +[`TokenObject`](TokenObject.md) + +## Properties + +### id + +• **id**: `any` + +#### Defined in + +[engine/Model.ts:66](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L66) + +___ + +### status + +• **status**: `any` + +#### Defined in + +[engine/Model.ts:67](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L67) + +___ + +### dataPath + +• **dataPath**: `any` + +#### Defined in + +[engine/Model.ts:68](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L68) + +___ + +### loopId + +• **loopId**: `any` + +#### Defined in + +[engine/Model.ts:69](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L69) + +___ + +### parentTokenId + +• **parentTokenId**: `any` + +#### Defined in + +[engine/Model.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L70) + +___ + +### branchNodeId + +• **branchNodeId**: `any` + +#### Defined in + +[engine/Model.ts:71](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L71) + +___ + +### startNodeId + +• **startNodeId**: `any` + +#### Defined in + +[engine/Model.ts:72](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L72) + +___ + +### currentNodeId + +• **currentNodeId**: `any` + +#### Defined in + +[engine/Model.ts:73](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Model.ts#L73) diff --git a/docs/api/classes/Transaction.md b/docs/api/classes/Transaction.md new file mode 100644 index 00000000..17849fa2 --- /dev/null +++ b/docs/api/classes/Transaction.md @@ -0,0 +1,1125 @@ +[bpmn-server](../API.md) / Transaction + +# Class: Transaction + +## Hierarchy + +- [`SubProcess`](SubProcess.md) + + ↳ **`Transaction`** + +## Table of contents + +### Constructors + +- [constructor](Transaction.md#constructor) + +### Properties + +- [id](Transaction.md#id) +- [type](Transaction.md#type) +- [subType](Transaction.md#subtype) +- [behaviours](Transaction.md#behaviours) +- [isFlow](Transaction.md#isflow) +- [lane](Transaction.md#lane) +- [name](Transaction.md#name) +- [process](Transaction.md#process) +- [def](Transaction.md#def) +- [outbounds](Transaction.md#outbounds) +- [inbounds](Transaction.md#inbounds) +- [attachments](Transaction.md#attachments) +- [attachedTo](Transaction.md#attachedto) +- [messageId](Transaction.md#messageid) +- [signalId](Transaction.md#signalid) +- [initiator](Transaction.md#initiator) +- [assignee](Transaction.md#assignee) +- [candidateGroups](Transaction.md#candidategroups) +- [candidateUsers](Transaction.md#candidateusers) +- [scripts](Transaction.md#scripts) +- [childProcess](Transaction.md#childprocess) + +### Accessors + +- [processId](Transaction.md#processid) +- [isCatching](Transaction.md#iscatching) +- [canBeInvoked](Transaction.md#canbeinvoked) +- [requiresWait](Transaction.md#requireswait) + +### Methods + +- [restored](Transaction.md#restored) +- [hasBehaviour](Transaction.md#hasbehaviour) +- [getBehaviour](Transaction.md#getbehaviour) +- [addBehaviour](Transaction.md#addbehaviour) +- [validate](Transaction.md#validate) +- [doEvent](Transaction.md#doevent) +- [setInput](Transaction.md#setinput) +- [getInput](Transaction.md#getinput) +- [getOutput](Transaction.md#getoutput) +- [enter](Transaction.md#enter) +- [execute](Transaction.md#execute) +- [continue](Transaction.md#continue) +- [run](Transaction.md#run) +- [cancelEBG](Transaction.md#cancelebg) +- [cancelBoundaryEvents](Transaction.md#cancelboundaryevents) +- [resume](Transaction.md#resume) +- [init](Transaction.md#init) +- [getOutbounds](Transaction.md#getoutbounds) +- [startBoundaryEvents](Transaction.md#startboundaryevents) +- [describe](Transaction.md#describe) +- [end](Transaction.md#end) +- [Cancel](Transaction.md#cancel) +- [Compensate](Transaction.md#compensate) +- [getNodes](Transaction.md#getnodes) +- [getItemsForToken](Transaction.md#getitemsfortoken) +- [getItems](Transaction.md#getitems) +- [start](Transaction.md#start) + +## Constructors + +### constructor + +• **new Transaction**(`id`, `process`, `type`, `def`): [`Transaction`](Transaction.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`Transaction`](Transaction.md) + +#### Inherited from + +[SubProcess](SubProcess.md).[constructor](SubProcess.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[id](SubProcess.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[type](SubProcess.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[subType](SubProcess.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[SubProcess](SubProcess.md).[behaviours](SubProcess.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[SubProcess](SubProcess.md).[isFlow](SubProcess.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[lane](SubProcess.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[name](SubProcess.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[process](SubProcess.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[def](SubProcess.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[SubProcess](SubProcess.md).[outbounds](SubProcess.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[SubProcess](SubProcess.md).[inbounds](SubProcess.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[SubProcess](SubProcess.md).[attachments](SubProcess.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[SubProcess](SubProcess.md).[attachedTo](SubProcess.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[messageId](SubProcess.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[signalId](SubProcess.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[initiator](SubProcess.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[assignee](SubProcess.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[candidateGroups](SubProcess.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[SubProcess](SubProcess.md).[candidateUsers](SubProcess.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[SubProcess](SubProcess.md).[scripts](SubProcess.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +___ + +### childProcess + +• **childProcess**: [`Process`](Process.md) + +#### Inherited from + +[SubProcess](SubProcess.md).[childProcess](SubProcess.md#childprocess) + +#### Defined in + +[elements/Tasks.ts:224](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L224) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +SubProcess.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +SubProcess.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +SubProcess.canBeInvoked + +#### Defined in + +[elements/Tasks.ts:226](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L226) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +SubProcess.requiresWait + +#### Defined in + +[elements/Transaction.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Transaction.ts#L15) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[SubProcess](SubProcess.md).[restored](SubProcess.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[SubProcess](SubProcess.md).[hasBehaviour](SubProcess.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[SubProcess](SubProcess.md).[getBehaviour](SubProcess.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[SubProcess](SubProcess.md).[addBehaviour](SubProcess.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[SubProcess](SubProcess.md).[validate](SubProcess.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[SubProcess](SubProcess.md).[doEvent](SubProcess.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[SubProcess](SubProcess.md).[setInput](SubProcess.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[SubProcess](SubProcess.md).[getInput](SubProcess.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[SubProcess](SubProcess.md).[getOutput](SubProcess.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[SubProcess](SubProcess.md).[enter](SubProcess.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[SubProcess](SubProcess.md).[execute](SubProcess.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[SubProcess](SubProcess.md).[continue](SubProcess.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[SubProcess](SubProcess.md).[run](SubProcess.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[SubProcess](SubProcess.md).[cancelEBG](SubProcess.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[SubProcess](SubProcess.md).[cancelBoundaryEvents](SubProcess.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[SubProcess](SubProcess.md).[resume](SubProcess.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[SubProcess](SubProcess.md).[init](SubProcess.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[SubProcess](SubProcess.md).[getOutbounds](SubProcess.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[SubProcess](SubProcess.md).[startBoundaryEvents](SubProcess.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[SubProcess](SubProcess.md).[describe](SubProcess.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | `any` | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[SubProcess](SubProcess.md).[end](SubProcess.md#end) + +#### Defined in + +[elements/Transaction.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Transaction.ts#L17) + +___ + +### Cancel + +▸ **Cancel**(`transaction`): `Promise`\<`void`\> + +Cancel Transaction + is called by Throw Cancel Event + + 1. Aborts any started items in the transaction + 2. Compensate any completed items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Transaction.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Transaction.ts#L31) + +___ + +### Compensate + +▸ **Compensate**(`transItem`): `Promise`\<`void`\> + +Compensate Transaction + is called by Throw Compensate Event + this is called outside of the transaction + + 1. Compensate any completed items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transItem` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Transaction.ts:43](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Transaction.ts#L43) + +___ + +### getNodes + +▸ **getNodes**(): [`Node`](Node.md)[] + +#### Returns + +[`Node`](Node.md)[] + +#### Defined in + +[elements/Transaction.ts:74](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Transaction.ts#L74) + +___ + +### getItemsForToken + +▸ **getItemsForToken**(`token`): `any`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `any` | + +#### Returns + +`any`[] + +#### Defined in + +[elements/Transaction.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Transaction.ts#L78) + +___ + +### getItems + +▸ **getItems**(`item`): `any`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`any`[] + +#### Defined in + +[elements/Transaction.ts:92](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Transaction.ts#L92) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[SubProcess](SubProcess.md).[start](SubProcess.md#start) + +#### Defined in + +[elements/Transaction.ts:97](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Transaction.ts#L97) diff --git a/docs/api/classes/UserTask.md b/docs/api/classes/UserTask.md new file mode 100644 index 00000000..381a6e66 --- /dev/null +++ b/docs/api/classes/UserTask.md @@ -0,0 +1,1021 @@ +[bpmn-server](../API.md) / UserTask + +# Class: UserTask + +## Hierarchy + +- [`Node`](Node.md) + + ↳ **`UserTask`** + +## Table of contents + +### Constructors + +- [constructor](UserTask.md#constructor) + +### Properties + +- [id](UserTask.md#id) +- [type](UserTask.md#type) +- [subType](UserTask.md#subtype) +- [behaviours](UserTask.md#behaviours) +- [isFlow](UserTask.md#isflow) +- [lane](UserTask.md#lane) +- [name](UserTask.md#name) +- [process](UserTask.md#process) +- [def](UserTask.md#def) +- [outbounds](UserTask.md#outbounds) +- [inbounds](UserTask.md#inbounds) +- [attachments](UserTask.md#attachments) +- [attachedTo](UserTask.md#attachedto) +- [messageId](UserTask.md#messageid) +- [signalId](UserTask.md#signalid) +- [initiator](UserTask.md#initiator) +- [assignee](UserTask.md#assignee) +- [candidateGroups](UserTask.md#candidategroups) +- [candidateUsers](UserTask.md#candidateusers) +- [scripts](UserTask.md#scripts) + +### Accessors + +- [processId](UserTask.md#processid) +- [isCatching](UserTask.md#iscatching) +- [requiresWait](UserTask.md#requireswait) +- [canBeInvoked](UserTask.md#canbeinvoked) + +### Methods + +- [restored](UserTask.md#restored) +- [hasBehaviour](UserTask.md#hasbehaviour) +- [getBehaviour](UserTask.md#getbehaviour) +- [addBehaviour](UserTask.md#addbehaviour) +- [validate](UserTask.md#validate) +- [doEvent](UserTask.md#doevent) +- [setInput](UserTask.md#setinput) +- [getInput](UserTask.md#getinput) +- [getOutput](UserTask.md#getoutput) +- [enter](UserTask.md#enter) +- [execute](UserTask.md#execute) +- [continue](UserTask.md#continue) +- [run](UserTask.md#run) +- [cancelEBG](UserTask.md#cancelebg) +- [cancelBoundaryEvents](UserTask.md#cancelboundaryevents) +- [resume](UserTask.md#resume) +- [init](UserTask.md#init) +- [getOutbounds](UserTask.md#getoutbounds) +- [startBoundaryEvents](UserTask.md#startboundaryevents) +- [end](UserTask.md#end) +- [start](UserTask.md#start) +- [setAssignVal](UserTask.md#setassignval) +- [describe](UserTask.md#describe) + +## Constructors + +### constructor + +• **new UserTask**(`id`, `process`, `type`, `def`): [`UserTask`](UserTask.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`UserTask`](UserTask.md) + +#### Inherited from + +[Node](Node.md).[constructor](Node.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Node](Node.md).[id](Node.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Node](Node.md).[type](Node.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Node](Node.md).[subType](Node.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[behaviours](Node.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Node](Node.md).[isFlow](Node.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Node](Node.md).[lane](Node.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Node](Node.md).[name](Node.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Node](Node.md).[process](Node.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Node](Node.md).[def](Node.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[outbounds](Node.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Node](Node.md).[inbounds](Node.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Node](Node.md).[attachments](Node.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Node](Node.md).[attachedTo](Node.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Node](Node.md).[messageId](Node.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Node](Node.md).[signalId](Node.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Node](Node.md).[initiator](Node.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Node](Node.md).[assignee](Node.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Node](Node.md).[candidateGroups](Node.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Node](Node.md).[candidateUsers](Node.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Node](Node.md).[scripts](Node.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Node.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Node.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.requiresWait + +#### Defined in + +[elements/Tasks.ts:213](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L213) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Node.canBeInvoked + +#### Defined in + +[elements/Tasks.ts:214](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L214) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[restored](Node.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Node](Node.md).[hasBehaviour](Node.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Node](Node.md).[getBehaviour](Node.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[addBehaviour](Node.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[validate](Node.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Node](Node.md).[doEvent](Node.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[setInput](Node.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getInput](Node.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Node](Node.md).[getOutput](Node.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[enter](Node.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Node](Node.md).[execute](Node.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[continue](Node.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Node](Node.md).[run](Node.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelEBG](Node.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[cancelBoundaryEvents](Node.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[resume](Node.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Node](Node.md).[init](Node.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +[`Item`](Item.md)[] + +#### Inherited from + +[Node](Node.md).[getOutbounds](Node.md#getoutbounds) + +#### Defined in + +[elements/Node.ts:315](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L315) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Node](Node.md).[startBoundaryEvents](Node.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### end + +▸ **end**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[Node](Node.md).[end](Node.md#end) + +#### Defined in + +[elements/Tasks.ts:149](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L149) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Overrides + +[Node](Node.md).[start](Node.md#start) + +#### Defined in + +[elements/Tasks.ts:153](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L153) + +___ + +### setAssignVal + +▸ **setAssignVal**(`item`, `attr`, `dateFormat?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | `any` | `undefined` | +| `attr` | `any` | `undefined` | +| `dateFormat` | `boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[elements/Tasks.ts:174](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L174) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Overrides + +[Node](Node.md).[describe](Node.md#describe) + +#### Defined in + +[elements/Tasks.ts:202](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Tasks.ts#L202) diff --git a/docs/api/classes/XORGateway.md b/docs/api/classes/XORGateway.md new file mode 100644 index 00000000..176763fd --- /dev/null +++ b/docs/api/classes/XORGateway.md @@ -0,0 +1,1110 @@ +[bpmn-server](../API.md) / XORGateway + +# Class: XORGateway + +ExclusiveGatway: + outbounds: only 1 + inbound: only 1 - + +## Hierarchy + +- [`Gateway`](Gateway.md) + + ↳ **`XORGateway`** + +## Table of contents + +### Constructors + +- [constructor](XORGateway.md#constructor) + +### Properties + +- [id](XORGateway.md#id) +- [type](XORGateway.md#type) +- [subType](XORGateway.md#subtype) +- [behaviours](XORGateway.md#behaviours) +- [isFlow](XORGateway.md#isflow) +- [lane](XORGateway.md#lane) +- [name](XORGateway.md#name) +- [process](XORGateway.md#process) +- [def](XORGateway.md#def) +- [outbounds](XORGateway.md#outbounds) +- [inbounds](XORGateway.md#inbounds) +- [attachments](XORGateway.md#attachments) +- [attachedTo](XORGateway.md#attachedto) +- [messageId](XORGateway.md#messageid) +- [signalId](XORGateway.md#signalid) +- [initiator](XORGateway.md#initiator) +- [assignee](XORGateway.md#assignee) +- [candidateGroups](XORGateway.md#candidategroups) +- [candidateUsers](XORGateway.md#candidateusers) +- [scripts](XORGateway.md#scripts) + +### Accessors + +- [processId](XORGateway.md#processid) +- [requiresWait](XORGateway.md#requireswait) +- [canBeInvoked](XORGateway.md#canbeinvoked) +- [isCatching](XORGateway.md#iscatching) + +### Methods + +- [restored](XORGateway.md#restored) +- [hasBehaviour](XORGateway.md#hasbehaviour) +- [getBehaviour](XORGateway.md#getbehaviour) +- [addBehaviour](XORGateway.md#addbehaviour) +- [getPotentialPath](XORGateway.md#getpotentialpath) +- [canReach](XORGateway.md#canreach) +- [getRelatedTokens](XORGateway.md#getrelatedtokens) +- [analyzeConvergingTokens](XORGateway.md#analyzeconvergingtokens) +- [start](XORGateway.md#start) +- [getOutbounds](XORGateway.md#getoutbounds) +- [validate](XORGateway.md#validate) +- [doEvent](XORGateway.md#doevent) +- [setInput](XORGateway.md#setinput) +- [getInput](XORGateway.md#getinput) +- [getOutput](XORGateway.md#getoutput) +- [enter](XORGateway.md#enter) +- [execute](XORGateway.md#execute) +- [continue](XORGateway.md#continue) +- [run](XORGateway.md#run) +- [cancelEBG](XORGateway.md#cancelebg) +- [cancelBoundaryEvents](XORGateway.md#cancelboundaryevents) +- [end](XORGateway.md#end) +- [resume](XORGateway.md#resume) +- [init](XORGateway.md#init) +- [startBoundaryEvents](XORGateway.md#startboundaryevents) +- [describe](XORGateway.md#describe) + +## Constructors + +### constructor + +• **new XORGateway**(`id`, `process`, `type`, `def`): [`XORGateway`](XORGateway.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `process` | `any` | +| `type` | `any` | +| `def` | `any` | + +#### Returns + +[`XORGateway`](XORGateway.md) + +#### Inherited from + +[Gateway](Gateway.md).[constructor](Gateway.md#constructor) + +#### Defined in + +[elements/Node.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L31) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[id](Gateway.md#id) + +#### Defined in + +[elements/Element.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L13) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[type](Gateway.md#type) + +#### Defined in + +[elements/Element.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L14) + +___ + +### subType + +• **subType**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[subType](Gateway.md#subtype) + +#### Defined in + +[elements/Element.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L15) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Gateway](Gateway.md).[behaviours](Gateway.md#behaviours) + +#### Defined in + +[elements/Element.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L17) + +___ + +### isFlow + +• **isFlow**: `boolean` = `false` + +#### Inherited from + +[Gateway](Gateway.md).[isFlow](Gateway.md#isflow) + +#### Defined in + +[elements/Element.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L18) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[lane](Gateway.md#lane) + +#### Defined in + +[elements/Element.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L19) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[name](Gateway.md#name) + +#### Defined in + +[elements/Node.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L12) + +___ + +### process + +• **process**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[process](Gateway.md#process) + +#### Defined in + +[elements/Node.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L13) + +___ + +### def + +• **def**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[def](Gateway.md#def) + +#### Defined in + +[elements/Node.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L14) + +___ + +### outbounds + +• **outbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Gateway](Gateway.md).[outbounds](Gateway.md#outbounds) + +#### Defined in + +[elements/Node.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L15) + +___ + +### inbounds + +• **inbounds**: [`Flow`](Flow.md)[] + +#### Inherited from + +[Gateway](Gateway.md).[inbounds](Gateway.md#inbounds) + +#### Defined in + +[elements/Node.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L16) + +___ + +### attachments + +• **attachments**: [`Node`](Node.md)[] + +#### Inherited from + +[Gateway](Gateway.md).[attachments](Gateway.md#attachments) + +#### Defined in + +[elements/Node.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L17) + +___ + +### attachedTo + +• **attachedTo**: [`Node`](Node.md) + +#### Inherited from + +[Gateway](Gateway.md).[attachedTo](Gateway.md#attachedto) + +#### Defined in + +[elements/Node.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L18) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[messageId](Gateway.md#messageid) + +#### Defined in + +[elements/Node.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[signalId](Gateway.md#signalid) + +#### Defined in + +[elements/Node.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L20) + +___ + +### initiator + +• **initiator**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[initiator](Gateway.md#initiator) + +#### Defined in + +[elements/Node.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[assignee](Gateway.md#assignee) + +#### Defined in + +[elements/Node.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[candidateGroups](Gateway.md#candidategroups) + +#### Defined in + +[elements/Node.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[Gateway](Gateway.md).[candidateUsers](Gateway.md#candidateusers) + +#### Defined in + +[elements/Node.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L24) + +___ + +### scripts + +• **scripts**: `Map`\<`any`, `any`\> + +#### Inherited from + +[Gateway](Gateway.md).[scripts](Gateway.md#scripts) + +#### Defined in + +[elements/Node.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L25) + +## Accessors + +### processId + +• `get` **processId**(): `any` + +#### Returns + +`any` + +#### Inherited from + +Gateway.processId + +#### Defined in + +[elements/Node.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L26) + +___ + +### requiresWait + +• `get` **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Gateway.requiresWait + +#### Defined in + +[elements/Node.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L122) + +___ + +### canBeInvoked + +• `get` **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Gateway.canBeInvoked + +#### Defined in + +[elements/Node.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L127) + +___ + +### isCatching + +• `get` **isCatching**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Gateway.isCatching + +#### Defined in + +[elements/Node.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L129) + +## Methods + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Gateway](Gateway.md).[restored](Gateway.md#restored) + +#### Defined in + +[elements/Element.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L24) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Gateway](Gateway.md).[hasBehaviour](Gateway.md#hasbehaviour) + +#### Defined in + +[elements/Element.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Gateway](Gateway.md).[getBehaviour](Gateway.md#getbehaviour) + +#### Defined in + +[elements/Element.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L38) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[Gateway](Gateway.md).[addBehaviour](Gateway.md#addbehaviour) + +#### Defined in + +[elements/Element.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Element.ts#L41) + +___ + +### getPotentialPath + +▸ **getPotentialPath**(`node`, `path?`): `any` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `node` | `any` | `undefined` | +| `path` | `any` | `null` | + +#### Returns + +`any` + +#### Inherited from + +[Gateway](Gateway.md).[getPotentialPath](Gateway.md#getpotentialpath) + +#### Defined in + +[elements/Gateway.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L64) + +___ + +### canReach + +▸ **canReach**(`node`, `target`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `node` | `any` | +| `target` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Gateway](Gateway.md).[canReach](Gateway.md#canreach) + +#### Defined in + +[elements/Gateway.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L78) + +___ + +### getRelatedTokens + +▸ **getRelatedTokens**(`item`): `any`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`any`[] + +#### Inherited from + +[Gateway](Gateway.md).[getRelatedTokens](Gateway.md#getrelatedtokens) + +#### Defined in + +[elements/Gateway.ts:88](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L88) + +___ + +### analyzeConvergingTokens + +▸ **analyzeConvergingTokens**(`item`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `pendingTokens` | [`Token`](Token.md)[] | +| `waitingTokens` | [`Token`](Token.md)[] | + +#### Inherited from + +[Gateway](Gateway.md).[analyzeConvergingTokens](Gateway.md#analyzeconvergingtokens) + +#### Defined in + +[elements/Gateway.ts:120](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L120) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Gateway](Gateway.md).[start](Gateway.md#start) + +#### Defined in + +[elements/Gateway.ts:149](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L149) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`Item`](Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +[`Item`](Item.md)[] + +#### Overrides + +[Gateway](Gateway.md).[getOutbounds](Gateway.md#getoutbounds) + +#### Defined in + +[elements/Gateway.ts:245](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Gateway.ts#L245) + +___ + +### validate + +▸ **validate**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[validate](Gateway.md#validate) + +#### Defined in + +[elements/Node.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L44) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`any`[]\> + +#### Inherited from + +[Gateway](Gateway.md).[doEvent](Gateway.md#doevent) + +#### Defined in + +[elements/Node.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L57) + +___ + +### setInput + +▸ **setInput**(`item`, `input`): `Promise`\<`void`\> + +is Called after execution +transform data using input rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[setInput](Gateway.md#setinput) + +#### Defined in + +[elements/Node.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L85) + +___ + +### getInput + +▸ **getInput**(`item`, `input`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | +| `input` | `any` | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Gateway](Gateway.md).[getInput](Gateway.md#getinput) + +#### Defined in + +[elements/Node.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L95) + +___ + +### getOutput + +▸ **getOutput**(`item`): `Promise`\<{}\> + +transform data using output rules +todo + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<{}\> + +#### Inherited from + +[Gateway](Gateway.md).[getOutput](Gateway.md#getoutput) + +#### Defined in + +[elements/Node.ts:109](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L109) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Gateway](Gateway.md).[enter](Gateway.md#enter) + +#### Defined in + +[elements/Node.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L113) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`end`](../enums/NODE_ACTION.md#end) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Inherited from + +[Gateway](Gateway.md).[execute](Gateway.md#execute) + +#### Defined in + +[elements/Node.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L139) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[continue](Gateway.md#continue) + +#### Defined in + +[elements/Node.ts:212](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L212) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Inherited from + +[Gateway](Gateway.md).[run](Gateway.md#run) + +#### Defined in + +[elements/Node.ts:227](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L227) + +___ + +### cancelEBG + +▸ **cancelEBG**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[cancelEBG](Gateway.md#cancelebg) + +#### Defined in + +[elements/Node.ts:231](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L231) + +___ + +### cancelBoundaryEvents + +▸ **cancelBoundaryEvents**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[cancelBoundaryEvents](Gateway.md#cancelboundaryevents) + +#### Defined in + +[elements/Node.ts:239](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L239) + +___ + +### end + +▸ **end**(`item`, `cancel?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `item` | [`Item`](Item.md) | `undefined` | +| `cancel` | `Boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[end](Gateway.md#end) + +#### Defined in + +[elements/Node.ts:272](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L272) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Gateway](Gateway.md).[resume](Gateway.md#resume) + +#### Defined in + +[elements/Node.ts:307](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L307) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`Item`](Item.md) | + +#### Returns + +`void` + +#### Inherited from + +[Gateway](Gateway.md).[init](Gateway.md#init) + +#### Defined in + +[elements/Node.ts:310](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L310) + +___ + +### startBoundaryEvents + +▸ **startBoundaryEvents**(`item`, `token`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `token` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[Gateway](Gateway.md).[startBoundaryEvents](Gateway.md#startboundaryevents) + +#### Defined in + +[elements/Node.ts:334](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L334) + +___ + +### describe + +▸ **describe**(): `any`[] + +#### Returns + +`any`[] + +#### Inherited from + +[Gateway](Gateway.md).[describe](Gateway.md#describe) + +#### Defined in + +[elements/Node.ts:346](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/Node.ts#L346) diff --git a/docs/api/enums/BPMN_TYPE.md b/docs/api/enums/BPMN_TYPE.md new file mode 100644 index 00000000..069490be --- /dev/null +++ b/docs/api/enums/BPMN_TYPE.md @@ -0,0 +1,217 @@ +[bpmn-server](../API.md) / BPMN\_TYPE + +# Enumeration: BPMN\_TYPE + +## Table of contents + +### Enumeration Members + +- [UserTask](BPMN_TYPE.md#usertask) +- [ScriptTask](BPMN_TYPE.md#scripttask) +- [ServiceTask](BPMN_TYPE.md#servicetask) +- [SendTask](BPMN_TYPE.md#sendtask) +- [ReceiveTask](BPMN_TYPE.md#receivetask) +- [BusinessRuleTask](BPMN_TYPE.md#businessruletask) +- [SubProcess](BPMN_TYPE.md#subprocess) +- [ParallelGateway](BPMN_TYPE.md#parallelgateway) +- [EventBasedGateway](BPMN_TYPE.md#eventbasedgateway) +- [InclusiveGateway](BPMN_TYPE.md#inclusivegateway) +- [ExclusiveGateway](BPMN_TYPE.md#exclusivegateway) +- [BoundaryEvent](BPMN_TYPE.md#boundaryevent) +- [StartEvent](BPMN_TYPE.md#startevent) +- [IntermediateCatchEvent](BPMN_TYPE.md#intermediatecatchevent) +- [IntermediateThrowEvent](BPMN_TYPE.md#intermediatethrowevent) +- [EndEvent](BPMN_TYPE.md#endevent) +- [SequenceFlow](BPMN_TYPE.md#sequenceflow) +- [MessageFlow](BPMN_TYPE.md#messageflow) +- [CallActivity](BPMN_TYPE.md#callactivity) + +## Enumeration Members + +### UserTask + +• **UserTask** = ``"bpmn:UserTask"`` + +#### Defined in + +[interfaces/Enums.ts:3](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L3) + +___ + +### ScriptTask + +• **ScriptTask** = ``"bpmn:ScriptTask"`` + +#### Defined in + +[interfaces/Enums.ts:4](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L4) + +___ + +### ServiceTask + +• **ServiceTask** = ``"bpmn:ServiceTask"`` + +#### Defined in + +[interfaces/Enums.ts:5](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L5) + +___ + +### SendTask + +• **SendTask** = ``"bpmn:SendTask"`` + +#### Defined in + +[interfaces/Enums.ts:6](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L6) + +___ + +### ReceiveTask + +• **ReceiveTask** = ``"bpmn:ReceiveTask"`` + +#### Defined in + +[interfaces/Enums.ts:7](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L7) + +___ + +### BusinessRuleTask + +• **BusinessRuleTask** = ``"bpmn:BusinessRuleTask"`` + +#### Defined in + +[interfaces/Enums.ts:8](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L8) + +___ + +### SubProcess + +• **SubProcess** = ``"bpmn:SubProcess"`` + +#### Defined in + +[interfaces/Enums.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L9) + +___ + +### ParallelGateway + +• **ParallelGateway** = ``"bpmn:ParallelGateway"`` + +#### Defined in + +[interfaces/Enums.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L10) + +___ + +### EventBasedGateway + +• **EventBasedGateway** = ``"bpmn:EventBasedGateway"`` + +#### Defined in + +[interfaces/Enums.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L11) + +___ + +### InclusiveGateway + +• **InclusiveGateway** = ``"bpmn:InclusiveGateway"`` + +#### Defined in + +[interfaces/Enums.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L12) + +___ + +### ExclusiveGateway + +• **ExclusiveGateway** = ``"bpmn:ExclusiveGateway"`` + +#### Defined in + +[interfaces/Enums.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L13) + +___ + +### BoundaryEvent + +• **BoundaryEvent** = ``"bpmn:BoundaryEvent"`` + +#### Defined in + +[interfaces/Enums.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L14) + +___ + +### StartEvent + +• **StartEvent** = ``"bpmn:StartEvent"`` + +#### Defined in + +[interfaces/Enums.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L15) + +___ + +### IntermediateCatchEvent + +• **IntermediateCatchEvent** = ``"bpmn:IntermediateCatchEvent"`` + +#### Defined in + +[interfaces/Enums.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L16) + +___ + +### IntermediateThrowEvent + +• **IntermediateThrowEvent** = ``"bpmn:IntermediateThrowEvent"`` + +#### Defined in + +[interfaces/Enums.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L17) + +___ + +### EndEvent + +• **EndEvent** = ``"bpmn:EndEvent"`` + +#### Defined in + +[interfaces/Enums.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L18) + +___ + +### SequenceFlow + +• **SequenceFlow** = ``"bpmn:SequenceFlow"`` + +#### Defined in + +[interfaces/Enums.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L19) + +___ + +### MessageFlow + +• **MessageFlow** = ``"bpmn:MessageFlow"`` + +#### Defined in + +[interfaces/Enums.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L20) + +___ + +### CallActivity + +• **CallActivity** = ``"bpmn:CallActivity"`` + +#### Defined in + +[interfaces/Enums.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L21) diff --git a/docs/api/enums/EXECUTION_EVENT.md b/docs/api/enums/EXECUTION_EVENT.md new file mode 100644 index 00000000..98827a3c --- /dev/null +++ b/docs/api/enums/EXECUTION_EVENT.md @@ -0,0 +1,305 @@ +[bpmn-server](../API.md) / EXECUTION\_EVENT + +# Enumeration: EXECUTION\_EVENT + +## Table of contents + +### Enumeration Members + +- [node\_enter](EXECUTION_EVENT.md#node_enter) +- [node\_assign](EXECUTION_EVENT.md#node_assign) +- [node\_validate](EXECUTION_EVENT.md#node_validate) +- [node\_start](EXECUTION_EVENT.md#node_start) +- [node\_wait](EXECUTION_EVENT.md#node_wait) +- [node\_end](EXECUTION_EVENT.md#node_end) +- [node\_terminated](EXECUTION_EVENT.md#node_terminated) +- [transform\_input](EXECUTION_EVENT.md#transform_input) +- [transform\_output](EXECUTION_EVENT.md#transform_output) +- [flow\_take](EXECUTION_EVENT.md#flow_take) +- [flow\_discard](EXECUTION_EVENT.md#flow_discard) +- [process\_loaded](EXECUTION_EVENT.md#process_loaded) +- [process\_start](EXECUTION_EVENT.md#process_start) +- [process\_started](EXECUTION_EVENT.md#process_started) +- [process\_invoke](EXECUTION_EVENT.md#process_invoke) +- [process\_invoked](EXECUTION_EVENT.md#process_invoked) +- [process\_saving](EXECUTION_EVENT.md#process_saving) +- [process\_restored](EXECUTION_EVENT.md#process_restored) +- [process\_resumed](EXECUTION_EVENT.md#process_resumed) +- [process\_wait](EXECUTION_EVENT.md#process_wait) +- [process\_end](EXECUTION_EVENT.md#process_end) +- [process\_terminated](EXECUTION_EVENT.md#process_terminated) +- [token\_start](EXECUTION_EVENT.md#token_start) +- [token\_wait](EXECUTION_EVENT.md#token_wait) +- [token\_end](EXECUTION_EVENT.md#token_end) +- [token\_terminated](EXECUTION_EVENT.md#token_terminated) +- [process\_error](EXECUTION_EVENT.md#process_error) + +## Enumeration Members + +### node\_enter + +• **node\_enter** = ``"enter"`` + +#### Defined in + +[interfaces/Enums.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L38) + +___ + +### node\_assign + +• **node\_assign** = ``"assign"`` + +#### Defined in + +[interfaces/Enums.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L39) + +___ + +### node\_validate + +• **node\_validate** = ``"validate"`` + +#### Defined in + +[interfaces/Enums.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L40) + +___ + +### node\_start + +• **node\_start** = ``"start"`` + +#### Defined in + +[interfaces/Enums.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L41) + +___ + +### node\_wait + +• **node\_wait** = ``"wait"`` + +#### Defined in + +[interfaces/Enums.ts:42](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L42) + +___ + +### node\_end + +• **node\_end** = ``"end"`` + +#### Defined in + +[interfaces/Enums.ts:43](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L43) + +___ + +### node\_terminated + +• **node\_terminated** = ``"terminated"`` + +#### Defined in + +[interfaces/Enums.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L44) + +___ + +### transform\_input + +• **transform\_input** = ``"transformInput"`` + +#### Defined in + +[interfaces/Enums.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L45) + +___ + +### transform\_output + +• **transform\_output** = ``"transformOutput"`` + +#### Defined in + +[interfaces/Enums.ts:46](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L46) + +___ + +### flow\_take + +• **flow\_take** = ``"take"`` + +#### Defined in + +[interfaces/Enums.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L47) + +___ + +### flow\_discard + +• **flow\_discard** = ``"discard"`` + +#### Defined in + +[interfaces/Enums.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L48) + +___ + +### process\_loaded + +• **process\_loaded** = ``"process.loaded"`` + +#### Defined in + +[interfaces/Enums.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L49) + +___ + +### process\_start + +• **process\_start** = ``"process.start"`` + +#### Defined in + +[interfaces/Enums.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L50) + +___ + +### process\_started + +• **process\_started** = ``"process.started"`` + +#### Defined in + +[interfaces/Enums.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L51) + +___ + +### process\_invoke + +• **process\_invoke** = ``"process.invoke"`` + +#### Defined in + +[interfaces/Enums.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L52) + +___ + +### process\_invoked + +• **process\_invoked** = ``"process.invoked"`` + +#### Defined in + +[interfaces/Enums.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L53) + +___ + +### process\_saving + +• **process\_saving** = ``"process.saving"`` + +#### Defined in + +[interfaces/Enums.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L54) + +___ + +### process\_restored + +• **process\_restored** = ``"process.restored"`` + +#### Defined in + +[interfaces/Enums.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L55) + +___ + +### process\_resumed + +• **process\_resumed** = ``"process_resumed"`` + +#### Defined in + +[interfaces/Enums.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L56) + +___ + +### process\_wait + +• **process\_wait** = ``"process.wait"`` + +#### Defined in + +[interfaces/Enums.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L57) + +___ + +### process\_end + +• **process\_end** = ``"process.end"`` + +#### Defined in + +[interfaces/Enums.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L58) + +___ + +### process\_terminated + +• **process\_terminated** = ``"process.terminated"`` + +#### Defined in + +[interfaces/Enums.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L59) + +___ + +### token\_start + +• **token\_start** = ``"token.start"`` + +#### Defined in + +[interfaces/Enums.ts:60](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L60) + +___ + +### token\_wait + +• **token\_wait** = ``"token.wait"`` + +#### Defined in + +[interfaces/Enums.ts:61](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L61) + +___ + +### token\_end + +• **token\_end** = ``"token.end"`` + +#### Defined in + +[interfaces/Enums.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L62) + +___ + +### token\_terminated + +• **token\_terminated** = ``"token.terminated"`` + +#### Defined in + +[interfaces/Enums.ts:63](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L63) + +___ + +### process\_error + +• **process\_error** = ``"process.error"`` + +#### Defined in + +[interfaces/Enums.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L64) diff --git a/docs/api/enums/EXECUTION_STATUS.md b/docs/api/enums/EXECUTION_STATUS.md new file mode 100644 index 00000000..90e95d41 --- /dev/null +++ b/docs/api/enums/EXECUTION_STATUS.md @@ -0,0 +1,52 @@ +[bpmn-server](../API.md) / EXECUTION\_STATUS + +# Enumeration: EXECUTION\_STATUS + +## Table of contents + +### Enumeration Members + +- [running](EXECUTION_STATUS.md#running) +- [wait](EXECUTION_STATUS.md#wait) +- [end](EXECUTION_STATUS.md#end) +- [terminated](EXECUTION_STATUS.md#terminated) + +## Enumeration Members + +### running + +• **running** = ``"running"`` + +#### Defined in + +[interfaces/Enums.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L85) + +___ + +### wait + +• **wait** = ``"wait"`` + +#### Defined in + +[interfaces/Enums.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L85) + +___ + +### end + +• **end** = ``"end"`` + +#### Defined in + +[interfaces/Enums.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L85) + +___ + +### terminated + +• **terminated** = ``"terminated"`` + +#### Defined in + +[interfaces/Enums.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L85) diff --git a/docs/api/enums/FLOW_ACTION.md b/docs/api/enums/FLOW_ACTION.md new file mode 100644 index 00000000..90dc70f1 --- /dev/null +++ b/docs/api/enums/FLOW_ACTION.md @@ -0,0 +1,30 @@ +[bpmn-server](../API.md) / FLOW\_ACTION + +# Enumeration: FLOW\_ACTION + +## Table of contents + +### Enumeration Members + +- [take](FLOW_ACTION.md#take) +- [discard](FLOW_ACTION.md#discard) + +## Enumeration Members + +### take + +• **take** = ``"take"`` + +#### Defined in + +[interfaces/Enums.ts:93](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L93) + +___ + +### discard + +• **discard** = ``"discard"`` + +#### Defined in + +[interfaces/Enums.ts:93](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L93) diff --git a/docs/api/enums/ITEM_STATUS.md b/docs/api/enums/ITEM_STATUS.md new file mode 100644 index 00000000..caf8c6fc --- /dev/null +++ b/docs/api/enums/ITEM_STATUS.md @@ -0,0 +1,85 @@ +[bpmn-server](../API.md) / ITEM\_STATUS + +# Enumeration: ITEM\_STATUS + +## Table of contents + +### Enumeration Members + +- [enter](ITEM_STATUS.md#enter) +- [start](ITEM_STATUS.md#start) +- [wait](ITEM_STATUS.md#wait) +- [end](ITEM_STATUS.md#end) +- [terminated](ITEM_STATUS.md#terminated) +- [cancelled](ITEM_STATUS.md#cancelled) +- [discard](ITEM_STATUS.md#discard) + +## Enumeration Members + +### enter + +• **enter** = ``"enter"`` + +#### Defined in + +[interfaces/Enums.ts:73](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L73) + +___ + +### start + +• **start** = ``"start"`` + +#### Defined in + +[interfaces/Enums.ts:74](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L74) + +___ + +### wait + +• **wait** = ``"wait"`` + +#### Defined in + +[interfaces/Enums.ts:75](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L75) + +___ + +### end + +• **end** = ``"end"`` + +#### Defined in + +[interfaces/Enums.ts:76](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L76) + +___ + +### terminated + +• **terminated** = ``"terminated"`` + +#### Defined in + +[interfaces/Enums.ts:77](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L77) + +___ + +### cancelled + +• **cancelled** = ``"cancelled"`` + +#### Defined in + +[interfaces/Enums.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L78) + +___ + +### discard + +• **discard** = ``"discard"`` + +#### Defined in + +[interfaces/Enums.ts:79](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L79) diff --git a/docs/api/enums/NODE_ACTION.md b/docs/api/enums/NODE_ACTION.md new file mode 100644 index 00000000..61b9c86a --- /dev/null +++ b/docs/api/enums/NODE_ACTION.md @@ -0,0 +1,85 @@ +[bpmn-server](../API.md) / NODE\_ACTION + +# Enumeration: NODE\_ACTION + +## Table of contents + +### Enumeration Members + +- [continue](NODE_ACTION.md#continue) +- [wait](NODE_ACTION.md#wait) +- [end](NODE_ACTION.md#end) +- [cancel](NODE_ACTION.md#cancel) +- [stop](NODE_ACTION.md#stop) +- [error](NODE_ACTION.md#error) +- [abort](NODE_ACTION.md#abort) + +## Enumeration Members + +### continue + +• **continue** = ``1`` + +#### Defined in + +[interfaces/Enums.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L70) + +___ + +### wait + +• **wait** = ``2`` + +#### Defined in + +[interfaces/Enums.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L70) + +___ + +### end + +• **end** = ``3`` + +#### Defined in + +[interfaces/Enums.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L70) + +___ + +### cancel + +• **cancel** = ``4`` + +#### Defined in + +[interfaces/Enums.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L70) + +___ + +### stop + +• **stop** = ``5`` + +#### Defined in + +[interfaces/Enums.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L70) + +___ + +### error + +• **error** = ``6`` + +#### Defined in + +[interfaces/Enums.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L70) + +___ + +### abort + +• **abort** = ``7`` + +#### Defined in + +[interfaces/Enums.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L70) diff --git a/docs/api/enums/NODE_SUBTYPE.md b/docs/api/enums/NODE_SUBTYPE.md new file mode 100644 index 00000000..f571059a --- /dev/null +++ b/docs/api/enums/NODE_SUBTYPE.md @@ -0,0 +1,85 @@ +[bpmn-server](../API.md) / NODE\_SUBTYPE + +# Enumeration: NODE\_SUBTYPE + +## Table of contents + +### Enumeration Members + +- [timer](NODE_SUBTYPE.md#timer) +- [message](NODE_SUBTYPE.md#message) +- [signal](NODE_SUBTYPE.md#signal) +- [error](NODE_SUBTYPE.md#error) +- [escalation](NODE_SUBTYPE.md#escalation) +- [cancel](NODE_SUBTYPE.md#cancel) +- [compensate](NODE_SUBTYPE.md#compensate) + +## Enumeration Members + +### timer + +• **timer** = ``"timer"`` + +#### Defined in + +[interfaces/Enums.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L25) + +___ + +### message + +• **message** = ``"message"`` + +#### Defined in + +[interfaces/Enums.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L26) + +___ + +### signal + +• **signal** = ``"signal"`` + +#### Defined in + +[interfaces/Enums.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L27) + +___ + +### error + +• **error** = ``"error"`` + +#### Defined in + +[interfaces/Enums.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L28) + +___ + +### escalation + +• **escalation** = ``"escalation"`` + +#### Defined in + +[interfaces/Enums.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L29) + +___ + +### cancel + +• **cancel** = ``"cancel"`` + +#### Defined in + +[interfaces/Enums.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L30) + +___ + +### compensate + +• **compensate** = ``"compensate"`` + +#### Defined in + +[interfaces/Enums.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L32) diff --git a/docs/api/enums/TOKEN_STATUS.md b/docs/api/enums/TOKEN_STATUS.md new file mode 100644 index 00000000..b6db0441 --- /dev/null +++ b/docs/api/enums/TOKEN_STATUS.md @@ -0,0 +1,52 @@ +[bpmn-server](../API.md) / TOKEN\_STATUS + +# Enumeration: TOKEN\_STATUS + +## Table of contents + +### Enumeration Members + +- [running](TOKEN_STATUS.md#running) +- [wait](TOKEN_STATUS.md#wait) +- [end](TOKEN_STATUS.md#end) +- [terminated](TOKEN_STATUS.md#terminated) + +## Enumeration Members + +### running + +• **running** = ``"running"`` + +#### Defined in + +[interfaces/Enums.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L87) + +___ + +### wait + +• **wait** = ``"wait"`` + +#### Defined in + +[interfaces/Enums.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L87) + +___ + +### end + +• **end** = ``"end"`` + +#### Defined in + +[interfaces/Enums.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L87) + +___ + +### terminated + +• **terminated** = ``"terminated"`` + +#### Defined in + +[interfaces/Enums.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/Enums.ts#L87) diff --git a/docs/api/enums/TOKEN_TYPE.md b/docs/api/enums/TOKEN_TYPE.md new file mode 100644 index 00000000..965cd5d7 --- /dev/null +++ b/docs/api/enums/TOKEN_TYPE.md @@ -0,0 +1,74 @@ +[bpmn-server](../API.md) / TOKEN\_TYPE + +# Enumeration: TOKEN\_TYPE + +## Table of contents + +### Enumeration Members + +- [Primary](TOKEN_TYPE.md#primary) +- [SubProcess](TOKEN_TYPE.md#subprocess) +- [Instance](TOKEN_TYPE.md#instance) +- [Diverge](TOKEN_TYPE.md#diverge) +- [EventSubProcess](TOKEN_TYPE.md#eventsubprocess) +- [BoundaryEvent](TOKEN_TYPE.md#boundaryevent) + +## Enumeration Members + +### Primary + +• **Primary** = ``"Primary"`` + +#### Defined in + +[engine/Token.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L53) + +___ + +### SubProcess + +• **SubProcess** = ``"SubProcess"`` + +#### Defined in + +[engine/Token.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L53) + +___ + +### Instance + +• **Instance** = ``"Instance"`` + +#### Defined in + +[engine/Token.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L53) + +___ + +### Diverge + +• **Diverge** = ``"Diverge"`` + +#### Defined in + +[engine/Token.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L53) + +___ + +### EventSubProcess + +• **EventSubProcess** = ``"EventSubProces"`` + +#### Defined in + +[engine/Token.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L54) + +___ + +### BoundaryEvent + +• **BoundaryEvent** = ``"BoundaryEvent"`` + +#### Defined in + +[engine/Token.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/engine/Token.ts#L54) diff --git a/docs/api/enums/USER_ROLE.md b/docs/api/enums/USER_ROLE.md new file mode 100644 index 00000000..b33ae242 --- /dev/null +++ b/docs/api/enums/USER_ROLE.md @@ -0,0 +1,41 @@ +[bpmn-server](../API.md) / USER\_ROLE + +# Enumeration: USER\_ROLE + +## Table of contents + +### Enumeration Members + +- [SYSTEM](USER_ROLE.md#system) +- [ADMIN](USER_ROLE.md#admin) +- [DESIGNER](USER_ROLE.md#designer) + +## Enumeration Members + +### SYSTEM + +• **SYSTEM** = ``"SYSTEM"`` + +#### Defined in + +[API/SecureUser.ts:5](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L5) + +___ + +### ADMIN + +• **ADMIN** = ``"ADMIN"`` + +#### Defined in + +[API/SecureUser.ts:6](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L6) + +___ + +### DESIGNER + +• **DESIGNER** = ``"DESIGNER"`` + +#### Defined in + +[API/SecureUser.ts:7](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L7) diff --git a/docs/api/interfaces/IAPIData.md b/docs/api/interfaces/IAPIData.md new file mode 100644 index 00000000..f1ff1531 --- /dev/null +++ b/docs/api/interfaces/IAPIData.md @@ -0,0 +1,133 @@ +[bpmn-server](../API.md) / IAPIData + +# Interface: IAPIData + +## Table of contents + +### Methods + +- [getPendingUserTasks](IAPIData.md#getpendingusertasks) +- [findItems](IAPIData.md#finditems) +- [findItem](IAPIData.md#finditem) +- [findInstances](IAPIData.md#findinstances) +- [deleteInstances](IAPIData.md#deleteinstances) + +## Methods + +### getPendingUserTasks + +▸ **getPendingUserTasks**(`query`, `user`): `Promise`\<[`IItemData`](IItemData.md)[]\> + +returns list of `User Tasks` that the user has access to + +to get assigned tasks for a user + +```ts +api.data.getPendingUserTasks({"item.assignee":user.userName}); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`Promise`\<[`IItemData`](IItemData.md)[]\> + +#### Defined in + +[API/API.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L85) + +___ + +### findItems + +▸ **findItems**(`query`, `user`): `Promise`\<[`IItemData`](IItemData.md)[]\> + +returns list of `item`s + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`Promise`\<[`IItemData`](IItemData.md)[]\> + +#### Defined in + +[API/API.ts:89](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L89) + +___ + +### findItem + +▸ **findItem**(`query`, `user`): `Promise`\<[`IItemData`](IItemData.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`Promise`\<[`IItemData`](IItemData.md)\> + +#### Defined in + +[API/API.ts:90](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L90) + +___ + +### findInstances + +▸ **findInstances**(`query`, `user`, `options`): `Promise`\<[`IInstanceData`](IInstanceData.md)[]\> + +returns list of `instance`s + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | +| `options` | `any` | + +#### Returns + +`Promise`\<[`IInstanceData`](IInstanceData.md)[]\> + +#### Defined in + +[API/API.ts:94](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L94) + +___ + +### deleteInstances + +▸ **deleteInstances**(`query`, `user`): `any` + +deletes the `instance`s + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`any` + +#### Defined in + +[API/API.ts:98](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L98) diff --git a/docs/api/interfaces/IAPIEngine.md b/docs/api/interfaces/IAPIEngine.md new file mode 100644 index 00000000..f3458e29 --- /dev/null +++ b/docs/api/interfaces/IAPIEngine.md @@ -0,0 +1,185 @@ +[bpmn-server](../API.md) / IAPIEngine + +# Interface: IAPIEngine + +common parameters: + +- query: MongoDB query to locate the target instance or item + +- data: input Data + +- user: an instance of ISecureUser object + +- options: various options, this is an open object that is based through the run-time + +Returns IExecution +containing the instance and the results of the call + +## Implemented by + +- [`APIEngine`](../classes/APIEngine.md) + +## Table of contents + +### Methods + +- [start](IAPIEngine.md#start) +- [invoke](IAPIEngine.md#invoke) +- [assign](IAPIEngine.md#assign) +- [throwMessage](IAPIEngine.md#throwmessage) +- [throwSignal](IAPIEngine.md#throwsignal) +- [startEvent](IAPIEngine.md#startevent) + +## Methods + +### start + +▸ **start**(`modelName`, `data`, `user`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +start a new Instance of specified model + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `modelName` | `any` | +| `data` | `Object` | +| `user` | [`ISecureUser`](ISecureUser.md) | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[API/API.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L50) + +___ + +### invoke + +▸ **invoke**(`query`, `data`, `user`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +continue with the execution of a particular item that is in a wait state, typically a user task + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `data` | `Object` | +| `user` | [`ISecureUser`](ISecureUser.md) | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[API/API.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L54) + +___ + +### assign + +▸ **assign**(`query`, `data`, `assignment`, `user`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +provide assignment data to a user task + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `data` | `any` | +| `assignment` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[API/API.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L58) + +___ + +### throwMessage + +▸ **throwMessage**(`messageId`, `data`, `messageMatchingKey`, `user`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +throw a message with an id, system will identify receiving item + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `messageId` | `any` | +| `data` | `any` | +| `messageMatchingKey` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[API/API.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L62) + +___ + +### throwSignal + +▸ **throwSignal**(`signalId`, `data`, `messageMatchingKey`, `user`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +throw a signal with an id, system will identify receiving item(s) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signalId` | `any` | +| `data` | `any` | +| `messageMatchingKey` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[API/API.ts:66](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L66) + +___ + +### startEvent + +▸ **startEvent**(`query`, `elementId`, `data`, `user`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +start a second event node (in a subprocess) for a running instance + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `elementId` | `any` | +| `data` | `Object` | +| `user` | [`ISecureUser`](ISecureUser.md) | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[API/API.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L70) diff --git a/docs/api/interfaces/IAPIModel.md b/docs/api/interfaces/IAPIModel.md new file mode 100644 index 00000000..8c4a31be --- /dev/null +++ b/docs/api/interfaces/IAPIModel.md @@ -0,0 +1,233 @@ +[bpmn-server](../API.md) / IAPIModel + +# Interface: IAPIModel + +common parameters: + +- query: MongoDB query to locate the target instance or item + +- user: an instance of ISecureUser object + +## Table of contents + +### Methods + +- [save](IAPIModel.md#save) +- [list](IAPIModel.md#list) +- [findEvents](IAPIModel.md#findevents) +- [findStartEvents](IAPIModel.md#findstartevents) +- [delete](IAPIModel.md#delete) +- [rename](IAPIModel.md#rename) +- [getSource](IAPIModel.md#getsource) +- [load](IAPIModel.md#load) +- [export](IAPIModel.md#export) + +## Methods + +### save + +▸ **save**(`name`, `source`, `svg`, `user`): `any` + +save a model to the modelStore + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `source` | `any` | +| `svg` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`any` + +#### Defined in + +[API/API.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L113) + +___ + +### list + +▸ **list**(`user`): `Promise`\<`string`[]\> + +list all models authorized to the user + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`Promise`\<`string`[]\> + +#### Defined in + +[API/API.ts:117](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L117) + +___ + +### findEvents + +▸ **findEvents**(`query`, `user`): `any` + +returns Model Events (like timers) for authorized to the user and based on specifid query + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`any` + +#### Defined in + +[API/API.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L122) + +___ + +### findStartEvents + +▸ **findStartEvents**(`query`, `user`): `any` + +returns Model Start Events for authorized to the user and based on specifid query + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`any` + +#### Defined in + +[API/API.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L127) + +___ + +### delete + +▸ **delete**(`name`, `user`): `any` + +delete the specified model + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`any` + +#### Defined in + +[API/API.ts:132](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L132) + +___ + +### rename + +▸ **rename**(`name`, `newName`, `user`): `any` + +delete the specified model + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `newName` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`any` + +#### Defined in + +[API/API.ts:136](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L136) + +___ + +### getSource + +▸ **getSource**(`name`, `user`): `any` + +returns the bpmn (xml) for the model + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`any` + +#### Defined in + +[API/API.ts:140](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L140) + +___ + +### load + +▸ **load**(`name`, `user`): `any` + +load a model + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`any` + +#### Defined in + +[API/API.ts:144](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L144) + +___ + +### export + +▸ **export**(`query`, `folder`, `user`): `any` + +export the specified models based on a query to a folder + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `folder` | `any` | +| `user` | [`ISecureUser`](ISecureUser.md) | + +#### Returns + +`any` + +#### Defined in + +[API/API.ts:148](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/API.ts#L148) diff --git a/docs/api/interfaces/IAppDelegate.md b/docs/api/interfaces/IAppDelegate.md new file mode 100644 index 00000000..40e84fdd --- /dev/null +++ b/docs/api/interfaces/IAppDelegate.md @@ -0,0 +1,238 @@ +[bpmn-server](../API.md) / IAppDelegate + +# Interface: IAppDelegate + +Application Delegate Object to respond to various events and services: + + 1. receive all events from workflow + 2. receive service calls + 3. receive message and signal calls + 4. execute scripts + +## Implemented by + +- [`DefaultAppDelegate`](../classes/DefaultAppDelegate.md) + +## Table of contents + +### Properties + +- [moddleOptions](IAppDelegate.md#moddleoptions) + +### Methods + +- [getServicesProvider](IAppDelegate.md#getservicesprovider) +- [sendEmail](IAppDelegate.md#sendemail) +- [executionStarted](IAppDelegate.md#executionstarted) +- [startUp](IAppDelegate.md#startup) +- [messageThrown](IAppDelegate.md#messagethrown) +- [signalThrown](IAppDelegate.md#signalthrown) +- [issueMessage](IAppDelegate.md#issuemessage) +- [issueSignal](IAppDelegate.md#issuesignal) +- [serviceCalled](IAppDelegate.md#servicecalled) + +## Properties + +### moddleOptions + +• **moddleOptions**: `any` + +#### Defined in + +[interfaces/common.ts:73](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L73) + +## Methods + +### getServicesProvider + +▸ **getServicesProvider**(`IExecution`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `IExecution` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/common.ts:74](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L74) + +___ + +### sendEmail + +▸ **sendEmail**(`to`, `msg`, `body`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `to` | `any` | +| `msg` | `any` | +| `body` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/common.ts:75](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L75) + +___ + +### executionStarted + +▸ **executionStarted**(`execution`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/common.ts:76](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L76) + +___ + +### startUp + +▸ **startUp**(`options`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/common.ts:77](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L77) + +___ + +### messageThrown + +▸ **messageThrown**(`signalId`, `data`, `messageMatchingKey`, `item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signalId` | `any` | +| `data` | `any` | +| `messageMatchingKey` | `any` | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`any` + +#### Defined in + +[interfaces/common.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L78) + +___ + +### signalThrown + +▸ **signalThrown**(`signalId`, `data`, `messageMatchingKey`, `item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signalId` | `any` | +| `data` | `any` | +| `messageMatchingKey` | `any` | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`any` + +#### Defined in + +[interfaces/common.ts:79](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L79) + +___ + +### issueMessage + +▸ **issueMessage**(`messageId`, `data`): `any` + +is called when an event throws a message that can not be answered by another process + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `messageId` | `any` | +| `data` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/common.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L87) + +___ + +### issueSignal + +▸ **issueSignal**(`messageId`, `data`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `messageId` | `any` | +| `data` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/common.ts:88](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L88) + +___ + +### serviceCalled + +▸ **serviceCalled**(`serviceName`, `data`, `item`): `any` + +is called only if the serviceTask has no implementation; otherwise the specified implementation will be called. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `serviceName` | `any` | +| `data` | `any` | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`any` + +#### Defined in + +[interfaces/common.ts:94](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L94) diff --git a/docs/api/interfaces/IBPMNServer.md b/docs/api/interfaces/IBPMNServer.md new file mode 100644 index 00000000..52ebd909 --- /dev/null +++ b/docs/api/interfaces/IBPMNServer.md @@ -0,0 +1,122 @@ +[bpmn-server](../API.md) / IBPMNServer + +# Interface: IBPMNServer + +## Implemented by + +- [`BPMNServer`](../classes/BPMNServer.md) + +## Table of contents + +### Properties + +- [engine](IBPMNServer.md#engine) +- [listener](IBPMNServer.md#listener) +- [configuration](IBPMNServer.md#configuration) +- [logger](IBPMNServer.md#logger) +- [definitions](IBPMNServer.md#definitions) +- [appDelegate](IBPMNServer.md#appdelegate) +- [dataStore](IBPMNServer.md#datastore) +- [cache](IBPMNServer.md#cache) +- [cron](IBPMNServer.md#cron) +- [userService](IBPMNServer.md#userservice) + +## Properties + +### engine + +• **engine**: [`IEngine`](IEngine.md) + +#### Defined in + +[interfaces/server.ts:8](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L8) + +___ + +### listener + +• **listener**: `EventEmitter` + +#### Defined in + +[interfaces/server.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L9) + +___ + +### configuration + +• **configuration**: [`IConfiguration`](IConfiguration.md) + +#### Defined in + +[interfaces/server.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L10) + +___ + +### logger + +• **logger**: [`ILogger`](ILogger.md) + +#### Defined in + +[interfaces/server.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L11) + +___ + +### definitions + +• **definitions**: [`IModelsDatastore`](IModelsDatastore.md) + +#### Defined in + +[interfaces/server.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L12) + +___ + +### appDelegate + +• **appDelegate**: [`IAppDelegate`](IAppDelegate.md) + +#### Defined in + +[interfaces/server.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L13) + +___ + +### dataStore + +• **dataStore**: [`IDataStore`](IDataStore.md) + +#### Defined in + +[interfaces/server.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L14) + +___ + +### cache + +• **cache**: [`ICacheManager`](ICacheManager.md) + +#### Defined in + +[interfaces/server.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L15) + +___ + +### cron + +• **cron**: [`ICron`](ICron.md) + +#### Defined in + +[interfaces/server.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L16) + +___ + +### userService + +• **userService**: [`IUserService`](IUserService.md) + +#### Defined in + +[interfaces/server.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L17) diff --git a/docs/api/interfaces/IBehaviour.md b/docs/api/interfaces/IBehaviour.md new file mode 100644 index 00000000..c8877b39 --- /dev/null +++ b/docs/api/interfaces/IBehaviour.md @@ -0,0 +1,224 @@ +[bpmn-server](../API.md) / IBehaviour + +# Interface: IBehaviour + +Behaviour + ioSpecification + timer + message + signal + + each behaviour is a class + it scans def and insert itself to perform actions as required + +## Implemented by + +- [`Behaviour`](../classes/Behaviour.md) + +## Table of contents + +### Properties + +- [node](IBehaviour.md#node) +- [definition](IBehaviour.md#definition) + +### Methods + +- [start](IBehaviour.md#start) +- [run](IBehaviour.md#run) +- [end](IBehaviour.md#end) +- [restored](IBehaviour.md#restored) +- [resume](IBehaviour.md#resume) +- [getNodeAttributes](IBehaviour.md#getnodeattributes) +- [getItemAttributes](IBehaviour.md#getitemattributes) +- [describe](IBehaviour.md#describe) +- [init](IBehaviour.md#init) + +## Properties + +### node + +• **node**: [`Node`](../classes/Node.md) + +#### Defined in + +[elements/behaviours/Behaviour.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L24) + +___ + +### definition + +• **definition**: `any` + +#### Defined in + +[elements/behaviours/Behaviour.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L25) + +## Methods + +### start + +▸ **start**(`item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Behaviour.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L26) + +___ + +### run + +▸ **run**(`item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Behaviour.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L27) + +___ + +### end + +▸ **end**(`item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Behaviour.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L28) + +___ + +### restored + +▸ **restored**(`item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Behaviour.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L29) + +___ + +### resume + +▸ **resume**(`item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Behaviour.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L30) + +___ + +### getNodeAttributes + +▸ **getNodeAttributes**(`attributes`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attributes` | `any`[] | + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Behaviour.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L31) + +___ + +### getItemAttributes + +▸ **getItemAttributes**(`item`, `attributes`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | +| `attributes` | `any`[] | + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Behaviour.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L32) + +___ + +### describe + +▸ **describe**(): `string`[] + +#### Returns + +`string`[] + +#### Defined in + +[elements/behaviours/Behaviour.ts:33](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L33) + +___ + +### init + +▸ **init**(): `any` + +#### Returns + +`any` + +#### Defined in + +[elements/behaviours/Behaviour.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/Behaviour.ts#L34) diff --git a/docs/api/interfaces/IBpmnModelData.md b/docs/api/interfaces/IBpmnModelData.md new file mode 100644 index 00000000..bfa0f704 --- /dev/null +++ b/docs/api/interfaces/IBpmnModelData.md @@ -0,0 +1,78 @@ +[bpmn-server](../API.md) / IBpmnModelData + +# Interface: IBpmnModelData + +## Implemented by + +- [`BpmnModelData`](../classes/BpmnModelData.md) + +## Table of contents + +### Properties + +- [name](IBpmnModelData.md#name) +- [source](IBpmnModelData.md#source) +- [svg](IBpmnModelData.md#svg) +- [processes](IBpmnModelData.md#processes) +- [events](IBpmnModelData.md#events) +- [saved](IBpmnModelData.md#saved) + +## Properties + +### name + +• **name**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:93](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L93) + +___ + +### source + +• **source**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:94](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L94) + +___ + +### svg + +• **svg**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L95) + +___ + +### processes + +• **processes**: [`IProcessData`](IProcessData.md)[] + +#### Defined in + +[interfaces/DataObjects.ts:96](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L96) + +___ + +### events + +• **events**: [`IEventData`](IEventData.md)[] + +#### Defined in + +[interfaces/DataObjects.ts:97](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L97) + +___ + +### saved + +• **saved**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:98](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L98) diff --git a/docs/api/interfaces/ICacheManager.md b/docs/api/interfaces/ICacheManager.md new file mode 100644 index 00000000..b866c214 --- /dev/null +++ b/docs/api/interfaces/ICacheManager.md @@ -0,0 +1,85 @@ +[bpmn-server](../API.md) / ICacheManager + +# Interface: ICacheManager + +## Implemented by + +- [`CacheManager`](../classes/CacheManager.md) +- [`NoCacheManager`](../classes/NoCacheManager.md) + +## Table of contents + +### Methods + +- [list](ICacheManager.md#list) +- [add](ICacheManager.md#add) +- [remove](ICacheManager.md#remove) +- [shutdown](ICacheManager.md#shutdown) + +## Methods + +### list + +▸ **list**(): `any` + +#### Returns + +`any` + +#### Defined in + +[interfaces/server.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L127) + +___ + +### add + +▸ **add**(`execution`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `execution` | [`IExecution`](IExecution.md) | + +#### Returns + +`any` + +#### Defined in + +[interfaces/server.ts:128](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L128) + +___ + +### remove + +▸ **remove**(`instanceId`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/server.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L129) + +___ + +### shutdown + +▸ **shutdown**(): `any` + +#### Returns + +`any` + +#### Defined in + +[interfaces/server.ts:130](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L130) diff --git a/docs/api/interfaces/IConfiguration.md b/docs/api/interfaces/IConfiguration.md new file mode 100644 index 00000000..65ad8fa9 --- /dev/null +++ b/docs/api/interfaces/IConfiguration.md @@ -0,0 +1,202 @@ +[bpmn-server](../API.md) / IConfiguration + +# Interface: IConfiguration + +## Implemented by + +- [`Configuration`](../classes/Configuration.md) + +## Table of contents + +### Properties + +- [definitionsPath](IConfiguration.md#definitionspath) +- [templatesPath](IConfiguration.md#templatespath) +- [timers](IConfiguration.md#timers) +- [database](IConfiguration.md#database) +- [apiKey](IConfiguration.md#apikey) +- [logger](IConfiguration.md#logger) + +### Methods + +- [definitions](IConfiguration.md#definitions) +- [appDelegate](IConfiguration.md#appdelegate) +- [dataStore](IConfiguration.md#datastore) +- [cacheManager](IConfiguration.md#cachemanager) +- [userService](IConfiguration.md#userservice) + +## Properties + +### definitionsPath + +• **definitionsPath**: `string` + +#### Defined in + +[interfaces/common.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L9) + +___ + +### templatesPath + +• **templatesPath**: `string` + +#### Defined in + +[interfaces/common.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L10) + +___ + +### timers + +• **timers**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `forceTimersDelay` | `number` | +| `precision` | `number` | + +#### Defined in + +[interfaces/common.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L11) + +___ + +### database + +• **database**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `MongoDB` | \{ `db_url`: `string` ; `db`: `string` } | +| `MongoDB.db_url` | `string` | +| `MongoDB.db` | `string` | +| `loopbackRepositories?` | `any` | + +#### Defined in + +[interfaces/common.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L15) + +___ + +### apiKey + +• **apiKey**: `string` + +#### Defined in + +[interfaces/common.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L23) + +___ + +### logger + +• **logger**: [`ILogger`](ILogger.md) + +#### Defined in + +[interfaces/common.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L24) + +## Methods + +### definitions + +▸ **definitions**(`server`): [`IModelsDatastore`](IModelsDatastore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`IModelsDatastore`](IModelsDatastore.md) + +#### Defined in + +[interfaces/common.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L25) + +___ + +### appDelegate + +▸ **appDelegate**(`server`): [`IAppDelegate`](IAppDelegate.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`IAppDelegate`](IAppDelegate.md) + +#### Defined in + +[interfaces/common.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L26) + +___ + +### dataStore + +▸ **dataStore**(`server`): [`IDataStore`](IDataStore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`IDataStore`](IDataStore.md) + +#### Defined in + +[interfaces/common.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L27) + +___ + +### cacheManager + +▸ **cacheManager**(`server`): [`ICacheManager`](ICacheManager.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`ICacheManager`](ICacheManager.md) + +#### Defined in + +[interfaces/common.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L28) + +___ + +### userService + +▸ **userService**(`server`): [`IUserService`](IUserService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `any` | + +#### Returns + +[`IUserService`](IUserService.md) + +#### Defined in + +[interfaces/common.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L29) diff --git a/docs/api/interfaces/ICron.md b/docs/api/interfaces/ICron.md new file mode 100644 index 00000000..221797d9 --- /dev/null +++ b/docs/api/interfaces/ICron.md @@ -0,0 +1,63 @@ +[bpmn-server](../API.md) / ICron + +# Interface: ICron + +## Implemented by + +- [`Cron`](../classes/Cron.md) + +## Table of contents + +### Methods + +- [checkTimers](ICron.md#checktimers) +- [start](ICron.md#start) +- [startTimers](ICron.md#starttimers) + +## Methods + +### checkTimers + +▸ **checkTimers**(`duration`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `duration` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/server.ts:119](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L119) + +___ + +### start + +▸ **start**(): `any` + +#### Returns + +`any` + +#### Defined in + +[interfaces/server.ts:120](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L120) + +___ + +### startTimers + +▸ **startTimers**(): `any` + +#### Returns + +`any` + +#### Defined in + +[interfaces/server.ts:121](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L121) diff --git a/docs/api/interfaces/IDataStore.md b/docs/api/interfaces/IDataStore.md new file mode 100644 index 00000000..345a82cd --- /dev/null +++ b/docs/api/interfaces/IDataStore.md @@ -0,0 +1,225 @@ +[bpmn-server](../API.md) / IDataStore + +# Interface: IDataStore + +## Implemented by + +- [`DataStore`](../classes/DataStore.md) + +## Table of contents + +### Properties + +- [dbConfiguration](IDataStore.md#dbconfiguration) +- [db](IDataStore.md#db) +- [logger](IDataStore.md#logger) +- [locker](IDataStore.md#locker) + +### Methods + +- [save](IDataStore.md#save) +- [loadInstance](IDataStore.md#loadinstance) +- [findItem](IDataStore.md#finditem) +- [findInstance](IDataStore.md#findinstance) +- [findInstances](IDataStore.md#findinstances) +- [findItems](IDataStore.md#finditems) +- [deleteInstances](IDataStore.md#deleteinstances) +- [install](IDataStore.md#install) + +## Properties + +### dbConfiguration + +• **dbConfiguration**: `any` + +#### Defined in + +[interfaces/datastore.ts:7](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L7) + +___ + +### db + +• **db**: `any` + +#### Defined in + +[interfaces/datastore.ts:8](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L8) + +___ + +### logger + +• **logger**: `any` + +#### Defined in + +[interfaces/datastore.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L9) + +___ + +### locker + +• **locker**: `any` + +#### Defined in + +[interfaces/datastore.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L10) + +## Methods + +### save + +▸ **save**(`instance`, `options`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `any` | +| `options` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/datastore.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L11) + +___ + +### loadInstance + +▸ **loadInstance**(`instanceId`, `options`): `Promise`\<\{ `instance`: `any` ; `items`: `any`[] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | +| `options` | `any` | + +#### Returns + +`Promise`\<\{ `instance`: `any` ; `items`: `any`[] }\> + +#### Defined in + +[interfaces/datastore.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L12) + +___ + +### findItem + +▸ **findItem**(`query`): `Promise`\<[`IItemData`](IItemData.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`Promise`\<[`IItemData`](IItemData.md)\> + +#### Defined in + +[interfaces/datastore.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L16) + +___ + +### findInstance + +▸ **findInstance**(`query`, `options`): `Promise`\<[`IInstanceData`](IInstanceData.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `options` | `any` | + +#### Returns + +`Promise`\<[`IInstanceData`](IInstanceData.md)\> + +#### Defined in + +[interfaces/datastore.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L17) + +___ + +### findInstances + +▸ **findInstances**(`query`, `option`): `Promise`\<[`IInstanceData`](IInstanceData.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `option` | ``"summary"`` \| ``"full"`` | + +#### Returns + +`Promise`\<[`IInstanceData`](IInstanceData.md)[]\> + +#### Defined in + +[interfaces/datastore.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L18) + +___ + +### findItems + +▸ **findItems**(`query`): `Promise`\<[`IItemData`](IItemData.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`Promise`\<[`IItemData`](IItemData.md)[]\> + +#### Defined in + +[interfaces/datastore.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L19) + +___ + +### deleteInstances + +▸ **deleteInstances**(`query?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/datastore.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L20) + +___ + +### install + +▸ **install**(): `any` + +#### Returns + +`any` + +#### Defined in + +[interfaces/datastore.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L21) diff --git a/docs/api/interfaces/IDefinition.md b/docs/api/interfaces/IDefinition.md new file mode 100644 index 00000000..d031ae3d --- /dev/null +++ b/docs/api/interfaces/IDefinition.md @@ -0,0 +1,191 @@ +[bpmn-server](../API.md) / IDefinition + +# Interface: IDefinition + +## Implemented by + +- [`Definition`](../classes/Definition.md) + +## Table of contents + +### Properties + +- [name](IDefinition.md#name) +- [processes](IDefinition.md#processes) +- [rootElements](IDefinition.md#rootelements) +- [nodes](IDefinition.md#nodes) +- [flows](IDefinition.md#flows) +- [source](IDefinition.md#source) +- [logger](IDefinition.md#logger) +- [accessRules](IDefinition.md#accessrules) + +### Methods + +- [load](IDefinition.md#load) +- [getJson](IDefinition.md#getjson) +- [getDefinition](IDefinition.md#getdefinition) +- [getStartNode](IDefinition.md#getstartnode) +- [getNodeById](IDefinition.md#getnodebyid) + +## Properties + +### name + +• **name**: `any` + +#### Defined in + +[interfaces/elements.ts:4](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L4) + +___ + +### processes + +• **processes**: `Map`\<`any`, `any`\> + +#### Defined in + +[interfaces/elements.ts:5](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L5) + +___ + +### rootElements + +• **rootElements**: `any` + +#### Defined in + +[interfaces/elements.ts:6](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L6) + +___ + +### nodes + +• **nodes**: `Map`\<`any`, `any`\> + +#### Defined in + +[interfaces/elements.ts:7](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L7) + +___ + +### flows + +• **flows**: `any`[] + +#### Defined in + +[interfaces/elements.ts:8](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L8) + +___ + +### source + +• **source**: `any` + +#### Defined in + +[interfaces/elements.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L9) + +___ + +### logger + +• **logger**: `any` + +#### Defined in + +[interfaces/elements.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L10) + +___ + +### accessRules + +• **accessRules**: `any`[] + +#### Defined in + +[interfaces/elements.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L11) + +## Methods + +### load + +▸ **load**(): `Promise`\<`any`\> + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[interfaces/elements.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L12) + +___ + +### getJson + +▸ **getJson**(): `string` + +#### Returns + +`string` + +#### Defined in + +[interfaces/elements.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L13) + +___ + +### getDefinition + +▸ **getDefinition**(`source`, `logger`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `any` | +| `logger` | [`ILogger`](ILogger.md) | + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[interfaces/elements.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L14) + +___ + +### getStartNode + +▸ **getStartNode**(): [`Node`](../classes/Node.md) + +#### Returns + +[`Node`](../classes/Node.md) + +#### Defined in + +[interfaces/elements.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L15) + +___ + +### getNodeById + +▸ **getNodeById**(`id`): [`Node`](../classes/Node.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | + +#### Returns + +[`Node`](../classes/Node.md) + +#### Defined in + +[interfaces/elements.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L16) diff --git a/docs/api/interfaces/IDefinitionData.md b/docs/api/interfaces/IDefinitionData.md new file mode 100644 index 00000000..245e55e3 --- /dev/null +++ b/docs/api/interfaces/IDefinitionData.md @@ -0,0 +1,96 @@ +[bpmn-server](../API.md) / IDefinitionData + +# Interface: IDefinitionData + +## Table of contents + +### Properties + +- [name](IDefinitionData.md#name) +- [processes](IDefinitionData.md#processes) +- [rootElements](IDefinitionData.md#rootelements) +- [nodes](IDefinitionData.md#nodes) +- [flows](IDefinitionData.md#flows) +- [source](IDefinitionData.md#source) +- [logger](IDefinitionData.md#logger) +- [accessRules](IDefinitionData.md#accessrules) + +## Properties + +### name + +• **name**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L50) + +___ + +### processes + +• **processes**: `Map`\<`any`, `any`\> + +#### Defined in + +[interfaces/DataObjects.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L51) + +___ + +### rootElements + +• **rootElements**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:52](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L52) + +___ + +### nodes + +• **nodes**: `Map`\<`any`, `any`\> + +#### Defined in + +[interfaces/DataObjects.ts:53](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L53) + +___ + +### flows + +• **flows**: `any`[] + +#### Defined in + +[interfaces/DataObjects.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L54) + +___ + +### source + +• **source**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L55) + +___ + +### logger + +• **logger**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L56) + +___ + +### accessRules + +• **accessRules**: `any`[] + +#### Defined in + +[interfaces/DataObjects.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L57) diff --git a/docs/api/interfaces/IElement.md b/docs/api/interfaces/IElement.md new file mode 100644 index 00000000..0f2037ba --- /dev/null +++ b/docs/api/interfaces/IElement.md @@ -0,0 +1,223 @@ +[bpmn-server](../API.md) / IElement + +# Interface: IElement + +## Hierarchy + +- **`IElement`** + + ↳ [`INode`](INode.md) + + ↳ [`IFlow`](IFlow.md) + +## Implemented by + +- [`Element`](../classes/Element.md) + +## Table of contents + +### Properties + +- [id](IElement.md#id) +- [type](IElement.md#type) +- [name](IElement.md#name) +- [lane](IElement.md#lane) +- [behaviours](IElement.md#behaviours) + +### Methods + +- [continue](IElement.md#continue) +- [describe](IElement.md#describe) +- [restored](IElement.md#restored) +- [resume](IElement.md#resume) +- [hasBehaviour](IElement.md#hasbehaviour) +- [getBehaviour](IElement.md#getbehaviour) +- [addBehaviour](IElement.md#addbehaviour) + +## Properties + +### id + +• **id**: `any` + +#### Defined in + +[interfaces/elements.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L21) + +___ + +### type + +• **type**: `any` + +#### Defined in + +[interfaces/elements.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L22) + +___ + +### name + +• **name**: `any` + +#### Defined in + +[interfaces/elements.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L23) + +___ + +### lane + +• **lane**: `any` + +#### Defined in + +[interfaces/elements.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L24) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Defined in + +[interfaces/elements.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L25) + +## Methods + +### continue + +▸ **continue**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Defined in + +[interfaces/elements.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L26) + +___ + +### describe + +▸ **describe**(): `string`[][] + +#### Returns + +`string`[][] + +#### Defined in + +[interfaces/elements.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L27) + +___ + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Defined in + +[interfaces/elements.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L28) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Defined in + +[interfaces/elements.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L29) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Defined in + +[interfaces/elements.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/elements.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L35) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/elements.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L36) diff --git a/docs/api/interfaces/IElementData.md b/docs/api/interfaces/IElementData.md new file mode 100644 index 00000000..3150750d --- /dev/null +++ b/docs/api/interfaces/IElementData.md @@ -0,0 +1,52 @@ +[bpmn-server](../API.md) / IElementData + +# Interface: IElementData + +## Table of contents + +### Properties + +- [id](IElementData.md#id) +- [type](IElementData.md#type) +- [name](IElementData.md#name) +- [behaviours](IElementData.md#behaviours) + +## Properties + +### id + +• **id**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L62) + +___ + +### type + +• **type**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:63](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L63) + +___ + +### name + +• **name**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L64) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Defined in + +[interfaces/DataObjects.ts:65](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L65) diff --git a/docs/api/interfaces/IEngine.md b/docs/api/interfaces/IEngine.md new file mode 100644 index 00000000..d638989b --- /dev/null +++ b/docs/api/interfaces/IEngine.md @@ -0,0 +1,234 @@ +[bpmn-server](../API.md) / IEngine + +# Interface: IEngine + +## Implemented by + +- [`Engine`](../classes/Engine.md) + +## Table of contents + +### Methods + +- [start](IEngine.md#start) +- [get](IEngine.md#get) +- [invoke](IEngine.md#invoke) +- [assign](IEngine.md#assign) +- [startRepeatTimerEvent](IEngine.md#startrepeattimerevent) +- [startEvent](IEngine.md#startevent) +- [throwMessage](IEngine.md#throwmessage) +- [throwSignal](IEngine.md#throwsignal) + +## Methods + +### start + +▸ **start**(`name`, `data?`, `startNodeId?`, `userName?`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +loads a definitions and start execution + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | `any` | name of the process to start | +| `data?` | `any` | input data | +| `startNodeId?` | `string` | in process has multiple start node; you need to specify which one | +| `userName?` | `string` | - | +| `options?` | `any` | - | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[interfaces/server.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L40) + +___ + +### get + +▸ **get**(`instanceQuery`): `Promise`\<[`IExecution`](IExecution.md)\> + +restores an instance into memeory or provides you access to a running instance + +this will also resume execution + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `instanceQuery` | `any` | criteria to fetch the instance query example: ```jsonl { id: instanceId} { data: {caseId: 1005}} { items.id : 'abcc111322'} { items.itemKey : 'businesskey here'} ``` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[interfaces/server.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L58) + +___ + +### invoke + +▸ **invoke**(`itemQuery`, `data`, `userName?`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +Continue an existing item that is in a wait state + +------------------------------------------------- + +scenario: + +``` +itemId {itemId: value } +itemKey {itemKey: value} +instance,task {instanceId: instanceId, elementId: value } +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `itemQuery` | `any` | criteria to retrieve the item | +| `data` | `Object` | | +| `userName?` | `string` | - | +| `options?` | `Object` | - | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[interfaces/server.ts:75](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L75) + +___ + +### assign + +▸ **assign**(`itemQuery`, `data`, `assignment`, `userName`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `itemQuery` | `any` | +| `data` | `Object` | +| `assignment` | `Object` | +| `userName` | `string` | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[interfaces/server.ts:77](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L77) + +___ + +### startRepeatTimerEvent + +▸ **startRepeatTimerEvent**(`instanceId`, `prevItem`, `data`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | +| `prevItem` | [`IItem`](IItem.md) | +| `data` | `Object` | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[interfaces/server.ts:80](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L80) + +___ + +### startEvent + +▸ **startEvent**(`instanceId`, `elementId`, `data?`): `Promise`\<[`IExecution`](IExecution.md)\> + +Invoking an event (usually start event of a secondary process) against an existing instance +or +Invoking a start event (of a secondary process) against an existing instance +---------------------------------------------------------------------------- + instance,task +``` + {instanceId: instanceId, elementId: value } +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instanceId` | `any` | +| `elementId` | `any` | +| `data?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[interfaces/server.ts:98](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L98) + +___ + +### throwMessage + +▸ **throwMessage**(`messageId`, `data`, `matchingQuery`): `Promise`\<[`IExecution`](IExecution.md)\> + +signal/message raise a signal or throw a message + +will seach for a matching event/task given the signalId/messageId + +that can be againt a running instance or it may start a new instance +---------------------------------------------------------------------------- + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | `any` | the id of the message or signal as per bpmn definition | +| `data` | `Object` | message data | +| `matchingQuery` | `Object` | - | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[interfaces/server.ts:112](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L112) + +___ + +### throwSignal + +▸ **throwSignal**(`signalId`, `data`, `matchingQuery`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signalId` | `any` | +| `data` | `Object` | +| `matchingQuery` | `Object` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/server.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L113) diff --git a/docs/api/interfaces/IEventData.md b/docs/api/interfaces/IEventData.md new file mode 100644 index 00000000..5b9b8267 --- /dev/null +++ b/docs/api/interfaces/IEventData.md @@ -0,0 +1,188 @@ +[bpmn-server](../API.md) / IEventData + +# Interface: IEventData + +## Implemented by + +- [`EventData`](../classes/EventData.md) + +## Table of contents + +### Properties + +- [elementId](IEventData.md#elementid) +- [processId](IEventData.md#processid) +- [type](IEventData.md#type) +- [name](IEventData.md#name) +- [subType](IEventData.md#subtype) +- [signalId](IEventData.md#signalid) +- [messageId](IEventData.md#messageid) +- [expression](IEventData.md#expression) +- [expressionFormat](IEventData.md#expressionformat) +- [referenceDateTime](IEventData.md#referencedatetime) +- [maxRepeat](IEventData.md#maxrepeat) +- [repeatCount](IEventData.md#repeatcount) +- [timeDue](IEventData.md#timedue) +- [lane](IEventData.md#lane) +- [candidateGroups](IEventData.md#candidategroups) +- [candidateUsers](IEventData.md#candidateusers) + +## Properties + +### elementId + +• **elementId**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:73](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L73) + +___ + +### processId + +• **processId**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:74](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L74) + +___ + +### type + +• **type**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:75](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L75) + +___ + +### name + +• **name**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:76](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L76) + +___ + +### subType + +• **subType**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:77](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L77) + +___ + +### signalId + +• `Optional` **signalId**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:78](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L78) + +___ + +### messageId + +• `Optional` **messageId**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:79](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L79) + +___ + +### expression + +• **expression**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:81](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L81) + +___ + +### expressionFormat + +• **expressionFormat**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:82](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L82) + +___ + +### referenceDateTime + +• **referenceDateTime**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:83](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L83) + +___ + +### maxRepeat + +• **maxRepeat**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:84](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L84) + +___ + +### repeatCount + +• **repeatCount**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L85) + +___ + +### timeDue + +• `Optional` **timeDue**: `Date` + +#### Defined in + +[interfaces/DataObjects.ts:86](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L86) + +___ + +### lane + +• `Optional` **lane**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L87) + +___ + +### candidateGroups + +• `Optional` **candidateGroups**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:88](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L88) + +___ + +### candidateUsers + +• `Optional` **candidateUsers**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:89](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L89) diff --git a/docs/api/interfaces/IExecution.md b/docs/api/interfaces/IExecution.md new file mode 100644 index 00000000..de35722e --- /dev/null +++ b/docs/api/interfaces/IExecution.md @@ -0,0 +1,871 @@ +[bpmn-server](../API.md) / IExecution + +# Interface: IExecution + +## Hierarchy + +- [`IServerComponent`](IServerComponent.md) + + ↳ **`IExecution`** + +## Implemented by + +- [`Execution`](../classes/Execution.md) + +## Table of contents + +### Properties + +- [instance](IExecution.md#instance) +- [server](IExecution.md#server) +- [tokens](IExecution.md#tokens) +- [definition](IExecution.md#definition) +- [appDelegate](IExecution.md#appdelegate) +- [logger](IExecution.md#logger) +- [process](IExecution.md#process) +- [promises](IExecution.md#promises) +- [listener](IExecution.md#listener) +- [isLocked](IExecution.md#islocked) +- [errors](IExecution.md#errors) +- [item](IExecution.md#item) +- [messageMatchingKey](IExecution.md#messagematchingkey) +- [worker](IExecution.md#worker) +- [userName](IExecution.md#username) +- [id](IExecution.md#id) +- [status](IExecution.md#status) +- [options](IExecution.md#options) +- [name](IExecution.md#name) +- [uids](IExecution.md#uids) +- [configuration](IExecution.md#configuration) +- [cron](IExecution.md#cron) +- [cache](IExecution.md#cache) +- [engine](IExecution.md#engine) +- [dataStore](IExecution.md#datastore) +- [definitions](IExecution.md#definitions) + +### Methods + +- [getNodeById](IExecution.md#getnodebyid) +- [getToken](IExecution.md#gettoken) +- [tokenEnded](IExecution.md#tokenended) +- [getItemsData](IExecution.md#getitemsdata) +- [save](IExecution.md#save) +- [end](IExecution.md#end) +- [stop](IExecution.md#stop) +- [terminate](IExecution.md#terminate) +- [execute](IExecution.md#execute) +- [signalItem](IExecution.md#signalitem) +- [signalEvent](IExecution.md#signalevent) +- [signalRepeatTimerEvent](IExecution.md#signalrepeattimerevent) +- [getItems](IExecution.md#getitems) +- [getState](IExecution.md#getstate) +- [restored](IExecution.md#restored) +- [resume](IExecution.md#resume) +- [report](IExecution.md#report) +- [getNewId](IExecution.md#getnewid) +- [getUUID](IExecution.md#getuuid) +- [doExecutionEvent](IExecution.md#doexecutionevent) +- [doItemEvent](IExecution.md#doitemevent) +- [log](IExecution.md#log) +- [info](IExecution.md#info) +- [error](IExecution.md#error) +- [appendData](IExecution.md#appenddata) +- [getData](IExecution.md#getdata) +- [getAndCreateData](IExecution.md#getandcreatedata) + +## Properties + +### instance + +• **instance**: [`IInstanceData`](IInstanceData.md) + +#### Defined in + +[interfaces/engine.ts:68](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L68) + +___ + +### server + +• **server**: [`IBPMNServer`](IBPMNServer.md) + +#### Overrides + +[IServerComponent](IServerComponent.md).[server](IServerComponent.md#server) + +#### Defined in + +[interfaces/engine.ts:69](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L69) + +___ + +### tokens + +• **tokens**: `Map`\<`any`, [`IToken`](IToken.md)\> + +#### Defined in + +[interfaces/engine.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L70) + +___ + +### definition + +• **definition**: [`IDefinition`](IDefinition.md) + +#### Defined in + +[interfaces/engine.ts:71](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L71) + +___ + +### appDelegate + +• **appDelegate**: [`IAppDelegate`](IAppDelegate.md) + +#### Overrides + +[IServerComponent](IServerComponent.md).[appDelegate](IServerComponent.md#appdelegate) + +#### Defined in + +[interfaces/engine.ts:72](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L72) + +___ + +### logger + +• **logger**: [`ILogger`](ILogger.md) + +#### Overrides + +[IServerComponent](IServerComponent.md).[logger](IServerComponent.md#logger) + +#### Defined in + +[interfaces/engine.ts:73](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L73) + +___ + +### process + +• **process**: `any` + +#### Defined in + +[interfaces/engine.ts:74](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L74) + +___ + +### promises + +• **promises**: `any` + +#### Defined in + +[interfaces/engine.ts:75](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L75) + +___ + +### listener + +• **listener**: `any` + +#### Defined in + +[interfaces/engine.ts:76](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L76) + +___ + +### isLocked + +• **isLocked**: `boolean` + +#### Defined in + +[interfaces/engine.ts:77](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L77) + +___ + +### errors + +• **errors**: `any` + +#### Defined in + +[interfaces/engine.ts:79](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L79) + +___ + +### item + +• **item**: `any` + +#### Defined in + +[interfaces/engine.ts:80](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L80) + +___ + +### messageMatchingKey + +• **messageMatchingKey**: `any` + +#### Defined in + +[interfaces/engine.ts:81](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L81) + +___ + +### worker + +• **worker**: `any` + +#### Defined in + +[interfaces/engine.ts:82](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L82) + +___ + +### userName + +• **userName**: `any` + +#### Defined in + +[interfaces/engine.ts:83](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L83) + +___ + +### id + +• **id**: `any` + +#### Defined in + +[interfaces/engine.ts:85](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L85) + +___ + +### status + +• **status**: `any` + +#### Defined in + +[interfaces/engine.ts:86](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L86) + +___ + +### options + +• **options**: `any` + +#### Defined in + +[interfaces/engine.ts:87](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L87) + +___ + +### name + +• **name**: `any` + +#### Defined in + +[interfaces/engine.ts:88](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L88) + +___ + +### uids + +• **uids**: `Object` + +#### Defined in + +[interfaces/engine.ts:122](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L122) + +___ + +### configuration + +• **configuration**: [`IConfiguration`](IConfiguration.md) + +#### Inherited from + +[IServerComponent](IServerComponent.md).[configuration](IServerComponent.md#configuration) + +#### Defined in + +[interfaces/server.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L22) + +___ + +### cron + +• **cron**: `any` + +#### Inherited from + +[IServerComponent](IServerComponent.md).[cron](IServerComponent.md#cron) + +#### Defined in + +[interfaces/server.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L24) + +___ + +### cache + +• **cache**: `any` + +#### Inherited from + +[IServerComponent](IServerComponent.md).[cache](IServerComponent.md#cache) + +#### Defined in + +[interfaces/server.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L25) + +___ + +### engine + +• **engine**: `any` + +#### Inherited from + +[IServerComponent](IServerComponent.md).[engine](IServerComponent.md#engine) + +#### Defined in + +[interfaces/server.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L27) + +___ + +### dataStore + +• **dataStore**: [`IDataStore`](IDataStore.md) + +#### Inherited from + +[IServerComponent](IServerComponent.md).[dataStore](IServerComponent.md#datastore) + +#### Defined in + +[interfaces/server.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L28) + +___ + +### definitions + +• **definitions**: `any` + +#### Inherited from + +[IServerComponent](IServerComponent.md).[definitions](IServerComponent.md#definitions) + +#### Defined in + +[interfaces/server.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L29) + +## Methods + +### getNodeById + +▸ **getNodeById**(`id`): [`Node`](../classes/Node.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | + +#### Returns + +[`Node`](../classes/Node.md) + +#### Defined in + +[interfaces/engine.ts:90](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L90) + +___ + +### getToken + +▸ **getToken**(`id`): [`IToken`](IToken.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `number` | + +#### Returns + +[`IToken`](IToken.md) + +#### Defined in + +[interfaces/engine.ts:91](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L91) + +___ + +### tokenEnded + +▸ **tokenEnded**(`token`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | [`IToken`](IToken.md) | + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:92](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L92) + +___ + +### getItemsData + +▸ **getItemsData**(): [`IItemData`](IItemData.md)[] + +#### Returns + +[`IItemData`](IItemData.md)[] + +#### Defined in + +[interfaces/engine.ts:93](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L93) + +___ + +### save + +▸ **save**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/engine.ts:94](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L94) + +___ + +### end + +▸ **end**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/engine.ts:95](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L95) + +___ + +### stop + +▸ **stop**(): `void` + +causes the execution to stop from running any further + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:100](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L100) + +___ + +### terminate + +▸ **terminate**(): `void` + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:101](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L101) + +___ + +### execute + +▸ **execute**(`startNodeId?`, `inputData?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `startNodeId?` | `any` | +| `inputData?` | `Object` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/engine.ts:102](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L102) + +___ + +### signalItem + +▸ **signalItem**(`executionId`, `inputData`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +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`](IExecution.md)\> + +#### Defined in + +[interfaces/engine.ts:113](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L113) + +___ + +### signalEvent + +▸ **signalEvent**(`executionId`, `inputData`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `executionId` | `any` | +| `inputData` | `any` | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[interfaces/engine.ts:114](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L114) + +___ + +### signalRepeatTimerEvent + +▸ **signalRepeatTimerEvent**(`executionId`, `prevItem`, `inputData`, `options?`): `Promise`\<[`IExecution`](IExecution.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `executionId` | `any` | +| `prevItem` | `any` | +| `inputData` | `any` | +| `options?` | `Object` | + +#### Returns + +`Promise`\<[`IExecution`](IExecution.md)\> + +#### Defined in + +[interfaces/engine.ts:115](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L115) + +___ + +### getItems + +▸ **getItems**(`query?`): [`IItem`](IItem.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | `any` | + +#### Returns + +[`IItem`](IItem.md)[] + +#### Defined in + +[interfaces/engine.ts:117](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L117) + +___ + +### getState + +▸ **getState**(): [`IInstanceData`](IInstanceData.md) + +#### Returns + +[`IInstanceData`](IInstanceData.md) + +#### Defined in + +[interfaces/engine.ts:118](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L118) + +___ + +### restored + +▸ **restored**(): `void` + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:119](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L119) + +___ + +### resume + +▸ **resume**(): `void` + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:120](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L120) + +___ + +### report + +▸ **report**(): `void` + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:121](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L121) + +___ + +### getNewId + +▸ **getNewId**(`scope`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | `string` | + +#### Returns + +`number` + +#### Defined in + +[interfaces/engine.ts:123](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L123) + +___ + +### getUUID + +▸ **getUUID**(): `any` + +#### Returns + +`any` + +#### Defined in + +[interfaces/engine.ts:124](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L124) + +___ + +### doExecutionEvent + +▸ **doExecutionEvent**(`process`, `event`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `process` | `any` | +| `event` | `any` | + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[interfaces/engine.ts:125](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L125) + +___ + +### doItemEvent + +▸ **doItemEvent**(`item`, `event`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | +| `event` | `any` | + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[interfaces/engine.ts:126](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L126) + +___ + +### log + +▸ **log**(`...msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...msg` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:127](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L127) + +___ + +### info + +▸ **info**(`...msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...msg` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:128](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L128) + +___ + +### error + +▸ **error**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:129](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L129) + +___ + +### appendData + +▸ **appendData**(`inputData`, `item`, `dataPath?`, `assignment?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inputData` | `any` | +| `item` | [`IItem`](IItem.md) | +| `dataPath?` | `any` | +| `assignment?` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:130](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L130) + +___ + +### getData + +▸ **getData**(`dataPath`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dataPath` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/engine.ts:131](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L131) + +___ + +### getAndCreateData + +▸ **getAndCreateData**(`dataPath`, `asArray?`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dataPath` | `any` | +| `asArray?` | `boolean` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/engine.ts:132](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L132) diff --git a/docs/api/interfaces/IFlow.md b/docs/api/interfaces/IFlow.md new file mode 100644 index 00000000..5f12d012 --- /dev/null +++ b/docs/api/interfaces/IFlow.md @@ -0,0 +1,269 @@ +[bpmn-server](../API.md) / IFlow + +# Interface: IFlow + +## Hierarchy + +- [`IElement`](IElement.md) + + ↳ **`IFlow`** + +## Implemented by + +- [`Flow`](../classes/Flow.md) + +## Table of contents + +### Properties + +- [id](IFlow.md#id) +- [type](IFlow.md#type) +- [name](IFlow.md#name) +- [lane](IFlow.md#lane) +- [behaviours](IFlow.md#behaviours) + +### Methods + +- [continue](IFlow.md#continue) +- [describe](IFlow.md#describe) +- [restored](IFlow.md#restored) +- [resume](IFlow.md#resume) +- [hasBehaviour](IFlow.md#hasbehaviour) +- [getBehaviour](IFlow.md#getbehaviour) +- [addBehaviour](IFlow.md#addbehaviour) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[IElement](IElement.md).[id](IElement.md#id) + +#### Defined in + +[interfaces/elements.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L21) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[IElement](IElement.md).[type](IElement.md#type) + +#### Defined in + +[interfaces/elements.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L22) + +___ + +### name + +• **name**: `any` + +#### Inherited from + +[IElement](IElement.md).[name](IElement.md#name) + +#### Defined in + +[interfaces/elements.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L23) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[IElement](IElement.md).[lane](IElement.md#lane) + +#### Defined in + +[interfaces/elements.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L24) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[IElement](IElement.md).[behaviours](IElement.md#behaviours) + +#### Defined in + +[interfaces/elements.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L25) + +## Methods + +### continue + +▸ **continue**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Inherited from + +[IElement](IElement.md).[continue](IElement.md#continue) + +#### Defined in + +[interfaces/elements.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L26) + +___ + +### describe + +▸ **describe**(): `string`[][] + +#### Returns + +`string`[][] + +#### Inherited from + +[IElement](IElement.md).[describe](IElement.md#describe) + +#### Defined in + +[interfaces/elements.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L27) + +___ + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Inherited from + +[IElement](IElement.md).[restored](IElement.md#restored) + +#### Defined in + +[interfaces/elements.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L28) + +___ + +### resume + +▸ **resume**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Inherited from + +[IElement](IElement.md).[resume](IElement.md#resume) + +#### Defined in + +[interfaces/elements.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L29) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[IElement](IElement.md).[hasBehaviour](IElement.md#hasbehaviour) + +#### Defined in + +[interfaces/elements.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[IElement](IElement.md).[getBehaviour](IElement.md#getbehaviour) + +#### Defined in + +[interfaces/elements.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L35) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[IElement](IElement.md).[addBehaviour](IElement.md#addbehaviour) + +#### Defined in + +[interfaces/elements.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L36) diff --git a/docs/api/interfaces/IFlowData.md b/docs/api/interfaces/IFlowData.md new file mode 100644 index 00000000..86e250c8 --- /dev/null +++ b/docs/api/interfaces/IFlowData.md @@ -0,0 +1,3 @@ +[bpmn-server](../API.md) / IFlowData + +# Interface: IFlowData diff --git a/docs/api/interfaces/IInstanceData.md b/docs/api/interfaces/IInstanceData.md new file mode 100644 index 00000000..669d5b98 --- /dev/null +++ b/docs/api/interfaces/IInstanceData.md @@ -0,0 +1,166 @@ +[bpmn-server](../API.md) / IInstanceData + +# Interface: IInstanceData + +## Implemented by + +- [`InstanceObject`](../classes/InstanceObject.md) + +## Table of contents + +### Properties + +- [id](IInstanceData.md#id) +- [name](IInstanceData.md#name) +- [status](IInstanceData.md#status) +- [version](IInstanceData.md#version) +- [startedAt](IInstanceData.md#startedat) +- [endedAt](IInstanceData.md#endedat) +- [saved](IInstanceData.md#saved) +- [data](IInstanceData.md#data) +- [items](IInstanceData.md#items) +- [source](IInstanceData.md#source) +- [logs](IInstanceData.md#logs) +- [tokens](IInstanceData.md#tokens) +- [loops](IInstanceData.md#loops) +- [parentItemId](IInstanceData.md#parentitemid) + +## Properties + +### id + +• **id**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L31) + +___ + +### name + +• **name**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L32) + +___ + +### status + +• **status**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:33](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L33) + +___ + +### version + +• **version**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L34) + +___ + +### startedAt + +• **startedAt**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L35) + +___ + +### endedAt + +• **endedAt**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L36) + +___ + +### saved + +• **saved**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:37](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L37) + +___ + +### data + +• **data**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L38) + +___ + +### items + +• **items**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L39) + +___ + +### source + +• **source**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L40) + +___ + +### logs + +• **logs**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L41) + +___ + +### tokens + +• **tokens**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:42](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L42) + +___ + +### loops + +• **loops**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:43](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L43) + +___ + +### parentItemId + +• **parentItemId**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L44) diff --git a/docs/api/interfaces/IItem.md b/docs/api/interfaces/IItem.md new file mode 100644 index 00000000..2c394607 --- /dev/null +++ b/docs/api/interfaces/IItem.md @@ -0,0 +1,407 @@ +[bpmn-server](../API.md) / IItem + +# Interface: IItem + +## Hierarchy + +- [`IItemData`](IItemData.md) + + ↳ **`IItem`** + +## Implemented by + +- [`Item`](../classes/Item.md) + +## Table of contents + +### Properties + +- [id](IItem.md#id) +- [itemKey](IItem.md#itemkey) +- [elementId](IItem.md#elementid) +- [name](IItem.md#name) +- [type](IItem.md#type) +- [instanceId](IItem.md#instanceid) +- [processName](IItem.md#processname) +- [tokenId](IItem.md#tokenid) +- [userName](IItem.md#username) +- [startedAt](IItem.md#startedat) +- [endedAt](IItem.md#endedat) +- [seq](IItem.md#seq) +- [timeDue](IItem.md#timedue) +- [status](IItem.md#status) +- [messageId](IItem.md#messageid) +- [signalId](IItem.md#signalid) +- [vars](IItem.md#vars) +- [assignee](IItem.md#assignee) +- [candidateGroups](IItem.md#candidategroups) +- [candidateUsers](IItem.md#candidateusers) +- [dueDate](IItem.md#duedate) +- [followUpDate](IItem.md#followupdate) +- [priority](IItem.md#priority) +- [element](IItem.md#element) +- [token](IItem.md#token) +- [context](IItem.md#context) +- [node](IItem.md#node) + +## Properties + +### id + +• **id**: `string` + +#### Inherited from + +[IItemData](IItemData.md).[id](IItemData.md#id) + +#### Defined in + +[interfaces/DataObjects.ts:4](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L4) + +___ + +### itemKey + +• **itemKey**: `string` + +#### Inherited from + +[IItemData](IItemData.md).[itemKey](IItemData.md#itemkey) + +#### Defined in + +[interfaces/DataObjects.ts:5](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L5) + +___ + +### elementId + +• **elementId**: `string` + +#### Inherited from + +[IItemData](IItemData.md).[elementId](IItemData.md#elementid) + +#### Defined in + +[interfaces/DataObjects.ts:6](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L6) + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[IItemData](IItemData.md).[name](IItemData.md#name) + +#### Defined in + +[interfaces/DataObjects.ts:7](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L7) + +___ + +### type + +• **type**: `string` + +#### Inherited from + +[IItemData](IItemData.md).[type](IItemData.md#type) + +#### Defined in + +[interfaces/DataObjects.ts:8](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L8) + +___ + +### instanceId + +• **instanceId**: `string` + +#### Inherited from + +[IItemData](IItemData.md).[instanceId](IItemData.md#instanceid) + +#### Defined in + +[interfaces/DataObjects.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L9) + +___ + +### processName + +• `Optional` **processName**: `string` + +#### Inherited from + +[IItemData](IItemData.md).[processName](IItemData.md#processname) + +#### Defined in + +[interfaces/DataObjects.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L10) + +___ + +### tokenId + +• **tokenId**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[tokenId](IItemData.md#tokenid) + +#### Defined in + +[interfaces/DataObjects.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L11) + +___ + +### userName + +• **userName**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[userName](IItemData.md#username) + +#### Defined in + +[interfaces/DataObjects.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L12) + +___ + +### startedAt + +• **startedAt**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[startedAt](IItemData.md#startedat) + +#### Defined in + +[interfaces/DataObjects.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L13) + +___ + +### endedAt + +• **endedAt**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[endedAt](IItemData.md#endedat) + +#### Defined in + +[interfaces/DataObjects.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L14) + +___ + +### seq + +• **seq**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[seq](IItemData.md#seq) + +#### Defined in + +[interfaces/DataObjects.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L15) + +___ + +### timeDue + +• **timeDue**: `Date` + +#### Inherited from + +[IItemData](IItemData.md).[timeDue](IItemData.md#timedue) + +#### Defined in + +[interfaces/DataObjects.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L16) + +___ + +### status + +• **status**: [`ITEM_STATUS`](../enums/ITEM_STATUS.md) + +#### Inherited from + +[IItemData](IItemData.md).[status](IItemData.md#status) + +#### Defined in + +[interfaces/DataObjects.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L17) + +___ + +### messageId + +• **messageId**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[messageId](IItemData.md#messageid) + +#### Defined in + +[interfaces/DataObjects.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[signalId](IItemData.md#signalid) + +#### Defined in + +[interfaces/DataObjects.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L20) + +___ + +### vars + +• **vars**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[vars](IItemData.md#vars) + +#### Defined in + +[interfaces/DataObjects.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[assignee](IItemData.md#assignee) + +#### Defined in + +[interfaces/DataObjects.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[candidateGroups](IItemData.md#candidategroups) + +#### Defined in + +[interfaces/DataObjects.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[candidateUsers](IItemData.md#candidateusers) + +#### Defined in + +[interfaces/DataObjects.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L24) + +___ + +### dueDate + +• **dueDate**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[dueDate](IItemData.md#duedate) + +#### Defined in + +[interfaces/DataObjects.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L25) + +___ + +### followUpDate + +• **followUpDate**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[followUpDate](IItemData.md#followupdate) + +#### Defined in + +[interfaces/DataObjects.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L26) + +___ + +### priority + +• **priority**: `any` + +#### Inherited from + +[IItemData](IItemData.md).[priority](IItemData.md#priority) + +#### Defined in + +[interfaces/DataObjects.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L27) + +___ + +### element + +• **element**: [`Element`](../classes/Element.md) + +#### Defined in + +[interfaces/engine.ts:136](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L136) + +___ + +### token + +• **token**: [`Token`](../classes/Token.md) + +#### Defined in + +[interfaces/engine.ts:137](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L137) + +___ + +### context + +• **context**: [`IExecution`](IExecution.md) + +#### Defined in + +[interfaces/engine.ts:138](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L138) + +___ + +### node + +• **node**: [`Node`](../classes/Node.md) + +#### Defined in + +[interfaces/engine.ts:139](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L139) diff --git a/docs/api/interfaces/IItemData.md b/docs/api/interfaces/IItemData.md new file mode 100644 index 00000000..2e8b6076 --- /dev/null +++ b/docs/api/interfaces/IItemData.md @@ -0,0 +1,271 @@ +[bpmn-server](../API.md) / IItemData + +# Interface: IItemData + +## Hierarchy + +- **`IItemData`** + + ↳ [`IItem`](IItem.md) + +## Implemented by + +- [`ItemObject`](../classes/ItemObject.md) + +## Table of contents + +### Properties + +- [id](IItemData.md#id) +- [itemKey](IItemData.md#itemkey) +- [elementId](IItemData.md#elementid) +- [name](IItemData.md#name) +- [type](IItemData.md#type) +- [instanceId](IItemData.md#instanceid) +- [processName](IItemData.md#processname) +- [tokenId](IItemData.md#tokenid) +- [userName](IItemData.md#username) +- [startedAt](IItemData.md#startedat) +- [endedAt](IItemData.md#endedat) +- [seq](IItemData.md#seq) +- [timeDue](IItemData.md#timedue) +- [status](IItemData.md#status) +- [messageId](IItemData.md#messageid) +- [signalId](IItemData.md#signalid) +- [vars](IItemData.md#vars) +- [assignee](IItemData.md#assignee) +- [candidateGroups](IItemData.md#candidategroups) +- [candidateUsers](IItemData.md#candidateusers) +- [dueDate](IItemData.md#duedate) +- [followUpDate](IItemData.md#followupdate) +- [priority](IItemData.md#priority) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:4](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L4) + +___ + +### itemKey + +• **itemKey**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:5](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L5) + +___ + +### elementId + +• **elementId**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:6](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L6) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:7](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L7) + +___ + +### type + +• **type**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:8](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L8) + +___ + +### instanceId + +• **instanceId**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L9) + +___ + +### processName + +• `Optional` **processName**: `string` + +#### Defined in + +[interfaces/DataObjects.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L10) + +___ + +### tokenId + +• **tokenId**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L11) + +___ + +### userName + +• **userName**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L12) + +___ + +### startedAt + +• **startedAt**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L13) + +___ + +### endedAt + +• **endedAt**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L14) + +___ + +### seq + +• **seq**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L15) + +___ + +### timeDue + +• **timeDue**: `Date` + +#### Defined in + +[interfaces/DataObjects.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L16) + +___ + +### status + +• **status**: [`ITEM_STATUS`](../enums/ITEM_STATUS.md) + +#### Defined in + +[interfaces/DataObjects.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L17) + +___ + +### messageId + +• **messageId**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L19) + +___ + +### signalId + +• **signalId**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L20) + +___ + +### vars + +• **vars**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L21) + +___ + +### assignee + +• **assignee**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L22) + +___ + +### candidateGroups + +• **candidateGroups**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L23) + +___ + +### candidateUsers + +• **candidateUsers**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L24) + +___ + +### dueDate + +• **dueDate**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L25) + +___ + +### followUpDate + +• **followUpDate**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L26) + +___ + +### priority + +• **priority**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L27) diff --git a/docs/api/interfaces/ILogger.md b/docs/api/interfaces/ILogger.md new file mode 100644 index 00000000..ff39de15 --- /dev/null +++ b/docs/api/interfaces/ILogger.md @@ -0,0 +1,197 @@ +[bpmn-server](../API.md) / ILogger + +# Interface: ILogger + +A logging tool to take various message for monitoring and debugging + +it can also keep the message in memory till saved later through saveToFile +msgs can be cleared by the clean method + +## Implemented by + +- [`Logger`](../classes/Logger.md) + +## Table of contents + +### Methods + +- [setOptions](ILogger.md#setoptions) +- [clear](ILogger.md#clear) +- [get](ILogger.md#get) +- [debug](ILogger.md#debug) +- [warn](ILogger.md#warn) +- [log](ILogger.md#log) +- [error](ILogger.md#error) +- [reportError](ILogger.md#reporterror) +- [save](ILogger.md#save) + +## Methods + +### setOptions + +▸ **setOptions**(`«destructured»`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `toConsole` | `any` | +| › `toFile` | `any` | +| › `callback` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/common.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L49) + +___ + +### clear + +▸ **clear**(): `void` + +#### Returns + +`void` + +#### Defined in + +[interfaces/common.ts:54](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L54) + +___ + +### get + +▸ **get**(): `any`[] + +#### Returns + +`any`[] + +#### Defined in + +[interfaces/common.ts:55](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L55) + +___ + +### debug + +▸ **debug**(`...message`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...message` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/common.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L56) + +___ + +### warn + +▸ **warn**(`...message`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...message` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/common.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L57) + +___ + +### log + +▸ **log**(`...message`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...message` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/common.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L58) + +___ + +### error + +▸ **error**(`err`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/common.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L59) + +___ + +### reportError + +▸ **reportError**(`err`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/common.ts:60](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L60) + +___ + +### save + +▸ **save**(`filename`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `filename` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/common.ts:61](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/common.ts#L61) diff --git a/docs/api/interfaces/IModelsDatastore.md b/docs/api/interfaces/IModelsDatastore.md new file mode 100644 index 00000000..7bad7dba --- /dev/null +++ b/docs/api/interfaces/IModelsDatastore.md @@ -0,0 +1,270 @@ +[bpmn-server](../API.md) / IModelsDatastore + +# Interface: IModelsDatastore + +## Implemented by + +- [`ModelsDatastore`](../classes/ModelsDatastore.md) +- [`ModelsDatastoreDB`](../classes/ModelsDatastoreDB.md) + +## Table of contents + +### Methods + +- [getList](IModelsDatastore.md#getlist) +- [getSource](IModelsDatastore.md#getsource) +- [getSVG](IModelsDatastore.md#getsvg) +- [save](IModelsDatastore.md#save) +- [load](IModelsDatastore.md#load) +- [loadModel](IModelsDatastore.md#loadmodel) +- [findEvents](IModelsDatastore.md#findevents) +- [install](IModelsDatastore.md#install) +- [import](IModelsDatastore.md#import) +- [saveModel](IModelsDatastore.md#savemodel) +- [deleteModel](IModelsDatastore.md#deletemodel) +- [renameModel](IModelsDatastore.md#renamemodel) + +## Methods + +### getList + +▸ **getList**(`query`): `Promise`\<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`Promise`\<`string`[]\> + +#### Defined in + +[interfaces/datastore.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L25) + +___ + +### getSource + +▸ **getSource**(`name`, `owner`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `owner` | `any` | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[interfaces/datastore.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L26) + +___ + +### getSVG + +▸ **getSVG**(`name`, `owner`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `owner` | `any` | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[interfaces/datastore.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L27) + +___ + +### save + +▸ **save**(`name`, `bpmn`, `svg?`, `owner?`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `bpmn` | `any` | +| `svg?` | `any` | +| `owner?` | `any` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[interfaces/datastore.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L28) + +___ + +### load + +▸ **load**(`name`, `owner`): `Promise`\<[`IDefinition`](IDefinition.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `owner` | `any` | + +#### Returns + +`Promise`\<[`IDefinition`](IDefinition.md)\> + +#### Defined in + +[interfaces/datastore.ts:30](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L30) + +___ + +### loadModel + +▸ **loadModel**(`name`, `owner`): `Promise`\<[`IBpmnModelData`](IBpmnModelData.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `owner` | `any` | + +#### Returns + +`Promise`\<[`IBpmnModelData`](IBpmnModelData.md)\> + +#### Defined in + +[interfaces/datastore.ts:31](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L31) + +___ + +### findEvents + +▸ **findEvents**(`query`, `owner`): `Promise`\<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | +| `owner` | `any` | + +#### Returns + +`Promise`\<`any`[]\> + +#### Defined in + +[interfaces/datastore.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L32) + +___ + +### install + +▸ **install**(): `any` + +#### Returns + +`any` + +#### Defined in + +[interfaces/datastore.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L34) + +___ + +### import + +▸ **import**(`data`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/datastore.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L35) + +___ + +### saveModel + +▸ **saveModel**(`model`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | [`IBpmnModelData`](IBpmnModelData.md) | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[interfaces/datastore.ts:37](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L37) + +___ + +### deleteModel + +▸ **deleteModel**(`name`, `owner`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `owner` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/datastore.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L38) + +___ + +### renameModel + +▸ **renameModel**(`name`, `newName`, `owner`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `newName` | `any` | +| `owner` | `any` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[interfaces/datastore.ts:39](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/datastore.ts#L39) diff --git a/docs/api/interfaces/INode.md b/docs/api/interfaces/INode.md new file mode 100644 index 00000000..9cf39ef8 --- /dev/null +++ b/docs/api/interfaces/INode.md @@ -0,0 +1,520 @@ +[bpmn-server](../API.md) / INode + +# Interface: INode + +## Hierarchy + +- [`IElement`](IElement.md) + + ↳ **`INode`** + +## Table of contents + +### Properties + +- [id](INode.md#id) +- [type](INode.md#type) +- [lane](INode.md#lane) +- [behaviours](INode.md#behaviours) +- [name](INode.md#name) +- [processId](INode.md#processid) +- [def](INode.md#def) +- [outbounds](INode.md#outbounds) +- [inbounds](INode.md#inbounds) + +### Methods + +- [describe](INode.md#describe) +- [restored](INode.md#restored) +- [hasBehaviour](INode.md#hasbehaviour) +- [getBehaviour](INode.md#getbehaviour) +- [addBehaviour](INode.md#addbehaviour) +- [doEvent](INode.md#doevent) +- [enter](INode.md#enter) +- [requiresWait](INode.md#requireswait) +- [canBeInvoked](INode.md#canbeinvoked) +- [execute](INode.md#execute) +- [continue](INode.md#continue) +- [start](INode.md#start) +- [run](INode.md#run) +- [end](INode.md#end) +- [resume](INode.md#resume) +- [init](INode.md#init) +- [getOutbounds](INode.md#getoutbounds) + +## Properties + +### id + +• **id**: `any` + +#### Inherited from + +[IElement](IElement.md).[id](IElement.md#id) + +#### Defined in + +[interfaces/elements.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L21) + +___ + +### type + +• **type**: `any` + +#### Inherited from + +[IElement](IElement.md).[type](IElement.md#type) + +#### Defined in + +[interfaces/elements.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L22) + +___ + +### lane + +• **lane**: `any` + +#### Inherited from + +[IElement](IElement.md).[lane](IElement.md#lane) + +#### Defined in + +[interfaces/elements.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L24) + +___ + +### behaviours + +• **behaviours**: `Map`\<`any`, `any`\> + +#### Inherited from + +[IElement](IElement.md).[behaviours](IElement.md#behaviours) + +#### Defined in + +[interfaces/elements.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L25) + +___ + +### name + +• **name**: `any` + +#### Overrides + +[IElement](IElement.md).[name](IElement.md#name) + +#### Defined in + +[interfaces/elements.ts:42](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L42) + +___ + +### processId + +• **processId**: `any` + +#### Defined in + +[interfaces/elements.ts:43](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L43) + +___ + +### def + +• **def**: `any` + +#### Defined in + +[interfaces/elements.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L44) + +___ + +### outbounds + +• **outbounds**: `any`[] + +#### Defined in + +[interfaces/elements.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L45) + +___ + +### inbounds + +• **inbounds**: `any`[] + +#### Defined in + +[interfaces/elements.ts:46](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L46) + +## Methods + +### describe + +▸ **describe**(): `string`[][] + +#### Returns + +`string`[][] + +#### Inherited from + +[IElement](IElement.md).[describe](IElement.md#describe) + +#### Defined in + +[interfaces/elements.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L27) + +___ + +### restored + +▸ **restored**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Inherited from + +[IElement](IElement.md).[restored](IElement.md#restored) + +#### Defined in + +[interfaces/elements.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L28) + +___ + +### hasBehaviour + +▸ **hasBehaviour**(`name`): `boolean` + +respond by providing behaviour attributes beyond item and node information + ex: timer due , input/outupt , fields + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[IElement](IElement.md).[hasBehaviour](IElement.md#hasbehaviour) + +#### Defined in + +[interfaces/elements.ts:34](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L34) + +___ + +### getBehaviour + +▸ **getBehaviour**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[IElement](IElement.md).[getBehaviour](IElement.md#getbehaviour) + +#### Defined in + +[interfaces/elements.ts:35](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L35) + +___ + +### addBehaviour + +▸ **addBehaviour**(`nane`, `behavriour`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nane` | `any` | +| `behavriour` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[IElement](IElement.md).[addBehaviour](IElement.md#addbehaviour) + +#### Defined in + +[interfaces/elements.ts:36](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L36) + +___ + +### doEvent + +▸ **doEvent**(`item`, `event`, `newStatus`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | +| `event` | [`EXECUTION_EVENT`](../enums/EXECUTION_EVENT.md) | +| `newStatus` | [`ITEM_STATUS`](../enums/ITEM_STATUS.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/elements.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L47) + +___ + +### enter + +▸ **enter**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Defined in + +[interfaces/elements.ts:48](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L48) + +___ + +### requiresWait + +▸ **requiresWait**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[interfaces/elements.ts:49](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L49) + +___ + +### canBeInvoked + +▸ **canBeInvoked**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[interfaces/elements.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L50) + +___ + +### execute + +▸ **execute**(`item`): `Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +this is the primary exectuion method for a node + +considerations: the following are handled by Token + 1. Loops we are inside a loop already (if any) + 2. Gatways + 3. Subprocess the parent node is fired as normal + run method will fire the subprocess invoking a new token and will go into wait + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`Promise`\<`void` \| [`wait`](../enums/NODE_ACTION.md#wait) \| [`error`](../enums/NODE_ACTION.md#error) \| [`abort`](../enums/NODE_ACTION.md#abort)\> + +#### Defined in + +[interfaces/elements.ts:60](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L60) + +___ + +### continue + +▸ **continue**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[IElement](IElement.md).[continue](IElement.md#continue) + +#### Defined in + +[interfaces/elements.ts:61](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L61) + +___ + +### start + +▸ **start**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Defined in + +[interfaces/elements.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L62) + +___ + +### run + +▸ **run**(`item`): `Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`Promise`\<[`NODE_ACTION`](../enums/NODE_ACTION.md)\> + +#### Defined in + +[interfaces/elements.ts:63](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L63) + +___ + +### end + +▸ **end**(`item`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/elements.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L64) + +___ + +### resume + +▸ **resume**(`item`): `void` + +is called by the token after an execution resume for every active (in wait) item +different than init, which is called for all items + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Overrides + +[IElement](IElement.md).[resume](IElement.md#resume) + +#### Defined in + +[interfaces/elements.ts:70](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L70) + +___ + +### init + +▸ **init**(`item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Defined in + +[interfaces/elements.ts:71](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L71) + +___ + +### getOutbounds + +▸ **getOutbounds**(`item`): [`IItem`](IItem.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +[`IItem`](IItem.md)[] + +#### Defined in + +[interfaces/elements.ts:72](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/elements.ts#L72) diff --git a/docs/api/interfaces/IProcessData.md b/docs/api/interfaces/IProcessData.md new file mode 100644 index 00000000..38df3137 --- /dev/null +++ b/docs/api/interfaces/IProcessData.md @@ -0,0 +1,45 @@ +[bpmn-server](../API.md) / IProcessData + +# Interface: IProcessData + +## Implemented by + +- [`ProcessData`](../classes/ProcessData.md) + +## Table of contents + +### Properties + +- [id](IProcessData.md#id) +- [name](IProcessData.md#name) +- [isExecutable](IProcessData.md#isexecutable) + +## Properties + +### id + +• **id**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:102](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L102) + +___ + +### name + +• **name**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:103](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L103) + +___ + +### isExecutable + +• **isExecutable**: `any` + +#### Defined in + +[interfaces/DataObjects.ts:104](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/DataObjects.ts#L104) diff --git a/docs/api/interfaces/ISecureUser.md b/docs/api/interfaces/ISecureUser.md new file mode 100644 index 00000000..23868f82 --- /dev/null +++ b/docs/api/interfaces/ISecureUser.md @@ -0,0 +1,389 @@ +[bpmn-server](../API.md) / ISecureUser + +# Interface: ISecureUser + +## Hierarchy + +- [`IUserInfo`](IUserInfo.md) + + ↳ **`ISecureUser`** + +## Implemented by + +- [`SecureUser`](../classes/SecureUser.md) + +## Table of contents + +### Properties + +- [userName](ISecureUser.md#username) +- [userGroups](ISecureUser.md#usergroups) +- [tenantId](ISecureUser.md#tenantid) +- [modelsOwner](ISecureUser.md#modelsowner) + +### Methods + +- [isAdmin](ISecureUser.md#isadmin) +- [isSystem](ISecureUser.md#issystem) +- [inGroup](ISecureUser.md#ingroup) +- [qualifyInstances](ISecureUser.md#qualifyinstances) +- [qualifyItems](ISecureUser.md#qualifyitems) +- [qualifyStartEvents](ISecureUser.md#qualifystartevents) +- [qualifyDeleteInstances](ISecureUser.md#qualifydeleteinstances) +- [qualifyModels](ISecureUser.md#qualifymodels) +- [canModifyModel](ISecureUser.md#canmodifymodel) +- [canDeleteModel](ISecureUser.md#candeletemodel) +- [qualifyViewItems](ISecureUser.md#qualifyviewitems) +- [canInvoke](ISecureUser.md#caninvoke) +- [canAssign](ISecureUser.md#canassign) +- [canStart](ISecureUser.md#canstart) + +## Properties + +### userName + +• **userName**: `string` + +#### Inherited from + +[IUserInfo](IUserInfo.md).[userName](IUserInfo.md#username) + +#### Defined in + +[interfaces/User.ts:3](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L3) + +___ + +### userGroups + +• **userGroups**: `string`[] + +#### Inherited from + +[IUserInfo](IUserInfo.md).[userGroups](IUserInfo.md#usergroups) + +#### Defined in + +[interfaces/User.ts:4](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L4) + +___ + +### tenantId + +• `Optional` **tenantId**: `string` + +#### Inherited from + +[IUserInfo](IUserInfo.md).[tenantId](IUserInfo.md#tenantid) + +#### Defined in + +[interfaces/User.ts:5](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L5) + +___ + +### modelsOwner + +• `Optional` **modelsOwner**: `string` + +#### Inherited from + +[IUserInfo](IUserInfo.md).[modelsOwner](IUserInfo.md#modelsowner) + +#### Defined in + +[interfaces/User.ts:6](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L6) + +## Methods + +### isAdmin + +▸ **isAdmin**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[interfaces/User.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L10) + +___ + +### isSystem + +▸ **isSystem**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[interfaces/User.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L11) + +___ + +### inGroup + +▸ **inGroup**(`userGroup`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userGroup` | `any` | + +#### Returns + +`boolean` + +#### Defined in + +[interfaces/User.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L12) + +___ + +### qualifyInstances + +▸ **qualifyInstances**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Defined in + +[interfaces/User.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L18) + +___ + +### qualifyItems + +▸ **qualifyItems**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Defined in + +[interfaces/User.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L25) + +___ + +### qualifyStartEvents + +▸ **qualifyStartEvents**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Defined in + +[interfaces/User.ts:32](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L32) + +___ + +### qualifyDeleteInstances + +▸ **qualifyDeleteInstances**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Defined in + +[interfaces/User.ts:38](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L38) + +___ + +### qualifyModels + +▸ **qualifyModels**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Defined in + +[interfaces/User.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L44) + +___ + +### canModifyModel + +▸ **canModifyModel**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/User.ts:47](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L47) + +___ + +### canDeleteModel + +▸ **canDeleteModel**(`name`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/User.ts:50](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L50) + +___ + +### qualifyViewItems + +▸ **qualifyViewItems**(`query`): `any` + +alters the query adding conditions based on security rules + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +query + +#### Defined in + +[interfaces/User.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L56) + +___ + +### canInvoke + +▸ **canInvoke**(`item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/User.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L57) + +___ + +### canAssign + +▸ **canAssign**(`item`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/User.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L58) + +___ + +### canStart + +▸ **canStart**(`name`, `startNodeId`, `user`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `any` | +| `startNodeId` | `any` | +| `user` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/User.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L59) diff --git a/docs/api/interfaces/IServerComponent.md b/docs/api/interfaces/IServerComponent.md new file mode 100644 index 00000000..0cf08d41 --- /dev/null +++ b/docs/api/interfaces/IServerComponent.md @@ -0,0 +1,113 @@ +[bpmn-server](../API.md) / IServerComponent + +# Interface: IServerComponent + +## Hierarchy + +- **`IServerComponent`** + + ↳ [`IExecution`](IExecution.md) + +## Table of contents + +### Properties + +- [server](IServerComponent.md#server) +- [configuration](IServerComponent.md#configuration) +- [logger](IServerComponent.md#logger) +- [cron](IServerComponent.md#cron) +- [cache](IServerComponent.md#cache) +- [appDelegate](IServerComponent.md#appdelegate) +- [engine](IServerComponent.md#engine) +- [dataStore](IServerComponent.md#datastore) +- [definitions](IServerComponent.md#definitions) + +## Properties + +### server + +• **server**: [`IBPMNServer`](IBPMNServer.md) + +#### Defined in + +[interfaces/server.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L21) + +___ + +### configuration + +• **configuration**: [`IConfiguration`](IConfiguration.md) + +#### Defined in + +[interfaces/server.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L22) + +___ + +### logger + +• **logger**: [`ILogger`](ILogger.md) + +#### Defined in + +[interfaces/server.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L23) + +___ + +### cron + +• **cron**: `any` + +#### Defined in + +[interfaces/server.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L24) + +___ + +### cache + +• **cache**: `any` + +#### Defined in + +[interfaces/server.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L25) + +___ + +### appDelegate + +• **appDelegate**: [`IAppDelegate`](IAppDelegate.md) + +#### Defined in + +[interfaces/server.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L26) + +___ + +### engine + +• **engine**: `any` + +#### Defined in + +[interfaces/server.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L27) + +___ + +### dataStore + +• **dataStore**: [`IDataStore`](IDataStore.md) + +#### Defined in + +[interfaces/server.ts:28](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L28) + +___ + +### definitions + +• **definitions**: `any` + +#### Defined in + +[interfaces/server.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/server.ts#L29) diff --git a/docs/api/interfaces/IToken.md b/docs/api/interfaces/IToken.md new file mode 100644 index 00000000..f40b1254 --- /dev/null +++ b/docs/api/interfaces/IToken.md @@ -0,0 +1,546 @@ +[bpmn-server](../API.md) / IToken + +# Interface: IToken + +## Implemented by + +- [`Token`](../classes/Token.md) + +## Table of contents + +### Properties + +- [id](IToken.md#id) +- [type](IToken.md#type) +- [execution](IToken.md#execution) +- [dataPath](IToken.md#datapath) +- [startNodeId](IToken.md#startnodeid) +- [parentToken](IToken.md#parenttoken) +- [originItem](IToken.md#originitem) +- [path](IToken.md#path) +- [loop](IToken.md#loop) +- [currentNode](IToken.md#currentnode) +- [processId](IToken.md#processid) +- [status](IToken.md#status) +- [data](IToken.md#data) +- [currentItem](IToken.md#currentitem) +- [lastItem](IToken.md#lastitem) +- [firstItem](IToken.md#firstitem) +- [childrenTokens](IToken.md#childrentokens) + +### Methods + +- [save](IToken.md#save) +- [resume](IToken.md#resume) +- [stop](IToken.md#stop) +- [processError](IToken.md#processerror) +- [restored](IToken.md#restored) +- [getChildrenTokens](IToken.md#getchildrentokens) +- [preExecute](IToken.md#preexecute) +- [preNext](IToken.md#prenext) +- [execute](IToken.md#execute) +- [appendData](IToken.md#appenddata) +- [terminate](IToken.md#terminate) +- [signal](IToken.md#signal) +- [getFullPath](IToken.md#getfullpath) +- [end](IToken.md#end) +- [goNext](IToken.md#gonext) +- [getSubProcessToken](IToken.md#getsubprocesstoken) +- [log](IToken.md#log) +- [info](IToken.md#info) +- [error](IToken.md#error) + +## Properties + +### id + +• **id**: `any` + +#### Defined in + +[interfaces/engine.ts:10](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L10) + +___ + +### type + +• **type**: `any` + +#### Defined in + +[interfaces/engine.ts:11](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L11) + +___ + +### execution + +• **execution**: [`IExecution`](IExecution.md) + +#### Defined in + +[interfaces/engine.ts:12](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L12) + +___ + +### dataPath + +• **dataPath**: `string` + +#### Defined in + +[interfaces/engine.ts:13](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L13) + +___ + +### startNodeId + +• **startNodeId**: `any` + +#### Defined in + +[interfaces/engine.ts:14](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L14) + +___ + +### parentToken + +• `Optional` **parentToken**: [`IToken`](IToken.md) + +#### Defined in + +[interfaces/engine.ts:15](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L15) + +___ + +### originItem + +• **originItem**: [`IItem`](IItem.md) + +#### Defined in + +[interfaces/engine.ts:17](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L17) + +___ + +### path + +• **path**: [`IItem`](IItem.md)[] + +#### Defined in + +[interfaces/engine.ts:18](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L18) + +___ + +### loop + +• **loop**: `any` + +#### Defined in + +[interfaces/engine.ts:19](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L19) + +___ + +### currentNode + +• **currentNode**: `any` + +#### Defined in + +[interfaces/engine.ts:20](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L20) + +___ + +### processId + +• **processId**: `any` + +#### Defined in + +[interfaces/engine.ts:21](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L21) + +___ + +### status + +• **status**: [`TOKEN_STATUS`](../enums/TOKEN_STATUS.md) + +#### Defined in + +[interfaces/engine.ts:22](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L22) + +___ + +### data + +• **data**: `any` + +#### Defined in + +[interfaces/engine.ts:23](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L23) + +___ + +### currentItem + +• **currentItem**: [`IItem`](IItem.md) + +#### Defined in + +[interfaces/engine.ts:24](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L24) + +___ + +### lastItem + +• **lastItem**: [`IItem`](IItem.md) + +#### Defined in + +[interfaces/engine.ts:25](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L25) + +___ + +### firstItem + +• **firstItem**: [`Item`](../classes/Item.md) + +#### Defined in + +[interfaces/engine.ts:26](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L26) + +___ + +### childrenTokens + +• **childrenTokens**: [`Token`](../classes/Token.md)[] + +#### Defined in + +[interfaces/engine.ts:27](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L27) + +## Methods + +### save + +▸ **save**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `type` | `any` | +| `status` | [`TOKEN_STATUS`](../enums/TOKEN_STATUS.md) | +| `dataPath` | `string` | +| `loopId` | `any` | +| `parentToken` | `any` | +| `originItem` | `any` | +| `startNodeId` | `any` | +| `currentNode` | `any` | + +#### Defined in + +[interfaces/engine.ts:29](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L29) + +___ + +### resume + +▸ **resume**(): `void` + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:40](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L40) + +___ + +### stop + +▸ **stop**(): `void` + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:41](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L41) + +___ + +### processError + +▸ **processError**(): `any` + +#### Returns + +`any` + +#### Defined in + +[interfaces/engine.ts:42](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L42) + +___ + +### restored + +▸ **restored**(): `void` + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:43](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L43) + +___ + +### getChildrenTokens + +▸ **getChildrenTokens**(): `any`[] + +#### Returns + +`any`[] + +#### Defined in + +[interfaces/engine.ts:44](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L44) + +___ + +### preExecute + +▸ **preExecute**(): `Promise`\<`boolean`\> + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[interfaces/engine.ts:45](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L45) + +___ + +### preNext + +▸ **preNext**(): `Promise`\<`boolean`\> + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[interfaces/engine.ts:46](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L46) + +___ + +### 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](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L50) + +___ + +### appendData + +▸ **appendData**(`inputData`, `item`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inputData` | `any` | +| `item` | [`IItem`](IItem.md) | + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:51](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L51) + +___ + +### terminate + +▸ **terminate**(): `void` + +is called by Gateways to cancel current token + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:56](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L56) + +___ + +### signal + +▸ **signal**(`data`): `Promise`\<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `any` | + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[interfaces/engine.ts:57](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L57) + +___ + +### getFullPath + +▸ **getFullPath**(`fullPath?`): [`Item`](../classes/Item.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fullPath?` | `any` | + +#### Returns + +[`Item`](../classes/Item.md)[] + +#### Defined in + +[interfaces/engine.ts:58](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L58) + +___ + +### end + +▸ **end**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/engine.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L59) + +___ + +### goNext + +▸ **goNext**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[interfaces/engine.ts:60](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L60) + +___ + +### getSubProcessToken + +▸ **getSubProcessToken**(): [`IToken`](IToken.md) + +#### Returns + +[`IToken`](IToken.md) + +#### Defined in + +[interfaces/engine.ts:61](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L61) + +___ + +### log + +▸ **log**(`...msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...msg` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:62](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L62) + +___ + +### info + +▸ **info**(`...msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...msg` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:63](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L63) + +___ + +### error + +▸ **error**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `any` | + +#### Returns + +`void` + +#### Defined in + +[interfaces/engine.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/engine.ts#L64) diff --git a/docs/api/interfaces/IUserInfo.md b/docs/api/interfaces/IUserInfo.md new file mode 100644 index 00000000..e0be28a3 --- /dev/null +++ b/docs/api/interfaces/IUserInfo.md @@ -0,0 +1,58 @@ +[bpmn-server](../API.md) / IUserInfo + +# Interface: IUserInfo + +## Hierarchy + +- **`IUserInfo`** + + ↳ [`ISecureUser`](ISecureUser.md) + +## Table of contents + +### Properties + +- [userName](IUserInfo.md#username) +- [userGroups](IUserInfo.md#usergroups) +- [tenantId](IUserInfo.md#tenantid) +- [modelsOwner](IUserInfo.md#modelsowner) + +## Properties + +### userName + +• **userName**: `string` + +#### Defined in + +[interfaces/User.ts:3](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L3) + +___ + +### userGroups + +• **userGroups**: `string`[] + +#### Defined in + +[interfaces/User.ts:4](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L4) + +___ + +### tenantId + +• `Optional` **tenantId**: `string` + +#### Defined in + +[interfaces/User.ts:5](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L5) + +___ + +### modelsOwner + +• `Optional` **modelsOwner**: `string` + +#### Defined in + +[interfaces/User.ts:6](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L6) diff --git a/docs/api/interfaces/IUserService.md b/docs/api/interfaces/IUserService.md new file mode 100644 index 00000000..5c96377e --- /dev/null +++ b/docs/api/interfaces/IUserService.md @@ -0,0 +1,90 @@ +[bpmn-server](../API.md) / IUserService + +# Interface: IUserService + +## Table of contents + +### Methods + +- [findUsers](IUserService.md#findusers) +- [addUser](IUserService.md#adduser) +- [setPassword](IUserService.md#setpassword) +- [install](IUserService.md#install) + +## Methods + +### findUsers + +▸ **findUsers**(`query`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/User.ts:63](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L63) + +___ + +### addUser + +▸ **addUser**(`userName`, `email`, `password`, `userGroups`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userName` | `any` | +| `email` | `any` | +| `password` | `any` | +| `userGroups` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/User.ts:64](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L64) + +___ + +### setPassword + +▸ **setPassword**(`userName`, `password`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userName` | `any` | +| `password` | `any` | + +#### Returns + +`any` + +#### Defined in + +[interfaces/User.ts:65](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L65) + +___ + +### install + +▸ **install**(): `any` + +#### Returns + +`any` + +#### Defined in + +[interfaces/User.ts:66](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/interfaces/User.ts#L66) diff --git a/docs/api/readme.md b/docs/api/readme.md new file mode 100644 index 00000000..b69e8de6 --- /dev/null +++ b/docs/api/readme.md @@ -0,0 +1,231 @@ +bpmn-server + +# bpmn-server + +## Table of contents + +## API + +### Enumerations + +- [USER\_ROLE](enums/USER_ROLE.md) + +### Interfaces + +- [IAPIEngine](interfaces/IAPIEngine.md) +- [IAPIEngine](interfaces/IAPIEngine.md) +- [IAPIData](interfaces/IAPIData.md) +- [IAPIModel](interfaces/IAPIModel.md) + + +### Classes + +- [BPMNAPI](classes/BPMNAPI.md) +- [BPMNAPI](classes/BPMNAPI.md) +- [APIEngine](classes/APIEngine.md) +- [APIData](classes/APIData.md) +- [APIModel](classes/APIModel.md) +- [SecureUser](classes/SecureUser.md) + + +## Server + +### Enumerations + +- [TOKEN\_TYPE](enums/TOKEN_TYPE.md) +- [BPMN\_TYPE](enums/BPMN_TYPE.md) +- [NODE\_SUBTYPE](enums/NODE_SUBTYPE.md) +- [EXECUTION\_EVENT](enums/EXECUTION_EVENT.md) +- [NODE\_ACTION](enums/NODE_ACTION.md) +- [ITEM\_STATUS](enums/ITEM_STATUS.md) +- [EXECUTION\_STATUS](enums/EXECUTION_STATUS.md) +- [TOKEN\_STATUS](enums/TOKEN_STATUS.md) +- [FLOW\_ACTION](enums/FLOW_ACTION.md) + +### Classes + +- [Configuration](classes/Configuration.md) +- [Logger](classes/Logger.md) +- [DataStore](classes/DataStore.md) +- [InstanceLocker](classes/InstanceLocker.md) +- [BpmnModelData](classes/BpmnModelData.md) +- [ProcessData](classes/ProcessData.md) +- [EventData](classes/EventData.md) +- [ModelsDatastore](classes/ModelsDatastore.md) +- [ModelsDatastoreDB](classes/ModelsDatastoreDB.md) +- [MongoDB](classes/MongoDB.md) +- [Definition](classes/Definition.md) +- [Element](classes/Element.md) +- [Event](classes/Event.md) +- [CatchEvent](classes/CatchEvent.md) +- [BoundaryEvent](classes/BoundaryEvent.md) +- [ThrowEvent](classes/ThrowEvent.md) +- [EndEvent](classes/EndEvent.md) +- [StartEvent](classes/StartEvent.md) +- [Flow](classes/Flow.md) +- [MessageFlow](classes/MessageFlow.md) +- [Gateway](classes/Gateway.md) +- [XORGateway](classes/XORGateway.md) +- [EventBasedGateway](classes/EventBasedGateway.md) +- [Node](classes/Node.md) +- [NodeLoader](classes/NodeLoader.md) +- [Process](classes/Process.md) +- [ScriptTask](classes/ScriptTask.md) +- [ServiceTask](classes/ServiceTask.md) +- [BusinessRuleTask](classes/BusinessRuleTask.md) +- [SendTask](classes/SendTask.md) +- [UserTask](classes/UserTask.md) +- [ReceiveTask](classes/ReceiveTask.md) +- [SubProcess](classes/SubProcess.md) +- [CallActivity](classes/CallActivity.md) +- [Transaction](classes/Transaction.md) +- [Behaviour](classes/Behaviour.md) +- [BehaviourLoader](classes/BehaviourLoader.md) +- [CamundaFormData](classes/CamundaFormData.md) +- [IOBehaviour](classes/IOBehaviour.md) +- [LoopBehaviour](classes/LoopBehaviour.md) +- [MessageEventBehaviour](classes/MessageEventBehaviour.md) +- [SignalEventBehaviour](classes/SignalEventBehaviour.md) +- [ScriptBehaviour](classes/ScriptBehaviour.md) +- [TerminateBehaviour](classes/TerminateBehaviour.md) +- [TimerBehaviour](classes/TimerBehaviour.md) +- [DefaultAppDelegate](classes/DefaultAppDelegate.md) +- [Execution](classes/Execution.md) +- [Item](classes/Item.md) +- [Loop](classes/Loop.md) +- [InstanceObject](classes/InstanceObject.md) +- [ItemObject](classes/ItemObject.md) +- [TokenObject](classes/TokenObject.md) +- [LoopObject](classes/LoopObject.md) +- [Query](classes/Query.md) +- [ScriptHandler](classes/ScriptHandler.md) +- [Token](classes/Token.md) +- [BPMNServer](classes/BPMNServer.md) +- [NoCacheManager](classes/NoCacheManager.md) +- [CacheManager](classes/CacheManager.md) +- [Cron](classes/Cron.md) +- [Engine](classes/Engine.md) +- [ServerComponent](classes/ServerComponent.md) + +### Interfaces + +- [IBehaviour](interfaces/IBehaviour.md) +- [IItemData](interfaces/IItemData.md) +- [IInstanceData](interfaces/IInstanceData.md) +- [IDefinitionData](interfaces/IDefinitionData.md) +- [IElementData](interfaces/IElementData.md) +- [IFlowData](interfaces/IFlowData.md) +- [IEventData](interfaces/IEventData.md) +- [IBpmnModelData](interfaces/IBpmnModelData.md) +- [IProcessData](interfaces/IProcessData.md) +- [IUserInfo](interfaces/IUserInfo.md) +- [ISecureUser](interfaces/ISecureUser.md) +- [IUserService](interfaces/IUserService.md) +- [IConfiguration](interfaces/IConfiguration.md) +- [ILogger](interfaces/ILogger.md) +- [IAppDelegate](interfaces/IAppDelegate.md) +- [IDataStore](interfaces/IDataStore.md) +- [IModelsDatastore](interfaces/IModelsDatastore.md) +- [IDefinition](interfaces/IDefinition.md) +- [IElement](interfaces/IElement.md) +- [IFlow](interfaces/IFlow.md) +- [INode](interfaces/INode.md) +- [IToken](interfaces/IToken.md) +- [IExecution](interfaces/IExecution.md) +- [IItem](interfaces/IItem.md) +- [IBPMNServer](interfaces/IBPMNServer.md) +- [IServerComponent](interfaces/IServerComponent.md) +- [IEngine](interfaces/IEngine.md) +- [ICron](interfaces/ICron.md) +- [ICacheManager](interfaces/ICacheManager.md) + +### Variables + +- [SystemUser](API.md#systemuser) +- [defaultConfiguration](API.md#defaultconfiguration) +- [Behaviour\_names](API.md#behaviour_names) +- [docsFolder](API.md#docsfolder) + +### Functions + +- [dateDiff](API.md#datediff) + +## Variables + +### SystemUser + +• `Const` **SystemUser**: [`SecureUser`](classes/SecureUser.md) + +#### Defined in + +[API/SecureUser.ts:230](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L230) + +___ + +### defaultConfiguration + +• **defaultConfiguration**: [`Configuration`](classes/Configuration.md) + +#### Defined in + +[common/DefaultConfiguration.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L59) + +___ + +### Behaviour\_names + +• `Const` **Behaviour\_names**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `TimerEventDefinition` | `string` | +| `LoopCharacteristics` | `string` | +| `IOSpecification` | `string` | +| `TerminateEventDefinition` | `string` | +| `MessageEventDefinition` | `string` | +| `SignalEventDefinition` | `string` | +| `ErrorEventDefinition` | `string` | +| `EscalationEventDefinition` | `string` | +| `CancelEventDefinition` | `string` | +| `CompensateEventDefinition` | `string` | +| `CamundaFormData` | `string` | +| `CamundaScript` | `string` | +| `CamundaScript2` | `string` | +| `CamundaScript3` | `string` | +| `CamundaIO` | `string` | + +#### Defined in + +[elements/behaviours/BehaviourLoader.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/BehaviourLoader.ts#L16) + +___ + +### docsFolder + +• `Const` **docsFolder**: `string` + +#### Defined in + +[index.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/index.ts#L9) + +## Functions + +### dateDiff + +▸ **dateDiff**(`dateStr`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dateStr` | `any` | + +#### Returns + +`string` + +#### Defined in + +[common/timer.ts:4](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/timer.ts#L4)