ServiceTask

Contents

bpmn-server / ServiceTask

Class: ServiceTask

     foo[method]();

     await this.token.appDelegate[serviceName](data);

     service signature:
             output= service (input,context)

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Parameters

Name Type
id any
process any
type any
def any

Returns

ServiceTask

Inherited from

Node.constructor

Defined in

elements/Node.ts:32

Properties

id

id: any

Inherited from

Node.id

Defined in

elements/Element.ts:13


type

type: any

Inherited from

Node.type

Defined in

elements/Element.ts:14


subType

subType: any

Inherited from

Node.subType

Defined in

elements/Element.ts:15


behaviours

behaviours: Map<any, any>

Inherited from

Node.behaviours

Defined in

elements/Element.ts:17


isFlow

isFlow: boolean = false

Inherited from

Node.isFlow

Defined in

elements/Element.ts:18


lane

lane: any

Inherited from

Node.lane

Defined in

elements/Element.ts:19


name

name: any

Inherited from

Node.name

Defined in

elements/Node.ts:13


process

process: any

Inherited from

Node.process

Defined in

elements/Node.ts:14


def

def: any

Inherited from

Node.def

Defined in

elements/Node.ts:15


outbounds

outbounds: Flow[]

Inherited from

Node.outbounds

Defined in

elements/Node.ts:16


inbounds

inbounds: Flow[]

Inherited from

Node.inbounds

Defined in

elements/Node.ts:17


attachments

attachments: Node[]

Inherited from

Node.attachments

Defined in

elements/Node.ts:18


attachedTo

attachedTo: Node

Inherited from

Node.attachedTo

Defined in

elements/Node.ts:19


messageId

messageId: any

Inherited from

Node.messageId

Defined in

elements/Node.ts:20


signalId

signalId: any

Inherited from

Node.signalId

Defined in

elements/Node.ts:21


initiator

initiator: any

Inherited from

Node.initiator

Defined in

elements/Node.ts:22


assignee

assignee: any

Inherited from

Node.assignee

Defined in

elements/Node.ts:23


candidateGroups

candidateGroups: any

Inherited from

Node.candidateGroups

Defined in

elements/Node.ts:24


candidateUsers

candidateUsers: any

Inherited from

Node.candidateUsers

Defined in

elements/Node.ts:25


scripts

scripts: Map<any, any>

Inherited from

Node.scripts

Defined in

elements/Node.ts:26

Accessors

processId

get processId(): any

Returns

any

Inherited from

Node.processId

Defined in

elements/Node.ts:27


requiresWait

get requiresWait(): boolean

Returns

boolean

Inherited from

Node.requiresWait

Defined in

elements/Node.ts:123


canBeInvoked

get canBeInvoked(): boolean

Returns

boolean

Inherited from

Node.canBeInvoked

Defined in

elements/Node.ts:128


isCatching

get isCatching(): boolean

Returns

boolean

Inherited from

Node.isCatching

Defined in

elements/Node.ts:130


serviceName

get serviceName(): any

Returns

any

Defined in

elements/Tasks.ts:38

Methods

restored

restored(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

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

Node.hasBehaviour

Defined in

elements/Element.ts:34


getBehaviour

getBehaviour(name): any

Parameters

Name Type
name any

Returns

any

Inherited from

Node.getBehaviour

Defined in

elements/Element.ts:38


addBehaviour

addBehaviour(nane, behavriour): void

Parameters

Name Type
nane any
behavriour any

Returns

void

Inherited from

Node.addBehaviour

Defined in

elements/Element.ts:41


validate

validate(item): Promise<void>

Parameters

Name Type
item Item

Returns

Promise<void>

Inherited from

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

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

Node.setInput

Defined in

elements/Node.ts:86


getInput

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

Parameters

Name Type
item Item
input any

Returns

Promise<{}>

Inherited from

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

Node.getOutput

Defined in

elements/Node.ts:110


enter

enter(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

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

Node.execute

Defined in

elements/Node.ts:140


continue

continue(item): Promise<void>

Parameters

Name Type
item Item

Returns

Promise<void>

Inherited from

Node.continue

Defined in

elements/Node.ts:213


start

start(item): Promise<NODE_ACTION>

Parameters

Name Type
item Item

Returns

Promise<NODE_ACTION>

Inherited from

Node.start

Defined in

elements/Node.ts:218


cancelEBG

cancelEBG(item): Promise<void>

Parameters

Name Type
item any

Returns

Promise<void>

Inherited from

Node.cancelEBG

Defined in

elements/Node.ts:232


cancelBoundaryEvents

cancelBoundaryEvents(item): Promise<void>

Parameters

Name Type
item any

Returns

Promise<void>

Inherited from

Node.cancelBoundaryEvents

Defined in

elements/Node.ts:240


end

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

Parameters

Name Type Default value
item Item undefined
cancel Boolean false

Returns

Promise<void>

Inherited from

Node.end

Defined in

elements/Node.ts:273


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

Node.resume

Defined in

elements/Node.ts:308


init

init(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Node.init

Defined in

elements/Node.ts:311


getOutbounds

getOutbounds(item): Item[]

Parameters

Name Type
item Item

Returns

Item[]

Inherited from

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

Node.startBoundaryEvents

Defined in

elements/Node.ts:335


run

run(item): Promise<NODE_ACTION>

Parameters

Name Type
item any

Returns

Promise<NODE_ACTION>

Overrides

Node.run

Defined in

elements/Tasks.ts:47


describe

describe(): any[]

Returns

any[]

Overrides

Node.describe

Defined in

elements/Tasks.ts:94