StartEvent

Contents

bpmn-server / StartEvent

Class: StartEvent

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new StartEvent(id, process, type, def): StartEvent

Parameters

Name Type
id any
process any
type any
def any

Returns

StartEvent

Overrides

Event.constructor

Defined in

elements/Events.ts:119

Properties

id

id: any

Inherited from

Event.id

Defined in

elements/Element.ts:13


type

type: any

Inherited from

Event.type

Defined in

elements/Element.ts:14


subType

subType: any

Inherited from

Event.subType

Defined in

elements/Element.ts:15


behaviours

behaviours: Map<any, any>

Inherited from

Event.behaviours

Defined in

elements/Element.ts:17


isFlow

isFlow: boolean = false

Inherited from

Event.isFlow

Defined in

elements/Element.ts:18


lane

lane: any

Inherited from

Event.lane

Defined in

elements/Element.ts:19


name

name: any

Inherited from

Event.name

Defined in

elements/Node.ts:13


process

process: any

Inherited from

Event.process

Defined in

elements/Node.ts:14


def

def: any

Inherited from

Event.def

Defined in

elements/Node.ts:15


outbounds

outbounds: Flow[]

Inherited from

Event.outbounds

Defined in

elements/Node.ts:16


inbounds

inbounds: Flow[]

Inherited from

Event.inbounds

Defined in

elements/Node.ts:17


attachments

attachments: Node[]

Inherited from

Event.attachments

Defined in

elements/Node.ts:18


attachedTo

attachedTo: Node

Inherited from

Event.attachedTo

Defined in

elements/Node.ts:19


messageId

messageId: any

Inherited from

Event.messageId

Defined in

elements/Node.ts:20


signalId

signalId: any

Inherited from

Event.signalId

Defined in

elements/Node.ts:21


initiator

initiator: any

Inherited from

Event.initiator

Defined in

elements/Node.ts:22


assignee

assignee: any

Inherited from

Event.assignee

Defined in

elements/Node.ts:23


candidateGroups

candidateGroups: any

Inherited from

Event.candidateGroups

Defined in

elements/Node.ts:24


candidateUsers

candidateUsers: any

Inherited from

Event.candidateUsers

Defined in

elements/Node.ts:25


scripts

scripts: Map<any, any>

Inherited from

Event.scripts

Defined in

elements/Node.ts:26

Accessors

canBeInvoked

get canBeInvoked(): boolean

Returns

boolean

Inherited from

Event.canBeInvoked

Defined in

elements/Events.ts:32


isCatching

get isCatching(): boolean

Returns

boolean

Overrides

Event.isCatching

Defined in

elements/Events.ts:136


processId

get processId(): any

Returns

any

Inherited from

Event.processId

Defined in

elements/Node.ts:27


requiresWait

get requiresWait(): boolean

Returns

boolean

Inherited from

Event.requiresWait

Defined in

elements/Node.ts:123

Methods

restored

restored(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Event.restored

Defined in

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

Event.hasBehaviour

Defined in

elements/Element.ts:34


getBehaviour

getBehaviour(name): any

Parameters

Name Type
name any

Returns

any

Inherited from

Event.getBehaviour

Defined in

elements/Element.ts:38


addBehaviour

addBehaviour(nane, behavriour): void

Parameters

Name Type
nane any
behavriour any

Returns

void

Inherited from

Event.addBehaviour

Defined in

elements/Element.ts:41


hasMessage

hasMessage(): any

Returns

any

Inherited from

Event.hasMessage

Defined in

elements/Events.ts:9


hasSignal

hasSignal(): any

Returns

any

Inherited from

Event.hasSignal

Defined in

elements/Events.ts:12


hasTimer

hasTimer(): any

Returns

any

Inherited from

Event.hasTimer

Defined in

elements/Events.ts:15


end

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

Parameters

Name Type Default value
item Item undefined
cancel Boolean false

Returns

Promise<void>

Inherited from

Event.end

Defined in

elements/Events.ts:28


start

start(item): Promise<NODE_ACTION>

using token: check if fromEventBasedGateway; if yes cancel all other events

Parameters

Name Type
item Item

Returns

Promise<NODE_ACTION>

Overrides

Event.start

Defined in

elements/Events.ts:127


validate

validate(item): Promise<void>

Parameters

Name Type
item Item

Returns

Promise<void>

Inherited from

Event.validate

Defined in

elements/Node.ts:45


doEvent

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

Parameters

Name Type
item Item
event EXECUTION_EVENT
newStatus ITEM_STATUS

Returns

Promise<any[]>

Inherited from

Event.doEvent

Defined in

elements/Node.ts:58


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

Event.setInput

Defined in

elements/Node.ts:86


getInput

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

Parameters

Name Type
item Item
input any

Returns

Promise<{}>

Inherited from

Event.getInput

Defined in

elements/Node.ts:96


getOutput

getOutput(item): Promise<{}>

transform data using output rules
todo

Parameters

Name Type
item Item

Returns

Promise<{}>

Inherited from

Event.getOutput

Defined in

elements/Node.ts:110


enter

enter(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Event.enter

Defined in

elements/Node.ts:114


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>

Inherited from

Event.execute

Defined in

elements/Node.ts:140


continue

continue(item): Promise<void>

Parameters

Name Type
item Item

Returns

Promise<void>

Inherited from

Event.continue

Defined in

elements/Node.ts:213


run

run(item): Promise<NODE_ACTION>

Parameters

Name Type
item Item

Returns

Promise<NODE_ACTION>

Inherited from

Event.run

Defined in

elements/Node.ts:228


cancelEBG

cancelEBG(item): Promise<void>

Parameters

Name Type
item any

Returns

Promise<void>

Inherited from

Event.cancelEBG

Defined in

elements/Node.ts:232


cancelBoundaryEvents

cancelBoundaryEvents(item): Promise<void>

Parameters

Name Type
item any

Returns

Promise<void>

Inherited from

Event.cancelBoundaryEvents

Defined in

elements/Node.ts:240


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

Inherited from

Event.resume

Defined in

elements/Node.ts:308


init

init(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Event.init

Defined in

elements/Node.ts:311


getOutbounds

getOutbounds(item): Item[]

Parameters

Name Type
item Item

Returns

Item[]

Inherited from

Event.getOutbounds

Defined in

elements/Node.ts:316


startBoundaryEvents

startBoundaryEvents(item, token): Promise<void>

Parameters

Name Type
item any
token any

Returns

Promise<void>

Inherited from

Event.startBoundaryEvents

Defined in

elements/Node.ts:335


describe

describe(): any[]

Returns

any[]

Inherited from

Event.describe

Defined in

elements/Node.ts:346