Package com.mendix.core.actionmanagement

Interface MicroflowCallBuilder

All Superinterfaces:

ActionCallBuilder

public interface MicroflowCallBuilder
extends ActionCallBuilder

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	Description
MicroflowCallBuilder	inTransaction(boolean executeInTransaction)	Specifies whether the microflow should be called in a transaction scope.
MicroflowCallBuilder	withExponentialRetry(int numberOfAttempts, java.time.Duration initialInterval)	Performs the specified number of retries if the execution of the action fails with an exception.
MicroflowCallBuilder	withExponentialRetry(int numberOfAttempts, java.time.Duration initialInterval, java.time.Duration maximumInterval)	Performs the specified number of retries if the execution of the action fails with an exception.
MicroflowCallBuilder	withParam(java.lang.String name, java.lang.Object value)	Adds the specified parameter to the microflow call.
default MicroflowCallBuilder	withParams(java.util.Map<java.lang.String,java.lang.Object> params)	Adds multiple parameters to the microflow call.
MicroflowCallBuilder	withRetry(int numberOfAttempts, java.time.Duration interval)	Performs the specified number of retries if the execution of the action fails with an exception.

Methods inherited from interface com.mendix.core.actionmanagement.ActionCallBuilder

execute, executeInBackground, executeInBackground

Method Detail

withParam

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

Adds the specified parameter to the microflow call.

Parameters:

name - the name of the parameter

value - the value for the parameter

Returns:

the updated builder

withParams

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

Adds multiple parameters to the microflow call.

Parameters:

params - the parameters to add

Returns:

the updated builder

inTransaction

MicroflowCallBuilder inTransaction(boolean executeInTransaction)

Specifies whether the microflow should be called in a transaction scope. This setting is ignored when executing the microflow as a background task.

Parameters:

executeInTransaction - true if the microflow must be run in a transaction; false otherwise

Returns:

the updated builder

withRetry

MicroflowCallBuilder withRetry(int numberOfAttempts,
                               java.time.Duration interval)

Description copied from interface: ActionCallBuilder

Performs the specified number of retries if the execution of the action fails with an exception. A fixed delay is used in between the retries. This setting only applies to actions that are executed as a background task.

Specified by:

withRetry in interface ActionCallBuilder

Parameters:

numberOfAttempts - the maximum number of times to retry

interval - the time to wait in between attempts

Returns:

the updated builder

withExponentialRetry

MicroflowCallBuilder withExponentialRetry(int numberOfAttempts,
                                          java.time.Duration initialInterval)

Description copied from interface: ActionCallBuilder

Performs the specified number of retries if the execution of the action fails with an exception. An exponentially increasing delay is used in between the retries. The interval doubles each time, up to a maximum of 1 day. This setting only applies to actions that are executed as a background task.

Specified by:

withExponentialRetry in interface ActionCallBuilder

Parameters:

numberOfAttempts - the maximum number of times to retry

initialInterval - the time to wait before the first retry

Returns:

the updated builder

withExponentialRetry

MicroflowCallBuilder withExponentialRetry(int numberOfAttempts,
                                          java.time.Duration initialInterval,
                                          java.time.Duration maximumInterval)

Description copied from interface: ActionCallBuilder

Performs the specified number of retries if the execution of the action fails with an exception. An exponentially increasing delay is used in between the retries. The interval doubles each time, up to the specified maximum. This setting only applies to actions that are executed as a background task.

Specified by:

withExponentialRetry in interface ActionCallBuilder

Parameters:

numberOfAttempts - the maximum number of times to retry

initialInterval - the time to wait before the first retry

maximumInterval - the maximum time to wait in between attempts

Returns:

the updated builder