org.bonitasoft.engine.filter

Class AbstractUserFilter

java.lang.Object

org.bonitasoft.engine.filter.AbstractUserFilter

All Implemented Interfaces:

UserFilter

public abstract class AbstractUserFilter
extends Object
implements UserFilter

Author:

Feng Hui, Romain Bioteau, Baptiste Mesta

Constructor Summary

Constructors

Constructor and Description
AbstractUserFilter()

Method Summary

Modifier and Type	Method and Description
APIAccessor	getAPIAccessor()
EngineExecutionContext	getExecutionContext()
protected Object	getInputParameter(String paramName)
protected <T> T	getOptinalInputParameter(String paramName)
protected String	getStringInputParameter(String paramName)
void	setAPIAccessor(APIAccessor apiAccessor)
void	setExecutionContext(EngineExecutionContext executionContext)
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 UserFilter.filter(String) is only one element.
protected void	validateStringInputParameterIsNotNulOrEmpty(String paramName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.bonitasoft.engine.filter.UserFilter

filter, validateInputParameters

Constructor Detail

AbstractUserFilter

public AbstractUserFilter()

Method Detail

setInputParameters

public void setInputParameters(Map<String,Object> parameters)

Description copied from interface: UserFilter

Set the input parameter for the filter.

Specified by:

setInputParameters in interface UserFilter

Parameters:

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

getInputParameter

protected Object getInputParameter(String paramName)
                            throws IllegalStateException

Throws:

IllegalStateException

getOptinalInputParameter

protected <T> T getOptinalInputParameter(String paramName)

getStringInputParameter

protected String getStringInputParameter(String paramName)

validateStringInputParameterIsNotNulOrEmpty

protected void validateStringInputParameterIsNotNulOrEmpty(String paramName)
                                                    throws ConnectorValidationException

Throws:

ConnectorValidationException

shouldAutoAssignTaskIfSingleResult

public boolean shouldAutoAssignTaskIfSingleResult()

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

Specified by:

shouldAutoAssignTaskIfSingleResult in interface UserFilter

Returns:

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

setAPIAccessor

public void setAPIAccessor(APIAccessor apiAccessor)

setExecutionContext

public void setExecutionContext(EngineExecutionContext executionContext)

getAPIAccessor

public APIAccessor getAPIAccessor()

getExecutionContext

public EngineExecutionContext getExecutionContext()