TimerBehaviour

Contents

bpmn-server / TimerBehaviour

Class: TimerBehaviour

Behaviour
ioSpecification
timer
message
signal

each behaviour is a class
it scans def and insert itself to perform actions as required

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new TimerBehaviour(node, definition): TimerBehaviour

Parameters

Name Type
node Node
definition any

Returns

TimerBehaviour

Inherited from

Behaviour.constructor

Defined in

elements/behaviours/Behaviour.ts:40

Properties

node

node: Node

Inherited from

Behaviour.node

Defined in

elements/behaviours/Behaviour.ts:38


definition

definition: any

Inherited from

Behaviour.definition

Defined in

elements/behaviours/Behaviour.ts:39


duration

duration: any

Defined in

elements/behaviours/Timer.ts:55


repeat

repeat: number = 1

Defined in

elements/behaviours/Timer.ts:56


timeCycle

timeCycle: any

Defined in

elements/behaviours/Timer.ts:57


timeDate

timeDate: any

Defined in

elements/behaviours/Timer.ts:58

Methods

restored

restored(item): void

Parameters

Name Type
item any

Returns

void

Inherited from

Behaviour.restored

Defined in

elements/behaviours/Behaviour.ts:45


enter

enter(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Behaviour.enter

Defined in

elements/behaviours/Behaviour.ts:48


run

run(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Behaviour.run

Defined in

elements/behaviours/Behaviour.ts:50


exit

exit(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Behaviour.exit

Defined in

elements/behaviours/Behaviour.ts:52


getNodeAttributes

getNodeAttributes(attributes): void

Parameters

Name Type
attributes any[]

Returns

void

Inherited from

Behaviour.getNodeAttributes

Defined in

elements/behaviours/Behaviour.ts:54


getItemAttributes

getItemAttributes(item, attributes): void

Parameters

Name Type
item Item
attributes any[]

Returns

void

Inherited from

Behaviour.getItemAttributes

Defined in

elements/behaviours/Behaviour.ts:55


init

init(): void

Returns

void

Overrides

Behaviour.init

Defined in

elements/behaviours/Timer.ts:59


describe

describe(): string[][]

Returns

string[][]

Overrides

Behaviour.describe

Defined in

elements/behaviours/Timer.ts:82


timeDue

timeDue(item, timerModifier?): any

return the next time the timer is due
format is time format

Parameters

Name Type Default value Description
item any undefined
timerModifier any null for testing purposes configuration can alter the timer

Returns

any

Defined in

elements/behaviours/Timer.ts:99


getRepeat

getRepeat(input): any

Parameters

Name Type
input any

Returns

any

Defined in

elements/behaviours/Timer.ts:129


start

start(item): NODE_ACTION

Parameters

Name Type
item Item

Returns

NODE_ACTION

Overrides

Behaviour.start

Defined in

elements/behaviours/Timer.ts:137


startTimer

startTimer(item): void

Parameters

Name Type
item any

Returns

void

Defined in

elements/behaviours/Timer.ts:148


expires

expires(): Promise<void>

Returns

Promise<void>

Defined in

elements/behaviours/Timer.ts:166


end

end(item): void

Parameters

Name Type
item Item

Returns

void

Overrides

Behaviour.end

Defined in

elements/behaviours/Timer.ts:202


resume

resume(): void

Returns

void

Overrides

Behaviour.resume

Defined in

elements/behaviours/Timer.ts:206