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[]

Inherited from#

Gateway.dataObjectNames

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

Inherited from#

Gateway.exceptionsAsErrors

Defined in#

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

Methods#

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#

Gateway.hasBehaviour

Defined in#

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

getBehaviour#

▸ getBehaviour(name): any

Parameters#

Name	Type
`name`	`any`

Returns#

any

Inherited from#

Gateway.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#

Gateway.addBehaviour

Defined in#

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

getOutbounds#

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

Parameters#

Name	Type
`item`	`Item`

Returns#

Promise\<Item[]>

Inherited from#

Gateway.getOutbounds

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:36

choose#

▸ choose(held, item): Item[]

Which of its flows the gateway takes, of those that hold (an exclusive gateway: one).

Parameters#

Name	Type
`held`	`Item`[]
`item`	`Item`

Returns#

Item[]

Inherited from#

Gateway.choose

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:44

explain#

▸ explain(item, held, chosen): void

The decision in words, for the instance's log: the flows taken and why, for a gateway that chooses.

Parameters#

Name	Type
`item`	`Item`
`held`	`Item`[]
`chosen`	`Item`[]

Returns#

void

Inherited from#

Gateway.explain

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:49

flowsThatHold#

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

The outgoing flows whose conditions hold; the default flow when none does.

Parameters#

Name	Type
`item`	`Item`

Returns#

Promise\<Item[]>

Inherited from#

Gateway.flowsThatHold

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:71

getPotentialPath#

▸ getPotentialPath(node, path?): any

Parameters#

Name	Type	Default value
`node`	`any`	`undefined`
`path`	`any`	`null`

Returns#

any

Inherited from#

Gateway.getPotentialPath

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:101

canReach#

▸ canReach(node, target): any

Parameters#

Name	Type
`node`	`any`
`target`	`any`

Returns#

any

Inherited from#

Gateway.canReach

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:115

getRelatedTokens#

▸ getRelatedTokens(item): any[]

Parameters#

Name	Type
`item`	`Item`

Returns#

any[]

Inherited from#

Gateway.getRelatedTokens

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:125

analyzeConvergingTokens#

▸ analyzeConvergingTokens(item): Object

Parameters#

Name	Type
`item`	`Item`

Returns#

Object

Name	Type
`pendingTokens`	`Token`[]
`waitingTokens`	`Token`[]

Inherited from#

Gateway.analyzeConvergingTokens

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:170

start#

▸ start(item): Promise\<NODE_ACTION>

Parameters#

Name	Type
`item`	`Item`

Returns#

Promise\<NODE_ACTION>

Inherited from#

Gateway.start

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:199

restored#

▸ restored(item): void

Parameters#

Name	Type
`item`	`Item`

Returns#

void

Overrides#

Gateway.restored

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:354

run#

▸ run(item): Promise\<NODE_ACTION>

Parameters#

Name	Type
`item`	`Item`

Returns#

Promise\<NODE_ACTION>

Overrides#

Gateway.run

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:357

cancelAllBranched#

▸ cancelAllBranched(endingItem): Promise\<void>

Parameters#

Name	Type
`endingItem`	`Item`

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/Gateway.ts:360

validate#

▸ validate(item): Promise\<void>

Parameters#

Name	Type
`item`	`Item`

Returns#

Promise\<void>

Inherited from#

Gateway.validate

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[]>

Inherited from#

Gateway.doEvent

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>

Inherited from#

Gateway.setInput

Defined in#

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

getInput#

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

Parameters#

Name	Type
`item`	`Item`
`input`	`any`

Returns#

Promise\<{}>

Inherited from#

Gateway.getInput

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\<{}>

Inherited from#

Gateway.getOutput

Defined in#

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

enter#

▸ enter(item): void

Parameters#

Name	Type
`item`	`Item`

Returns#

void

Inherited from#

Gateway.enter

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>

Inherited from#

Gateway.loadDataObjects

Defined in#

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

execute#

▸ execute(item): Promise\<any>

Parameters#

Name	Type
`item`	`Item`

Returns#

Promise\<any>

Inherited from#

Gateway.execute

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>

Inherited from#

Gateway.perform

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.