Skip to content

bpmn-server / Node

Class: Node#

Hierarchy#

↳ Node

↳↳ UserTask

↳↳ ScriptTask

↳↳ ServiceTask

↳↳ ReceiveTask

↳↳ SubProcess

↳↳ CallActivity

↳↳ AdHocSubProcess

↳↳ Event

↳↳ Gateway

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#

packages/bpmn-server/src/elements/Node.ts:34

Properties#

id#

• id: any

Inherited from#

Element.id

Defined in#

packages/bpmn-server/src/elements/Element.ts:13


type#

• type: any

Inherited from#

Element.type

Defined in#

packages/bpmn-server/src/elements/Element.ts:14


subType#

• subType: any

Inherited from#

Element.subType

Defined in#

packages/bpmn-server/src/elements/Element.ts:15


behaviours#

• behaviours: Map\<any, any>

Inherited from#

Element.behaviours

Defined in#

packages/bpmn-server/src/elements/Element.ts:17


isFlow#

• isFlow: boolean = false

Inherited from#

Element.isFlow

Defined in#

packages/bpmn-server/src/elements/Element.ts:18


lane#

• lane: any

Inherited from#

Element.lane

Defined in#

packages/bpmn-server/src/elements/Element.ts:19


name#

• name: string = ''

Overrides#

Element.name

Defined in#

packages/bpmn-server/src/elements/Node.ts:15


process#

• process: any

Defined in#

packages/bpmn-server/src/elements/Node.ts:16


def#

• def: any

Defined in#

packages/bpmn-server/src/elements/Node.ts:17


outbounds#

• outbounds: Flow[]

Defined in#

packages/bpmn-server/src/elements/Node.ts:18


inbounds#

• inbounds: Flow[]

Defined in#

packages/bpmn-server/src/elements/Node.ts:19


attachments#

• attachments: Node[]

Defined in#

packages/bpmn-server/src/elements/Node.ts:20


attachedTo#

• attachedTo: Node

Defined in#

packages/bpmn-server/src/elements/Node.ts:21


messageId#

• messageId: any

Defined in#

packages/bpmn-server/src/elements/Node.ts:22


signalId#

• signalId: any

Defined in#

packages/bpmn-server/src/elements/Node.ts:23


initiator#

• initiator: any

Defined in#

packages/bpmn-server/src/elements/Node.ts:24


assignee#

• assignee: any

Defined in#

packages/bpmn-server/src/elements/Node.ts:25


candidateGroups#

• candidateGroups: any

Defined in#

packages/bpmn-server/src/elements/Node.ts:26


candidateUsers#

• candidateUsers: any

Defined in#

packages/bpmn-server/src/elements/Node.ts:27


scripts#

• scripts: Map\<any, any>

Defined in#

packages/bpmn-server/src/elements/Node.ts:28

Accessors#

processId#

• get processId(): any

Returns#

any

Defined in#

packages/bpmn-server/src/elements/Node.ts:29


requiresWait#

• get requiresWait(): boolean

Returns#

boolean

Defined in#

packages/bpmn-server/src/elements/Node.ts:136


canBeInvoked#

• get canBeInvoked(): boolean

Returns#

boolean

Defined in#

packages/bpmn-server/src/elements/Node.ts:141


loopDefinition#

• get loopDefinition(): any

Returns#

any

Defined in#

packages/bpmn-server/src/elements/Node.ts:143


isCatching#

• get isCatching(): boolean

Returns#

boolean

Defined in#

packages/bpmn-server/src/elements/Node.ts:147


dataObjectNames#

• get dataObjectNames(): string[]

The data objects connected to this element by a data association, either way: their names, as the diagram shows them (the reference's name, else the data object's or data store's, else its id).

Returns#

string[]

Defined in#

packages/bpmn-server/src/elements/Node.ts:161


exceptionsAsErrors#

• get exceptionsAsErrors(): boolean

camunda:exceptionsAsErrors="true": an exception of the task's work is raised as a BPMN error.

Returns#

boolean

Defined in#

packages/bpmn-server/src/elements/Node.ts:296

Methods#

restored#

▸ restored(item): void

Parameters#

Name Type
item Item

Returns#

void

Inherited from#

Element.restored

Defined in#

packages/bpmn-server/src/elements/Element.ts:24


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#

packages/bpmn-server/src/elements/Element.ts:34


getBehaviour#

▸ getBehaviour(name): any

Parameters#

Name Type
name any

Returns#

any

Inherited from#

Element.getBehaviour

Defined in#

packages/bpmn-server/src/elements/Element.ts:38


addBehaviour#

▸ addBehaviour(nane, behavriour): void

Parameters#

Name Type
nane any
behavriour any

Returns#

void

Inherited from#

Element.addBehaviour

Defined in#

packages/bpmn-server/src/elements/Element.ts:41


validate#

▸ validate(item): Promise\<void>

Parameters#

Name Type
item Item

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/Node.ts:48


doEvent#

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

Parameters#

Name Type Default value
item Item undefined
event EXECUTION_EVENT undefined
newStatus ITEM_STATUS null
eventDetails Object {}

Returns#

Promise\<any[]>

Defined in#

packages/bpmn-server/src/elements/Node.ts:61


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#

packages/bpmn-server/src/elements/Node.ts:99


getInput#

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

Parameters#

Name Type
item Item
input any

Returns#

Promise\<{}>

Defined in#

packages/bpmn-server/src/elements/Node.ts:109


getOutput#

▸ getOutput(item): Promise\<{}>

transform data using output rules todo

Parameters#

Name Type
item Item

Returns#

Promise\<{}>

Defined in#

packages/bpmn-server/src/elements/Node.ts:123


enter#

▸ enter(item): void

Parameters#

Name Type
item Item

Returns#

void

Defined in#

packages/bpmn-server/src/elements/Node.ts:127


loadDataObjects#

▸ loadDataObjects(item): Promise\<void>

Load the element's data objects into the instance data (appDelegate.loadDataObject), where they are saved with the instance: data.client for a data object 'client'. They load each time the element runs.

Parameters#

Name Type
item Item

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/Node.ts:178


execute#

▸ execute(item): Promise\<any>

Parameters#

Name Type
item Item

Returns#

Promise\<any>

Defined in#

packages/bpmn-server/src/elements/Node.ts:194


perform#

▸ perform(item): Promise\<any>

Steps 4 and 5 of execute: the work (run), then on. Also a failed item's retry (Token.retry): the work again.

Parameters#

Name Type
item Item

Returns#

Promise\<any>

Defined in#

packages/bpmn-server/src/elements/Node.ts:260


failed#

▸ failed(item, error): Promise\<NODE_ACTION>

The task's work threw. With exceptionsAsErrors and an error event that catches it (by the exception's code, else its name; an error event with no code catches any), it is raised there as a BPMN error and the task ends. Otherwise the item's status is error, with the message, saved so the instance shows it and the item can be retried (engine.retry), and the exception is thrown to the caller as before.

Parameters#

Name Type
item Item
error any

Returns#

Promise\<NODE_ACTION>

Defined in#

packages/bpmn-server/src/elements/Node.ts:305


continue#

▸ continue(item): Promise\<void>

Parameters#

Name Type
item Item

Returns#

Promise\<void>

Overrides#

Element.continue

Defined in#

packages/bpmn-server/src/elements/Node.ts:334


start#

▸ start(item): Promise\<NODE_ACTION>

Parameters#

Name Type
item Item

Returns#

Promise\<NODE_ACTION>

Defined in#

packages/bpmn-server/src/elements/Node.ts:339


run#

▸ run(item): Promise\<NODE_ACTION>

Parameters#

Name Type
item Item

Returns#

Promise\<NODE_ACTION>

Defined in#

packages/bpmn-server/src/elements/Node.ts:349


cancelEBG#

▸ cancelEBG(item): Promise\<void>

Parameters#

Name Type
item any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/Node.ts:353


cancelBoundaryEvents#

▸ cancelBoundaryEvents(item): Promise\<void>

Parameters#

Name Type
item any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/Node.ts:361


getBoundaryEventItems#

▸ getBoundaryEventItems(item): any[]

Parameters#

Name Type
item any

Returns#

any[]

Defined in#

packages/bpmn-server/src/elements/Node.ts:399


end#

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

Parameters#

Name Type Default value
item Item undefined
cancel Boolean false

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/Node.ts:437


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#

packages/bpmn-server/src/elements/Node.ts:486


init#

▸ init(item): void

Parameters#

Name Type
item Item

Returns#

void

Defined in#

packages/bpmn-server/src/elements/Node.ts:489


getOutbounds#

▸ getOutbounds(item): Promise\<Item[]>

Parameters#

Name Type
item Item

Returns#

Promise\<Item[]>

Defined in#

packages/bpmn-server/src/elements/Node.ts:494


startBoundaryEvents#

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

Parameters#

Name Type
item any
token any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/Node.ts:527


describe#

▸ describe(): any[]

Returns#

any[]

Overrides#

Element.describe

Defined in#

packages/bpmn-server/src/elements/Node.ts:546

Comments