Contents
bpmn-server / INode
Interface: INode
Hierarchy
-
IElement
↳
INode
Table of contents
Properties
Methods
- describe
- restored
- hasBehaviour
- getBehaviour
- addBehaviour
- doEvent
- enter
- requiresWait
- canBeInvoked
- execute
- continue
- start
- run
- end
- resume
- init
- getOutbounds
Properties
id
• id: any
Inherited from
Defined in
type
• type: any
Inherited from
Defined in
lane
• lane: any
Inherited from
Defined in
behaviours
• behaviours: Map
<any
, any
>
Inherited from
Defined in
name
• name: any
Overrides
Defined in
processId
• processId: any
Defined in
def
• def: any
Defined in
outbounds
• outbounds: any
[]
Defined in
inbounds
• inbounds: any
[]
Defined in
Methods
describe
▸ describe(): string
[][]
Returns
string
[][]
Inherited from
Defined in
restored
▸ restored(item
): void
Parameters
Name | Type |
---|---|
item |
IItem |
Returns
void
Inherited from
Defined in
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
Defined in
getBehaviour
▸ getBehaviour(name
): any
Parameters
Name | Type |
---|---|
name |
any |
Returns
any
Inherited from
Defined in
addBehaviour
▸ addBehaviour(nane
, behavriour
): void
Parameters
Name | Type |
---|---|
nane |
any |
behavriour |
any |
Returns
void
Inherited from
Defined in
doEvent
▸ doEvent(item
, event
, newStatus
): Promise
<void
>
Parameters
Name | Type |
---|---|
item |
IItem |
event |
EXECUTION_EVENT |
newStatus |
ITEM_STATUS |
Returns
Promise
<void
>
Defined in
enter
▸ enter(item
): void
Parameters
Name | Type |
---|---|
item |
IItem |
Returns
void
Defined in
requiresWait
▸ requiresWait(): boolean
Returns
boolean
Defined in
canBeInvoked
▸ canBeInvoked(): boolean
Returns
boolean
Defined in
execute
▸ execute(item
): Promise
<void
| wait
| error
| abort
>
this is the primary exectuion method for a node
considerations: the following are handled by Token
- Loops we are inside a loop already (if any)
- Gatways
- 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 |
Returns
Promise
<void
| wait
| error
| abort
>
Defined in
continue
▸ continue(item
): Promise
<void
>
Parameters
Name | Type |
---|---|
item |
IItem |
Returns
Promise
<void
>
Overrides
Defined in
start
▸ start(item
): Promise
<NODE_ACTION
>
Parameters
Name | Type |
---|---|
item |
IItem |
Returns
Promise
<NODE_ACTION
>
Defined in
run
▸ run(item
): Promise
<NODE_ACTION
>
Parameters
Name | Type |
---|---|
item |
IItem |
Returns
Promise
<NODE_ACTION
>
Defined in
end
▸ end(item
): Promise
<void
>
Parameters
Name | Type |
---|---|
item |
IItem |
Returns
Promise
<void
>
Defined in
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 |
Returns
void
Overrides
Defined in
init
▸ init(item
): void
Parameters
Name | Type |
---|---|
item |
IItem |
Returns
void
Defined in
getOutbounds
▸ getOutbounds(item
): IItem
[]
Parameters
Name | Type |
---|---|
item |
IItem |
Returns
IItem
[]