Package io.jmix.bpmflowui.processform.annotation

Annotation Interface ProcessVariable

@Target(FIELD) @Retention(RUNTIME) public @interface ProcessVariable
The annotation should be applied for UI components and simple fields. The injection mechanism will set the value of the process variable to the component or field.

For instance, for the UI component: 

 @ViewComponent
 @ProcessVariable(name = "specificationVar")
 private EntityPicker<Specification> specificationEntityPicker;
For the simple field: 
 @ProcessVariable
 private Date date;

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
     
    ProcessVariableParam[]
    params
    Parameters can be used to pass additional information to the process variable.

  • Element Details

    • name

      String name
      Returns:
      the name of the process variable
      Default:
      ""

    • params

      ProcessVariableParam[] params
      Parameters can be used to pass additional information to the process variable. For instance, if the entity variable should load dynamic attributes, specify the following parameter: 
       @ProcessVariable(
         name = "specificationVar",
         params = @ProcessVariableParam(
                 key = ProcessVariableConstants.LOAD_DYN_ATTR_PARAM,
                 value = "true"))
 private Specification specificationVar;
      Returns:
      process variable parameters
      Default:
      {}