Skip to content
ralphhanna edited this page Dec 18, 2023 · 3 revisions

bpmn-server / INode

Interface: INode

Hierarchy

Table of contents

Properties

Methods

Properties

behaviours

behaviours: Map<any, any>

Inherited from

IElement.behaviours

Defined in

interfaces/elements.ts:25


def

def: any

Defined in

interfaces/elements.ts:44


id

id: any

Inherited from

IElement.id

Defined in

interfaces/elements.ts:21


inbounds

inbounds: any[]

Defined in

interfaces/elements.ts:46


lane

lane: any

Inherited from

IElement.lane

Defined in

interfaces/elements.ts:24


name

name: any

Overrides

IElement.name

Defined in

interfaces/elements.ts:42


outbounds

outbounds: any[]

Defined in

interfaces/elements.ts:45


processId

processId: any

Defined in

interfaces/elements.ts:43


type

type: any

Inherited from

IElement.type

Defined in

interfaces/elements.ts:22

Methods

addBehaviour

addBehaviour(nane, behavriour): void

Parameters

Name Type
nane any
behavriour any

Returns

void

Inherited from

IElement.addBehaviour

Defined in

interfaces/elements.ts:36


canBeInvoked

canBeInvoked(): boolean

Returns

boolean

Defined in

interfaces/elements.ts:50


continue

continue(item): Promise<void>

Parameters

Name Type
item IItem

Returns

Promise<void>

Overrides

IElement.continue

Defined in

interfaces/elements.ts:61


describe

describe(): string[][]

Returns

string[][]

Inherited from

IElement.describe

Defined in

interfaces/elements.ts:27


doEvent

doEvent(item, event, newStatus): Promise<void>

Parameters

Name Type
item IItem
event EXECUTION_EVENT
newStatus ITEM_STATUS

Returns

Promise<void>

Defined in

interfaces/elements.ts:47


end

end(item): Promise<void>

Parameters

Name Type
item IItem

Returns

Promise<void>

Defined in

interfaces/elements.ts:64


enter

enter(item): void

Parameters

Name Type
item IItem

Returns

void

Defined in

interfaces/elements.ts:48


execute

execute(item): Promise<void | wait | 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

Parameters

Name Type
item IItem

Returns

Promise<void | wait | error | abort>

Defined in

interfaces/elements.ts:60


getBehaviour

getBehaviour(name): any

Parameters

Name Type
name any

Returns

any

Inherited from

IElement.getBehaviour

Defined in

interfaces/elements.ts:35


getOutbounds

getOutbounds(item): IItem[]

Parameters

Name Type
item IItem

Returns

IItem[]

Defined in

interfaces/elements.ts:72


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.hasBehaviour

Defined in

interfaces/elements.ts:34


init

init(item): void

Parameters

Name Type
item IItem

Returns

void

Defined in

interfaces/elements.ts:71


requiresWait

requiresWait(): boolean

Returns

boolean

Defined in

interfaces/elements.ts:49


restored

restored(item): void

Parameters

Name Type
item IItem

Returns

void

Inherited from

IElement.restored

Defined in

interfaces/elements.ts:28


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

IElement.resume

Defined in

interfaces/elements.ts:70


run

run(item): Promise<NODE_ACTION>

Parameters

Name Type
item IItem

Returns

Promise<NODE_ACTION>

Defined in

interfaces/elements.ts:63


start

start(item): Promise<NODE_ACTION>

Parameters

Name Type
item IItem

Returns

Promise<NODE_ACTION>

Defined in

interfaces/elements.ts:62

Clone this wiki locally