Package com.mendix.core.actionmanagement

Interface UserActionCallBuilder

All Superinterfaces:
ActionCallBuilder
public interface UserActionCallBuilder extends ActionCallBuilder
Provides a builder for building a user action call. The builder can be used to add arguments and eventually call the user action.

  • Method Details

    • withParams

      UserActionCallBuilder withParams(Object... params)
      Sets the parameters that will be used to create the user action.

      There are two ways of using this method:

      1. Provide exactly the constructor parameters of the UserAction that is to be called. For example for the MyCustomAction has a constructor public MyCustomAction(IContext context, Integer param>) then it can be called with all those parameter, e.g. ....withParams(context, 23).
      2. Provide all except context parameter of the constructor of the UserAction that is to be called. In the above example that would mean ....withParams(23).
        Only parameters of the exact type IContext can be omitted. If one IContext parameter is omitted all parameters of that type have to be omitted.
      The second method is preferred.

      All parameters have to be specified at once, subsequent calls override earlier calls.

      Parameters:
      params - the parameters to set
      Returns:
      the updated call builder with the specified parameters

    • withRetry

      UserActionCallBuilder withRetry(int numberOfAttempts, 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

      UserActionCallBuilder withExponentialRetry(int numberOfAttempts, 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

      UserActionCallBuilder withExponentialRetry(int numberOfAttempts, Duration initialInterval, 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