Package org.ametys.plugins.forms.workflow

Class IsUserCondition

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.forms.workflow.IsUserCondition

All Implemented Interfaces:

com.opensymphony.workflow.Condition, FormEntryCondition, EnhancedCondition, LogEnabled, Serviceable

public class IsUserCondition
extends AbstractLogEnabled
implements EnhancedCondition, FormEntryCondition, Serviceable

Worklow condition for checking if current user is the same user as an user defined in a question

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected UserManager	_userManager	The user manager
static final String	QUESTION_NAME	The question name argument

Constructor Summary

Constructors

Constructor	Description
IsUserCondition()

Method Summary

Modifier and Type	Method	Description
List<WorkflowArgument>	getArguments()	Get the list of accepted arguments for this condition
I18nizableText	getFullLabel(Map<String,String> argumentsValues)	Get the condition label depending on arguments values
I18nizableText	getLabel()	Get the label for this condition
protected Set<UserIdentity>	getUsersFromEntry(FormEntry formEntry, Map args)	Get the set of users defined in the given question of the form entry
List<WorkflowHelper.WorkflowVisibility>	getVisibilities()	Get the condition's visibilities depending on rights
Map<UserIdentity,RightManager.RightResult>	getWorkflowActorsPermissions(FormEntry entry, Map args)	Returns all users with their corresponding permission result.
boolean	passesCondition(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.forms.workflow.FormEntryCondition

getAnyConnectedPermissions

Field Details

QUESTION_NAME

public static final String QUESTION_NAME

The question name argument

See Also:

• Constant Field Values

_userManager

protected UserManager _userManager

The user manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

IsUserCondition

public IsUserCondition()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

passesCondition

public boolean passesCondition(Map transientVars,
 Map args,
 com.opensymphony.module.propertyset.PropertySet ps)
                        throws com.opensymphony.workflow.WorkflowException

Specified by:

passesCondition in interface com.opensymphony.workflow.Condition

Throws:

com.opensymphony.workflow.WorkflowException

getArguments

public List<WorkflowArgument> getArguments()

Description copied from interface: EnhancedCondition

Get the list of accepted arguments for this condition

Specified by:

getArguments in interface EnhancedCondition

Returns:

a List of argument names and associated description

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedCondition

Get the label for this condition

Specified by:

getLabel in interface EnhancedCondition

Returns:

the label

getFullLabel

public I18nizableText getFullLabel(Map<String,String> argumentsValues)

Description copied from interface: EnhancedCondition

Get the condition label depending on arguments values

Specified by:

getFullLabel in interface EnhancedCondition

Parameters:

argumentsValues - a map of the arguments with their values in current workflow

Returns:

a label to display in workflow editor vue

getVisibilities

public List<WorkflowHelper.WorkflowVisibility> getVisibilities()

Description copied from interface: EnhancedCondition

Get the condition's visibilities depending on rights

Specified by:

getVisibilities in interface EnhancedCondition

Returns:

a list of all the allowed right profiles

getWorkflowActorsPermissions

public Map<UserIdentity,RightManager.RightResult> getWorkflowActorsPermissions(FormEntry entry,
 Map args)

Description copied from interface: FormEntryCondition

Returns all users with their corresponding permission result. The associated RightManager.RightResult indicates whether the user passes the condition or not.

Specified by:

getWorkflowActorsPermissions in interface FormEntryCondition

Parameters:

entry - the form entry

args - the condition arguments

Returns:

a map containing each evaluated user and their corresponding RightManager.RightResult

getUsersFromEntry

protected Set<UserIdentity> getUsersFromEntry(FormEntry formEntry,
 Map args)

Get the set of users defined in the given question of the form entry

Parameters:

formEntry - the form entry to get the users from

args - the condition arguments containing the question name

Returns:

the set of users defined in the given question of the form entry, or an empty set if the question is not valid