Role mapper is dedicated to manual activity (ie. activity with startMode=Manual, aka human task).
Implementing this interface allows to resolve the role by executing the
#searchMembersthat returns the list of users matching with the role.
Within xpdl definition, Role Mapper element is specified within a role (ie. XPDL participant element with type=role)
and this role is specified within the XPDL Performer element of a manual activity
(ie. activity with startMode=Manual, aka human task).
There is two parameters to define a role mapper:
- the type of the role mapper (ie. custom)
- the name of the class that implements this interface
The
#searchMembers to be implemented is called when the execution
enters into the node of the activity after the creation of the human task.
Candidates list of the task will be filled-in with returned set of users assuming
that only these members of the list can get the task.
In other word, this task is returned by
org.ow2.bonita.facade.QueryRuntimeAPI#getTaskList(with state=READY) if executed by the users of the candidates list (being authenticated).