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