Repository navigation
Transaction
bpmn-server / Transaction
-
↳
Transaction
- assignee
- attachedTo
- attachments
- behaviours
- childProcess
- def
- id
- inbounds
- initiator
- isFlow
- lane
- messageId
- name
- outbounds
- process
- scripts
- signalId
- subType
- type
- addBehaviour
- cancelBoundaryEvents
- cancelEBG
- continue
- describe
- doEvent
- end
- enter
- execute
- getBehaviour
- getInput
- getItems
- getItemsForToken
- getNodes
- getOutbounds
- getOutput
- hasBehaviour
- init
- restored
- resume
- run
- setInput
- start
- startBoundaryEvents
- validate
- Cancel
- Compensate
• new Transaction(id, process, type, def): Transaction
| Name | Type |
|---|---|
id |
any |
process |
any |
type |
any |
def |
any |
• assignee: any
• attachedTo: Node
• attachments: Node[]
• behaviours: Map<any, any>
• childProcess: Process
• def: any
• id: any
• inbounds: Flow[]
• initiator: any
• isFlow: boolean = false
• lane: any
• messageId: any
• name: any
• outbounds: Flow[]
• process: any
• scripts: Map<any, any>
• signalId: any
• subType: any
• type: any
• get canBeInvoked(): boolean
boolean
SubProcess.canBeInvoked
• get isCatching(): boolean
boolean
SubProcess.isCatching
• get processId(): any
any
SubProcess.processId
• get requiresWait(): boolean
boolean
SubProcess.requiresWait
▸ addBehaviour(nane, behavriour): void
| Name | Type |
|---|---|
nane |
any |
behavriour |
any |
void
▸ cancelBoundaryEvents(item): Promise<void>
| Name | Type |
|---|---|
item |
any |
Promise<void>
SubProcess.cancelBoundaryEvents
▸ cancelEBG(item): Promise<void>
| Name | Type |
|---|---|
item |
any |
Promise<void>
▸ continue(item): Promise<void>
| Name | Type |
|---|---|
item |
Item |
Promise<void>
▸ describe(): string[][]
string[][]
▸ doEvent(item, event, newStatus): Promise<any[]>
| Name | Type |
|---|---|
item |
Item |
event |
EXECUTION_EVENT |
newStatus |
ITEM_STATUS |
Promise<any[]>
▸ end(item, cancel?): Promise<void>
| Name | Type | Default value |
|---|---|---|
item |
any |
undefined |
cancel |
Boolean |
false |
Promise<void>
▸ enter(item): void
| Name | Type |
|---|---|
item |
Item |
void
▸ execute(item): Promise<void | wait | end | error | 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
| Name | Type |
|---|---|
item |
Item |
Promise<void | wait | end | error | abort>
▸ getBehaviour(name): any
| Name | Type |
|---|---|
name |
any |
any
▸ getInput(item, input): Promise<{}>
| Name | Type |
|---|---|
item |
Item |
input |
any |
Promise<{}>
▸ getItems(item): any[]
| Name | Type |
|---|---|
item |
any |
any[]
▸ getItemsForToken(token): any[]
| Name | Type |
|---|---|
token |
any |
any[]
▸ getNodes(): Node[]
Node[]
▸ getOutbounds(item): Item[]
| Name | Type |
|---|---|
item |
Item |
Item[]
▸ getOutput(item): Promise<{}>
transform data using output rules todo
| Name | Type |
|---|---|
item |
Item |
Promise<{}>
▸ hasBehaviour(name): boolean
respond by providing behaviour attributes beyond item and node information ex: timer due , input/outupt , fields
| Name | Type |
|---|---|
name |
any |
boolean
▸ init(item): void
| Name | Type |
|---|---|
item |
Item |
void
▸ restored(item): void
| Name | Type |
|---|---|
item |
Item |
void
▸ 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
| Name | Type |
|---|---|
item |
Item |
void
▸ run(item): Promise<NODE_ACTION>
| Name | Type |
|---|---|
item |
Item |
Promise<NODE_ACTION>
▸ setInput(item, input): Promise<void>
is Called after execution transform data using input rules todo
| Name | Type |
|---|---|
item |
Item |
input |
any |
Promise<void>
▸ start(item): Promise<NODE_ACTION>
| Name | Type |
|---|---|
item |
any |
Promise<NODE_ACTION>
▸ startBoundaryEvents(item, token): Promise<void>
| Name | Type |
|---|---|
item |
any |
token |
any |
Promise<void>
SubProcess.startBoundaryEvents
▸ validate(item): Promise<void>
| Name | Type |
|---|---|
item |
Item |
Promise<void>
▸ Cancel(transaction): Promise<void>
Cancel Transaction is called by Throw Cancel Event
- Aborts any started items in the transaction
- Compensate any completed items
| Name | Type |
|---|---|
transaction |
any |
Promise<void>
▸ Compensate(transItem): Promise<void>
Compensate Transaction is called by Throw Compensate Event this is called outside of the transaction
- Compensate any completed items
| Name | Type |
|---|---|
transItem |
any |
Promise<void>