org.bonitasoft.engine.filter

Interface UserFilter

All Known Implementing Classes:

AbstractUserFilter

public interface UserFilter

The execution of this filter returns a list of userId. It is used for the filtering of who can claim a UserTask based on its actorId

Author:

Baptiste Mesta

Method Summary

Methods

Modifier and Type	Method and Description
List<Long>	filter(String actorName) Execute the filter.
void	setInputParameters(Map<String,Object> parameters) Set the input parameter for the filter.
boolean	shouldAutoAssignTaskIfSingleResult() This method make the engine assign automatically the task if the result of filter(String) is only one element.
void	validateInputParameters() Validate the input parameters.

Method Detail

setInputParameters

void setInputParameters(Map<String,Object> parameters)

Set the input parameter for the filter.

Parameters:

parameters - parameters is a map with parameter names and their value.

validateInputParameters

void validateInputParameters()
                             throws ConnectorValidationException

Validate the input parameters. Check the parameters types and boundaries.

Throws:

ConnectorValidationException

filter

List<Long> filter(String actorName)
                  throws UserFilterException

Execute the filter.

Parameters:

actorName - the actor name of the task

Returns:

the connector outputs map corresponding to the output definition.

Throws:

UserFilterException

shouldAutoAssignTaskIfSingleResult

boolean shouldAutoAssignTaskIfSingleResult()

This method make the engine assign automatically the task if the result of filter(String) is only one element. i.e. when the task is filtered only for a single user

Returns:

true if we should assign task when there is only one result.