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

bpmn-server / Node

Class: Node

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new Node(id, process, type, def): Node

Parameters

Name Type
id any
process any
type any
def any

Returns

Node

Overrides

Element.constructor

Defined in

elements/Node.ts:29

Properties

assignee

• assignee: any

Defined in

elements/Node.ts:22


attachedTo

• attachedTo: Node

Defined in

elements/Node.ts:18


attachments

• attachments: Node[]

Defined in

elements/Node.ts:17


behaviours

• behaviours: Map<any, any>

Inherited from

Element.behaviours

Defined in

elements/Element.ts:17


def

• def: any

Defined in

elements/Node.ts:14


id

• id: any

Inherited from

Element.id

Defined in

elements/Element.ts:13


inbounds

• inbounds: Flow[]

Defined in

elements/Node.ts:16


initiator

• initiator: any

Defined in

elements/Node.ts:21


isFlow

• isFlow: boolean = false

Inherited from

Element.isFlow

Defined in

elements/Element.ts:18


lane

• lane: any

Inherited from

Element.lane

Defined in

elements/Element.ts:19


messageId

• messageId: any

Defined in

elements/Node.ts:19


name

• name: any

Overrides

Element.name

Defined in

elements/Node.ts:12


outbounds

• outbounds: Flow[]

Defined in

elements/Node.ts:15


process

• process: any

Defined in

elements/Node.ts:13


scripts

• scripts: Map<any, any>

Defined in

elements/Node.ts:23


signalId

• signalId: any

Defined in

elements/Node.ts:20


subType

• subType: any

Inherited from

Element.subType

Defined in

elements/Element.ts:15


type

• type: any

Inherited from

Element.type

Defined in

elements/Element.ts:14

Accessors

canBeInvoked

• get canBeInvoked(): boolean

Returns

boolean

Defined in

elements/Node.ts:123


isCatching

• get isCatching(): boolean

Returns

boolean

Defined in

elements/Node.ts:125


processId

• get processId(): any

Returns

any

Defined in

elements/Node.ts:24


requiresWait

• get requiresWait(): boolean

Returns

boolean

Defined in

elements/Node.ts:118

Methods

addBehaviour

▸ addBehaviour(nane, behavriour): void

Parameters

Name Type
nane any
behavriour any

Returns

void

Inherited from

Element.addBehaviour

Defined in

elements/Element.ts:39


cancelBoundaryEvents

▸ cancelBoundaryEvents(item): Promise<void>

Parameters

Name Type
item any

Returns

Promise<void>

Defined in

elements/Node.ts:235


cancelEBG

▸ cancelEBG(item): Promise<void>

Parameters

Name Type
item any

Returns

Promise<void>

Defined in

elements/Node.ts:227


continue

▸ continue(item): Promise<void>

Parameters

Name Type
item Item

Returns

Promise<void>

Overrides

Element.continue

Defined in

elements/Node.ts:208


describe

▸ describe(): string[][]

Returns

string[][]

Inherited from

Element.describe

Defined in

elements/Element.ts:21


doEvent

▸ doEvent(item, event, newStatus): Promise<any[]>

Parameters

Name Type
item Item
event EXECUTION_EVENT
newStatus ITEM_STATUS

Returns

Promise<any[]>

Defined in

elements/Node.ts:53


end

▸ end(item, cancel?): Promise<void>

Parameters

Name Type Default value
item Item undefined
cancel Boolean false

Returns

Promise<void>

Defined in

elements/Node.ts:268


enter

▸ enter(item): void

Parameters

Name Type
item Item

Returns

void

Defined in

elements/Node.ts:109


execute

▸ 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

Parameters

Name Type
item Item

Returns

Promise<void | wait | end | error | abort>

Defined in

elements/Node.ts:135


getBehaviour

▸ getBehaviour(name): any

Parameters

Name Type
name any

Returns

any

Inherited from

Element.getBehaviour

Defined in

elements/Element.ts:36


getInput

▸ getInput(item, input): Promise<{}>

Parameters

Name Type
item Item
input any

Returns

Promise<{}>

Defined in

elements/Node.ts:91


getOutbounds

▸ getOutbounds(item): Item[]

Parameters

Name Type
item Item

Returns

Item[]

Defined in

elements/Node.ts:311


getOutput

▸ getOutput(item): Promise<{}>

transform data using output rules todo

Parameters

Name Type
item Item

Returns

Promise<{}>

Defined in

elements/Node.ts:105


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

Defined in

elements/Element.ts:32


init

▸ init(item): void

Parameters

Name Type
item Item

Returns

void

Defined in

elements/Node.ts:306


restored

▸ restored(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Element.restored

Defined in

elements/Element.ts:22


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

Returns

void

Overrides

Element.resume

Defined in

elements/Node.ts:303


run

▸ run(item): Promise<NODE_ACTION>

Parameters

Name Type
item Item

Returns

Promise<NODE_ACTION>

Defined in

elements/Node.ts:223


setInput

▸ setInput(item, input): Promise<void>

is Called after execution transform data using input rules todo

Parameters

Name Type
item Item
input any

Returns

Promise<void>

Defined in

elements/Node.ts:81


start

▸ start(item): Promise<NODE_ACTION>

Parameters

Name Type
item Item

Returns

Promise<NODE_ACTION>

Defined in

elements/Node.ts:213


startBoundaryEvents

▸ startBoundaryEvents(item, token): Promise<void>

Parameters

Name Type
item any
token any

Returns

Promise<void>

Defined in

elements/Node.ts:330


validate

▸ validate(item): Promise<void>

Parameters

Name Type
item Item

Returns

Promise<void>

Defined in

elements/Node.ts:42

Clone this wiki locally