Package dev.dsf.bpe.v1.variables

Interface Variables

public interface Variables

Gives access to process execution variables. Includes factory methods for Target and Targets values.

Method Summary

Modifier and Type	Method	Description
default Target	createTarget(String organizationIdentifierValue, String endpointIdentifierValue, String endpointAddress)	Creates a new Target object.
Target	createTarget(String organizationIdentifierValue, String endpointIdentifierValue, String endpointAddress, String correlationKey)	Creates a new Target object.
default Targets	createTargets(Target... targets)	Creates a new target list.
Targets	createTargets(List<? extends Target> targets)	Creates a new target list.
default Boolean	getBoolean(String variableName)	Retrieves Boolean execution variable with the given variableName
default byte[]	getByteArray(String variableName)	Retrieves byte[] execution variable with the given variableName
List<org.hl7.fhir.r4.model.Task>	getCurrentTasks()
default Date	getDate(String variableName)	Retrieves Date execution variable with the given variableName
default Double	getDouble(String variableName)	Retrieves Double execution variable with the given variableName
default File	getFile(String variableName)	Retrieves File execution variable with the given variableName
default Integer	getInteger(String variableName)	Retrieves Integer execution variable with the given variableName
org.hl7.fhir.r4.model.QuestionnaireResponse	getLatestReceivedQuestionnaireResponse()
org.hl7.fhir.r4.model.Task	getLatestTask()	Returns the latest Task received by this process or subprocess via a intermediate message catch event or message receive task.
default Long	getLong(String variableName)	Retrieves Long execution variable with the given variableName
default Number	getNumber(String variableName)	Retrieves Number execution variable with the given variableName
<R extends org.hl7.fhir.r4.model.Resource> R	getResource(String variableName)	Retrieves FHIR Resource execution variable with the given variableName
<R extends org.hl7.fhir.r4.model.Resource> List<R>	getResourceList(String variableName)	Retrieves FHIR Resource list execution variable with the given variableName
default Short	getShort(String variableName)	Retrieves Short execution variable with the given variableName
org.hl7.fhir.r4.model.Task	getStartTask()	Returns the Task associated with the message start event of the process.
default String	getString(String variableName)	Retrieves String execution variable with the given variableName
Target	getTarget()	Retrieves execution variable BpmnExecutionVariables.TARGET
Targets	getTargets()	Retrieves execution variable BpmnExecutionVariables.TARGETS
List<org.hl7.fhir.r4.model.Task>	getTasks()
Object	getVariable(String variableName)	Retrieves execution variable with the given variableName
void	setAlternativeBusinessKey(String alternativeBusinessKey)	Sets execution variable BpmnExecutionVariables.ALTERNATIVE_BUSINESS_KEY
default void	setBoolean(String variableName, Boolean value)	Sets execution variable with the given variableName to the given Boolean
default void	setByteArray(String variableName, byte[] value)	Sets execution variable with the given variableName to the given byte[]
default void	setDate(String variableName, Date value)	Sets execution variable with the given variableName to the given Date
default void	setDouble(String variableName, Double value)	Sets execution variable with the given variableName to the given Double
default void	setFile(String variableName, File value)	Sets execution variable with the given variableName to the given File
default void	setInteger(String variableName, Integer value)	Sets execution variable with the given variableName to the given Integer
default void	setLong(String variableName, Long value)	Sets execution variable with the given variableName to the given Long
default void	setNumber(String variableName, Number value)	Sets execution variable with the given variableName to the given Number
void	setResource(String variableName, org.hl7.fhir.r4.model.Resource resource)	Sets execution variable with the given variableName to the given FHIR Resource
void	setResourceList(String variableName, List<? extends org.hl7.fhir.r4.model.Resource> resources)	Sets execution variable with the given variableName to the given FHIR Resource list
default void	setShort(String variableName, Short value)	Sets execution variable with the given variableName to the given Short
default void	setString(String variableName, String value)	Sets execution variable with the given variableName to the given String
void	setTarget(Target target)	Sets execution variable BpmnExecutionVariables.TARGET
void	setTargets(Targets targets)	Sets execution variable BpmnExecutionVariables.TARGETS.
void	setVariable(String variableName, org.camunda.bpm.engine.variable.value.TypedValue value)	Sets execution variable with the given variableName to the given TypedValue
void	updateTask(org.hl7.fhir.r4.model.Task task)	Does nothing if the given task is null.

Method Details

setAlternativeBusinessKey

void setAlternativeBusinessKey(String alternativeBusinessKey)

Sets execution variable BpmnExecutionVariables.ALTERNATIVE_BUSINESS_KEY

Parameters:

alternativeBusinessKey - may be null

createTarget

Target createTarget(String organizationIdentifierValue,
 String endpointIdentifierValue,
 String endpointAddress,
 String correlationKey)

Creates a new Target object.

A not null correlationKey should be used if return messages aka. Task resources from multiple organizations with the same message-name are expected in a following multi instance message receive task or intermediate message catch event in a multi instance subprocess.
Note: The correlationKey needs to be set as a BpmnExecutionVariables.CORRELATION_KEY variable in the message receive task or intermediate message catch event of a subprocess before incoming messages aka. Task resources can be correlated. Within a BPMN file this can be accomplished by setting an input variable with name: BpmnExecutionVariables.CORRELATION_KEY, type: string or expression, and value: ${target.correlationKey}.

A not null correlationKey should also be used when sending a message aka. Task resource back to an organization waiting for multiple returns.

Parameters:

organizationIdentifierValue - not null

endpointIdentifierValue - not null

endpointAddress - not null

correlationKey - not null if used for sending multiple messages and multiple messages with the same message-name are expected in return

Returns:

new Target object

See Also:

• createTarget(String, String, String)
• setTarget(Target)

createTarget

default Target createTarget(String organizationIdentifierValue,
 String endpointIdentifierValue,
 String endpointAddress)

Creates a new Target object. See createTarget(String, String, String, String) for sending a correlation-key for 1:n or n:1 relationships.

Parameters:

organizationIdentifierValue - not null

endpointIdentifierValue - not null

endpointAddress - not null

Returns:

new Target object

See Also:

• createTarget(String, String, String, String)
• setTarget(Target)

setTarget

void setTarget(Target target)
        throws IllegalArgumentException

Sets execution variable BpmnExecutionVariables.TARGET

Parameters:

target - may be null

Throws:

IllegalArgumentException - if the given target object is not supported, meaning the object was not created by this Variables implementation

See Also:

• createTarget(String, String, String)
• createTarget(String, String, String, String)
• getTarget()

getTarget

Target getTarget()

Retrieves execution variable BpmnExecutionVariables.TARGET

Returns:

Execution variable BpmnExecutionVariables.TARGET, may be null

createTargets

default Targets createTargets(Target... targets)

Creates a new target list. Use ${targets.entries} as a multi instance collection and target as the element variable to loop over this list in a multi instance task or subprocess.

Parameters:

targets - Target objects to incorporate into the created list

Returns:

a new target list

Throws:

IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by this Variables implementation

See Also:

• createTarget(String, String, String)
• createTarget(String, String, String, String)
• setTargets(Targets)

createTargets

Targets createTargets(List<? extends Target> targets)

Creates a new target list. Use ${targets.entries} as a multi instance collection and target as the element variable to loop over this list in a multi instance task or subprocess.

Parameters:

targets - Target objects to incorporate into the created list, may be null

Returns:

a new target list

Throws:

IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by this Variables implementation

See Also:

• createTarget(String, String, String)
• createTarget(String, String, String, String)
• setTargets(Targets)

setTargets

void setTargets(Targets targets)

Sets execution variable BpmnExecutionVariables.TARGETS. Use ${targets.entries} as a multi instance collection and

Parameters:

targets - may be null

See Also:

• createTargets(List)
• createTargets(Target...)
• getTargets()

getTargets

Targets getTargets()

Retrieves execution variable BpmnExecutionVariables.TARGETS

Returns:

Execution variable BpmnExecutionVariables.TARGETS, may be null

See Also:

• setTargets(Targets)

setResourceList

void setResourceList(String variableName,
 List<? extends org.hl7.fhir.r4.model.Resource> resources)

Sets execution variable with the given variableName to the given FHIR Resource list

Parameters:

variableName - not null

resources -

getResourceList

<R extends org.hl7.fhir.r4.model.Resource> List<R> getResourceList(String variableName)

Retrieves FHIR Resource list execution variable with the given variableName

Type Parameters:

R - FHIR resource type

Parameters:

variableName - not null

Returns:

list of FHIR resources from execution variables for the given variableName, may be null

setResource

void setResource(String variableName,
 org.hl7.fhir.r4.model.Resource resource)

Sets execution variable with the given variableName to the given FHIR Resource

Parameters:

variableName - not null

resource - may be null

getResource

<R extends org.hl7.fhir.r4.model.Resource> R getResource(String variableName)

Retrieves FHIR Resource execution variable with the given variableName

Type Parameters:

R - FHIR resource type

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

getStartTask

org.hl7.fhir.r4.model.Task getStartTask()

Returns the Task associated with the message start event of the process.

Returns:

Task that started the process instance, not null

See Also:

• updateTask(Task)
• getLatestTask()
• getTasks()

getLatestTask

org.hl7.fhir.r4.model.Task getLatestTask()

Returns the latest Task received by this process or subprocess via a intermediate message catch event or message receive task.

Returns:

Last received Task of the current process or subprocess, not null

See Also:

• updateTask(Task)
• getStartTask()
• getCurrentTasks()

getTasks

List<org.hl7.fhir.r4.model.Task> getTasks()

Returns:

All Task resources received

See Also:

• getCurrentTasks()

getCurrentTasks

List<org.hl7.fhir.r4.model.Task> getCurrentTasks()

Returns:

All Task resources received by the current process or subprocess

See Also:

• getTasks()

updateTask

void updateTask(org.hl7.fhir.r4.model.Task task)

Does nothing if the given task is null. Forces an update to the Task list variable used internally to track all received Task resources if the given task object is already part of this list.

Parameters:

task - may be null

See Also:

• getStartTask()
• getLatestTask()
• getTasks()
• getCurrentTasks()

getLatestReceivedQuestionnaireResponse

org.hl7.fhir.r4.model.QuestionnaireResponse getLatestReceivedQuestionnaireResponse()

Returns:

Last received QuestionnaireResponse, null if nothing received yet

setVariable

void setVariable(String variableName,
 org.camunda.bpm.engine.variable.value.TypedValue value)

Sets execution variable with the given variableName to the given TypedValue

Parameters:

variableName - not null

value - may be null

See Also:

• getVariable(String)
• setInteger(String, Integer)
• setString(String, String)
• setBoolean(String, Boolean)
• setByteArray(String, byte[])
• setDate(String, Date)
• setLong(String, Long)
• setShort(String, Short)
• setDouble(String, Double)
• setNumber(String, Number)
• setFile(String, File)

getVariable

Object getVariable(String variableName)

Retrieves execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

See Also:

• setVariable(String, TypedValue)
• getInteger(String)
• getString(String)
• getBoolean(String)
• getByteArray(String)
• getDate(String)
• getLong(String)
• getShort(String)
• getDouble(String)
• getNumber(String)
• getFile(String)

setInteger

default void setInteger(String variableName,
 Integer value)

Sets execution variable with the given variableName to the given Integer

Parameters:

variableName - not null

value - may be null

See Also:

• getInteger(String)
• setVariable(String, TypedValue)

getInteger

default Integer getInteger(String variableName)

Retrieves Integer execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a Integer

See Also:

• setInteger(String, Integer)
• getVariable(String)

setString

default void setString(String variableName,
 String value)

Sets execution variable with the given variableName to the given String

Parameters:

variableName - not null

value - may be null

See Also:

• getString(String)
• setVariable(String, TypedValue)

getString

default String getString(String variableName)

Retrieves String execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a String

See Also:

• setString(String, String)
• getVariable(String)

setBoolean

default void setBoolean(String variableName,
 Boolean value)

Sets execution variable with the given variableName to the given Boolean

Parameters:

variableName - not null

value - may be null

See Also:

• getBoolean(String)
• setVariable(String, TypedValue)

getBoolean

default Boolean getBoolean(String variableName)

Retrieves Boolean execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a Boolean

See Also:

• setBoolean(String, Boolean)
• getVariable(String)

setByteArray

default void setByteArray(String variableName,
 byte[] value)

Sets execution variable with the given variableName to the given byte[]

Parameters:

variableName - not null

value - may be null

See Also:

• getByteArray(String)
• setVariable(String, TypedValue)

getByteArray

default byte[] getByteArray(String variableName)

Retrieves byte[] execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a byte[]

See Also:

• setByteArray(String, byte[])
• getVariable(String)

setDate

default void setDate(String variableName,
 Date value)

Sets execution variable with the given variableName to the given Date

Parameters:

variableName - not null

value - may be null

See Also:

• getDate(String)
• setVariable(String, TypedValue)

getDate

default Date getDate(String variableName)

Retrieves Date execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a Date

See Also:

• setDate(String, Date)
• getVariable(String)

setLong

default void setLong(String variableName,
 Long value)

Sets execution variable with the given variableName to the given Long

Parameters:

variableName - not null

value - may be null

See Also:

• getLong(String)
• setVariable(String, TypedValue)

getLong

default Long getLong(String variableName)

Retrieves Long execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a Long

See Also:

• setLong(String, Long)
• getVariable(String)

setShort

default void setShort(String variableName,
 Short value)

Sets execution variable with the given variableName to the given Short

Parameters:

variableName - not null

value - may be null

See Also:

• getShort(String)
• setVariable(String, TypedValue)

getShort

default Short getShort(String variableName)

Retrieves Short execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a Short

See Also:

• setShort(String, Short)
• getVariable(String)

setDouble

default void setDouble(String variableName,
 Double value)

Sets execution variable with the given variableName to the given Double

Parameters:

variableName - not null

value - may be null

See Also:

• getDouble(String)
• setVariable(String, TypedValue)

getDouble

default Double getDouble(String variableName)

Retrieves Double execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a Double

See Also:

• setDouble(String, Double)
• getVariable(String)

setNumber

default void setNumber(String variableName,
 Number value)

Sets execution variable with the given variableName to the given Number

Parameters:

variableName - not null

value - may be null

See Also:

• getNumber(String)
• setVariable(String, TypedValue)

getNumber

default Number getNumber(String variableName)

Retrieves Number execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a Number

See Also:

• setNumber(String, Number)
• getVariable(String)

setFile

default void setFile(String variableName,
 File value)

Sets execution variable with the given variableName to the given File

Parameters:

variableName - not null

value - may be null

See Also:

• getFile(String)
• setVariable(String, TypedValue)

getFile

default File getFile(String variableName)

Retrieves File execution variable with the given variableName

Parameters:

variableName - not null

Returns:

value from execution variables for the given variableName, may be null

Throws:

ClassCastException - if the stored value is not a File

See Also:

• setFile(String, File)
• getVariable(String)