Module io.automatiko.engine.api

Package io.automatiko.engine.api.workflow

Interface VariableAugmentor

public interface VariableAugmentor

Variable augmentor allows to perform modification to the variable bfore it is added to variable scope instance. This usually acts like a interceptor to be able to change variable value structure for example moving binary data of a file to data store to offload the instance storage from big data sets

Method Summary

Modifier and Type	Method	Description
boolean	accept(Variable variable, Object value)	Determines if given augmentor is capable of working on given values
Object	augmentOnCreate(String processId, String processVersion, String processInstanceId, Variable variable, Object value)	Invoked when variable is going to be created for the first time
void	augmentOnDelete(String processId, String processVersion, String processInstanceId, Variable variable, Object value)	Invoked when variable is going to be removed
Object	augmentOnUpdate(String processId, String processVersion, String processInstanceId, Variable variable, Object value)	Invoked when variable is going to be updated

Method Details

accept

boolean accept(Variable variable,
 Object value)

Determines if given augmentor is capable of working on given values

Parameters:

variable - variable definition

value - value of the variable to be set/updated/removed

Returns:

true if it can process it otherwise false

augmentOnCreate

Object augmentOnCreate(String processId,
 String processVersion,
 String processInstanceId,
 Variable variable,
 Object value)

Invoked when variable is going to be created for the first time

Parameters:

processId - identifier of the process definition

processVersion - version of the process definition

processInstanceId - instance identifier of the process instance

variable - variable definition

value - value to be set

augmentOnUpdate

Object augmentOnUpdate(String processId,
 String processVersion,
 String processInstanceId,
 Variable variable,
 Object value)

Invoked when variable is going to be updated

Parameters:

processId - identifier of the process definition

processVersion - version of the process definition

processInstanceId - instance identifier of the process instance

variable - variable definition

value - value to be updated

augmentOnDelete

void augmentOnDelete(String processId,
 String processVersion,
 String processInstanceId,
 Variable variable,
 Object value)

Invoked when variable is going to be removed

Parameters:

processId - identifier of the process definition

processVersion - version of the process definition

processInstanceId - instance identifier of the process instance

variable - variable definition

value - value to be removed