brainslug.flow.context

Interface BrainslugContext

public interface BrainslugContext

The BrainslugContext is the main configuration and interface for the execution of flow definitions.

Method Summary

Modifier and Type	Method and Description
BrainslugContext	addFlowDefinition(FlowDefinition flowDefinition) add a flow definition to the definition store to make it executable
Collection<FlowDefinition>	getDefinitions()
BrainslugContext	start() start the async schedulers (if enabled)
Identifier	startFlow(Identifier definitionId, Identifier startNodeId) start the flow at the given startNodeId
Identifier	startFlow(Identifier definitionId, Identifier startNodeId, ExecutionProperties properties) start the flow at the given startNodeId
BrainslugContext	stop() stop the async schedulers (if enabled)
void	trigger(TriggerContext context) trigger a node in a given instance and definition for further exeution

Method Detail

addFlowDefinition

BrainslugContext addFlowDefinition(FlowDefinition flowDefinition)

add a flow definition to the definition store to make it executable

Parameters:

flowDefinition - the flow definition to add

Returns:

context with added store

getDefinitions

Collection<FlowDefinition> getDefinitions()

Returns:

the stored flow definitions from the definition store

trigger

void trigger(TriggerContext context)

trigger a node in a given instance and definition for further exeution

Parameters:

context - the definition of the trigger environment

startFlow

Identifier startFlow(Identifier definitionId,
                     Identifier startNodeId)

start the flow at the given startNodeId

Parameters:

definitionId - the definition to be started

startNodeId - the node in the definition to start at

Returns:

id of the instance

startFlow

Identifier startFlow(Identifier definitionId,
                     Identifier startNodeId,
                     ExecutionProperties properties)

start the flow at the given startNodeId

Parameters:

definitionId - the definition to be started

startNodeId - the node in the definition to start at

properties - the properties to be available during execution

Returns:

id of the instance

start

BrainslugContext start()

start the async schedulers (if enabled)

Returns:

BrainslugContext with schedulers started

stop

BrainslugContext stop()

stop the async schedulers (if enabled)

Returns:

BrainslugContext with schedulers stopped