com.mendix.core.actionmanagement

Interface MicroflowCallBuilder

public interface MicroflowCallBuilder

Provides a builder for building a microflow call. The builder can be used to add arguments and eventually call the microflow.

Method Summary

Modifier and Type	Method and Description
void	executeInBackground(IContext context, java.lang.String queueName) This API call is experimental and should not be used! It will not work without explicitly enabling background processing.
MicroflowCallBuilder	withParam(java.lang.String name, java.lang.Object value) Adds a parameter with the specified name and value to the microflow call.
default MicroflowCallBuilder	withParams(java.util.Map<java.lang.String,java.lang.Object> params) Adds multiples parameters to the microflow call.

Method Detail

withParam

MicroflowCallBuilder withParam(java.lang.String name,
                               java.lang.Object value)

Adds a parameter with the specified name and value to the microflow call.

Parameters:

name - the name of the parameter to add

value - the value of the parameter to add

Returns:

the updated builder

withParams

default MicroflowCallBuilder withParams(java.util.Map<java.lang.String,java.lang.Object> params)

Adds multiples parameters to the microflow call.

Parameters:

params - the parameters to add

Returns:

the updated builder

executeInBackground

void executeInBackground(IContext context,
                         java.lang.String queueName)

This API call is experimental and should not be used! It will not work without explicitly enabling background processing. Executes the microflow in the background. This method only schedules the microflow to be executed and returns immediately. The microflow will executed as soon as possible, depending on the queue in which it is inserted. Because the microflow is executed in the background there is no return value. The microflow will be executed in its own context for the same user as the specified context.

Parameters:

context - the context in which to schedule the microflow call

queueName - the name of the queue in which to insert the microflow call