Package org.ametys.plugins.forms.rights

Class FormEntryAccessConditionsWorkflowHelper

java.lang.Object

org.ametys.plugins.forms.rights.FormEntryAccessConditionsWorkflowHelper

All Implemented Interfaces:

Component, Serviceable

public class FormEntryAccessConditionsWorkflowHelper
extends Object
implements Component, Serviceable

This helper provides methods to get the users passing the workflow conditions for form entries.

Field Summary

Fields

Modifier and Type	Field	Description
protected EnhancedConditionExtensionPoint	_enhancedConditionExtensionPoint	Extension point for Conditions
protected WorkflowHelper	_workflowHelper	The workflow helper component
protected WorkflowProvider	_workflowProvider	The workflow provider
static final String	ROLE	The component role

Constructor Summary

Constructors

Constructor	Description
FormEntryAccessConditionsWorkflowHelper()

Method Summary

Modifier and Type	Method	Description
protected List<String>	getExcludedActionTypes()	Get the list of action types to exclude for the access rights evaluation
protected Map<UserIdentity,RightManager.RightResult>	getUsersPassingConditions(FormEntry entry)	Get the users passing the workflow conditions for the given form entry with their right result
Map<UserIdentity,RightManager.RightResult>	getWorkflowActors(FormEntry entry)	Get the users having at least one available action on the entry with their right result
boolean	isAnyWorkflowActorsAllowed(FormEntry entry)	true if the workflow conditions for the given form entry allow any workflow actor to have access to this entry, false otherwise
static RightManager.RightResult	mergeAndRightResults(RightManager.RightResult r1, RightManager.RightResult r2)	Merge two right results with an AND operation
static RightManager.RightResult	mergeOrRightResults(RightManager.RightResult r1, RightManager.RightResult r2)	Merge two right results with an OR operation
protected boolean	passesConditions(FormEntry entry)	Evaluate the workflow conditions for the given form entry and returning true if we pass all the conditions, false otherwise
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper component

_enhancedConditionExtensionPoint

protected EnhancedConditionExtensionPoint _enhancedConditionExtensionPoint

Extension point for Conditions

Constructor Details

FormEntryAccessConditionsWorkflowHelper

public FormEntryAccessConditionsWorkflowHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isAnyWorkflowActorsAllowed

public boolean isAnyWorkflowActorsAllowed(FormEntry entry)

true if the workflow conditions for the given form entry allow any workflow actor to have access to this entry, false otherwise

Parameters:

entry - the form entry

Returns:

true if the workflow conditions for the given form entry allow any workflow actor to have access to this entry, false otherwise

passesConditions

protected boolean passesConditions(FormEntry entry)

Evaluate the workflow conditions for the given form entry and returning true if we pass all the conditions, false otherwise

Parameters:

entry - the form entry

Returns:

true if we pass all the conditions, false otherwise

getWorkflowActors

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

Get the users having at least one available action on the entry with their right result

Parameters:

entry - the form entry

Returns:

the users having at least one available action on the entry with their right result

getUsersPassingConditions

protected Map<UserIdentity,RightManager.RightResult> getUsersPassingConditions(FormEntry entry)

Get the users passing the workflow conditions for the given form entry with their right result

Parameters:

entry - the form entry

Returns:

the users passing the workflow conditions for the given form entry with their right result

getExcludedActionTypes

protected List<String> getExcludedActionTypes()

Get the list of action types to exclude for the access rights evaluation

Returns:

the list of action types to exclude for the access rights evaluation

mergeOrRightResults

public static RightManager.RightResult mergeOrRightResults(RightManager.RightResult r1,
 RightManager.RightResult r2)

Merge two right results with an OR operation

Parameters:

r1 - the first right result

r2 - the second right result

Returns:

the merged right result

mergeAndRightResults

public static RightManager.RightResult mergeAndRightResults(RightManager.RightResult r1,
 RightManager.RightResult r2)

Merge two right results with an AND operation

Parameters:

r1 - the first right result

r2 - the second right result

Returns:

the merged right result