Package org.ametys.plugins.odfpilotage.rule

Class RulesManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfpilotage.rule.RulesManager

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class RulesManager
extends AbstractLogEnabled
implements Component, Serviceable

The rules manager

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentWorkflowHelper	_contentWorkflowHelper	The content workflow helper
protected CopyContentComponent	_copyContentComponent	The copy content component
protected ContentTypeExtensionPoint	_cTypeEP	The content type extension point
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected MCCWorkflowHelper	_mccWorkflowHelper	The MCC workflow helper
protected PilotageHelper	_pilotageHelper	The pilotage helper
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected RightManager	_rightManager	The right manager
protected ThematicsHelper	_thematicsHelper	The thematics helper
static final String	ADDITIONAL_THEMATICS_PREFIX	The additional thematic prefix
static final String	COMPLEMENTARY_RULE_VIEW	The name of the complementary rules view
static final String	CONTAINER_RULES	The attribute name for the rules repeater in container
static final String	CONTAINER_THEMATICS	The attribute name for the thematics repeater in container
static final String	HANDLE_RULES_RIGHT	The handle rules right
static final String	ROLE	Avalon ROLE.
static final String	RULE_CODE	The attribute name for the rule code
static final String	RULE_DEROGABLE	The attribute name for the rule derogable
static final String	RULE_HELP_MOTIVATION	The attribute name for the rule help motivation
static final String	RULE_HELP_TEXT	The attribute name for the rule help text
static final String	RULE_MOTIVATION	The attribute name for the rule motivation
static final String	RULE_STATUS	The attribute name for the rule status
static final String	RULE_TEXT	The attribute name for the rule text
static final String	RULE_THEMATIC_CODE	The attribute name for the rule thematic code
static final String	SPECIFIC_RULE_VIEW	The name of the specific rules view
static final String	THEMATIC_CODE	The attribute name for the thematic code
static final String	THEMATIC_CONTENT_TYPE	The thematic content type
static final String	THEMATIC_DEGREE	The attribute name for the degree restriction in thematic content
static final String	THEMATIC_NB_SESSIONS	The attribute name for the nb sessions restriction in thematic content
static final String	THEMATIC_REGIME	The attribute name for the regime restriction in thematic content
static final String	THEMATIC_RULES	The attribute name for the rules repeater in thematic content
static final String	THEMATICS_PREFIX	The thematic prefix

Constructor Summary

Constructors

Constructor	Description
RulesManager()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_addAdditionalRule(String containerId, String thematicCode, Object text, Object motivation, int actionId)	Add an additional rule to the container for a given thematic
protected Map<String,Object>	_derogateRule(String containerId, String thematicCode, String ruleCode, Object text, Object motivation, int actionId)	Derogate a rule for a given container
Map<String,Object>	addAdditionalRule(String containerId, String thematicCode, Object text, Object motivation)	Add an additional rule to the container for a given thematic
boolean	canEditRules(Container container)	true if can edit rules for the given container
Map<String,Object>	copyAllRules(String srcContainerId, List<String> destContainerIds)	Copy all rule of the source container to the dest containers
Map<String,Object>	copyRule(String srcContainerId, String thematicCode, String ruleCode, List<String> destContainerIds)	Copy the rule to the given containers
Map<String,Object>	copyRulesFromView(String srcContainerId, List<String> destContainerIds, String viewName)	Copy all rules from view of the source container to the dest containers
Map<String,Object>	deleteRule(String containerId, String ruleCode)	Delete a container rule
boolean	deleteRules(Container container, Set<Integer> rulePositions)	Delete the rules of container
Map<String,Object>	derogateRule(String containerId, String thematicCode, String ruleCode, Object text, Object motivation)	Derogate a rule for a given container
Map<String,Object>	editAdditionalRule(String containerId, String ruleCode, String text, String motivation)	Edit a container additional rule
Map<String,Object>	getAllowedContainers(Map<String,Object> params)	Get the containers matching the same thematic restriction of the given container
Map<String,Object>	getRuleInfo(String containerId, String thematicCode, String ruleCode)	Get the information of given rule in the given container
Map<String,Object>	getRuleValues(String containerId, String ruleCode)	Get the values of given rule in the given container
boolean	hasHandleRulesRight(Container container)	true if has handle rules right
Map<String,Object>	isMccCompatible(String containerId)	true if the current user has right on the container and its nature equals to "annee"
boolean	isRulesEnabled()	Determines if rules are enabled
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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

Avalon ROLE.

THEMATIC_CONTENT_TYPE

public static final String THEMATIC_CONTENT_TYPE

The thematic content type

See Also:

• Constant Field Values

CONTAINER_THEMATICS

public static final String CONTAINER_THEMATICS

The attribute name for the thematics repeater in container

See Also:

• Constant Field Values

THEMATIC_DEGREE

public static final String THEMATIC_DEGREE

The attribute name for the degree restriction in thematic content

See Also:

• Constant Field Values

THEMATIC_REGIME

public static final String THEMATIC_REGIME

The attribute name for the regime restriction in thematic content

See Also:

• Constant Field Values

THEMATIC_NB_SESSIONS

public static final String THEMATIC_NB_SESSIONS

The attribute name for the nb sessions restriction in thematic content

See Also:

• Constant Field Values

THEMATIC_RULES

public static final String THEMATIC_RULES

The attribute name for the rules repeater in thematic content

See Also:

• Constant Field Values

CONTAINER_RULES

public static final String CONTAINER_RULES

The attribute name for the rules repeater in container

See Also:

• Constant Field Values

THEMATIC_CODE

public static final String THEMATIC_CODE

The attribute name for the thematic code

See Also:

• Constant Field Values

RULE_THEMATIC_CODE

public static final String RULE_THEMATIC_CODE

The attribute name for the rule thematic code

See Also:

• Constant Field Values

RULE_CODE

public static final String RULE_CODE

The attribute name for the rule code

See Also:

• Constant Field Values

RULE_HELP_TEXT

public static final String RULE_HELP_TEXT

The attribute name for the rule help text

See Also:

• Constant Field Values

RULE_TEXT

public static final String RULE_TEXT

The attribute name for the rule text

See Also:

• Constant Field Values

RULE_STATUS

public static final String RULE_STATUS

The attribute name for the rule status

See Also:

• Constant Field Values

RULE_DEROGABLE

public static final String RULE_DEROGABLE

The attribute name for the rule derogable

See Also:

• Constant Field Values

RULE_HELP_MOTIVATION

public static final String RULE_HELP_MOTIVATION

The attribute name for the rule help motivation

See Also:

• Constant Field Values

RULE_MOTIVATION

public static final String RULE_MOTIVATION

The attribute name for the rule motivation

See Also:

• Constant Field Values

THEMATICS_PREFIX

public static final String THEMATICS_PREFIX

The thematic prefix

See Also:

• Constant Field Values

ADDITIONAL_THEMATICS_PREFIX

public static final String ADDITIONAL_THEMATICS_PREFIX

The additional thematic prefix

See Also:

• Constant Field Values

HANDLE_RULES_RIGHT

public static final String HANDLE_RULES_RIGHT

The handle rules right

See Also:

• Constant Field Values

SPECIFIC_RULE_VIEW

public static final String SPECIFIC_RULE_VIEW

The name of the specific rules view

See Also:

• Constant Field Values

COMPLEMENTARY_RULE_VIEW

public static final String COMPLEMENTARY_RULE_VIEW

The name of the complementary rules view

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

_pilotageHelper

protected PilotageHelper _pilotageHelper

The pilotage helper

_thematicsHelper

protected ThematicsHelper _thematicsHelper

The thematics helper

_rightManager

protected RightManager _rightManager

The right manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_mccWorkflowHelper

protected MCCWorkflowHelper _mccWorkflowHelper

The MCC workflow helper

_copyContentComponent

protected CopyContentComponent _copyContentComponent

The copy content component

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point

Constructor Details

RulesManager

public RulesManager()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isRulesEnabled

public boolean isRulesEnabled()

Determines if rules are enabled

Returns:

true if rules are enabled

canEditRules

public boolean canEditRules(Container container)

true if can edit rules for the given container

Parameters:

container - the container

Returns:

true if can edit rules

isMccCompatible

public Map<String,Object> isMccCompatible(String containerId)

true if the current user has right on the container and its nature equals to "annee"

Parameters:

containerId - the container id

Returns:

results

hasHandleRulesRight

public boolean hasHandleRulesRight(Container container)

true if has handle rules right

Parameters:

container - the container

Returns:

true if has handle rules right

addAdditionalRule

public Map<String,Object> addAdditionalRule(String containerId,
 String thematicCode,
 Object text,
 Object motivation)

Add an additional rule to the container for a given thematic

Parameters:

containerId - the container id

thematicCode - the code of the thematic

text - the text rule

motivation - the motivation rule

Returns:

the map of results

_addAdditionalRule

protected Map<String,Object> _addAdditionalRule(String containerId,
 String thematicCode,
 Object text,
 Object motivation,
 int actionId)

Add an additional rule to the container for a given thematic

Parameters:

containerId - the container id

thematicCode - the code of the thematic

text - the text rule

motivation - the motivation rule

actionId - the action id

Returns:

the map of results

editAdditionalRule

public Map<String,Object> editAdditionalRule(String containerId,
 String ruleCode,
 String text,
 String motivation)

Edit a container additional rule

Parameters:

containerId - the container id

ruleCode - the code of the rule

text - the text rule

motivation - the motivation rule

Returns:

the map of results

deleteRule

public Map<String,Object> deleteRule(String containerId,
 String ruleCode)

Delete a container rule

Parameters:

containerId - the container id

ruleCode - the code of the rule

Returns:

the map of results

deleteRules

public boolean deleteRules(Container container,
 Set<Integer> rulePositions)

Delete the rules of container

Parameters:

container - the container

rulePositions - the rule positions

Returns:

true if the deletion is a success

getRuleValues

public Map<String,Object> getRuleValues(String containerId,
 String ruleCode)

Get the values of given rule in the given container

Parameters:

containerId - the container id

ruleCode - the rule code

Returns:

the rule values

getRuleInfo

public Map<String,Object> getRuleInfo(String containerId,
 String thematicCode,
 String ruleCode)

Get the information of given rule in the given container

Parameters:

containerId - the container id

thematicCode - the thematic code

ruleCode - the rule code

Returns:

the rule information

derogateRule

public Map<String,Object> derogateRule(String containerId,
 String thematicCode,
 String ruleCode,
 Object text,
 Object motivation)

Derogate a rule for a given container

Parameters:

containerId - the container

thematicCode - the thematic code

ruleCode - the rule code

text - the text of the derogation

motivation - the motivation of the derogation

Returns:

the rule information

_derogateRule

protected Map<String,Object> _derogateRule(String containerId,
 String thematicCode,
 String ruleCode,
 Object text,
 Object motivation,
 int actionId)

Derogate a rule for a given container

Parameters:

containerId - the container

thematicCode - the thematic code

ruleCode - the rule code

text - the text of the derogation

motivation - the motivation of the derogation

actionId - the action id

Returns:

the rule information

getAllowedContainers

public Map<String,Object> getAllowedContainers(Map<String,Object> params)

Get the containers matching the same thematic restriction of the given container

Parameters:

params - the given parameters

Returns:

the allowed containers

copyRule

public Map<String,Object> copyRule(String srcContainerId,
 String thematicCode,
 String ruleCode,
 List<String> destContainerIds)

Copy the rule to the given containers

Parameters:

srcContainerId - the source container id

thematicCode - the thematic code

ruleCode - the rule code

destContainerIds - the ids of dest container

Returns:

the results

copyAllRules

public Map<String,Object> copyAllRules(String srcContainerId,
 List<String> destContainerIds)

Copy all rule of the source container to the dest containers

Parameters:

srcContainerId - the source container id

destContainerIds - the destination container ids

Returns:

the copy result

copyRulesFromView

public Map<String,Object> copyRulesFromView(String srcContainerId,
 List<String> destContainerIds,
 String viewName)

Copy all rules from view of the source container to the dest containers

Parameters:

srcContainerId - the source container id

destContainerIds - the destination container ids

viewName - the view name

Returns:

the copy result