Package io.jmix.bpm.provider

Annotation Interface UserListProvider

@Target(TYPE)
@Retention(RUNTIME)
@Component
public @interface UserListProvider

Indicates that an annotated class is a "userListProvider". Such classes are used to find an appropriate list of UserDetails as possible candidates for userTask and should return a list of usernames. Calculated usernames will be set as value of flowable:candidateUsers attribute for userTask.

Annotated class can contain one or more methods with arbitrary number of parameters and List<String> return type:

   List<String> getDefaultUsers() {
       return Arrays.asList("anonymous", "admin");
   }

   List<String> getUsersByRole(String roleCode) {
       List<UserDetails> candidateUsers = ...;
       return candidateUsers.stream().map(UserDetails::getUsername).collect(toList());
   }
 

Declared methods will be available in modeler with a possibility to pass into them actual parameters, include process variables.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	description	Short explanation of searching algorithm to find appropriate users.
String	value

Element Details

description

String description

Short explanation of searching algorithm to find appropriate users.

Default:

""

value

@AliasFor(annotation=org.springframework.stereotype.Component.class)
String value

Default:

""