Package org.ametys.plugins.odfpilotage.clientsideelement

Class MCCWorkflowClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.cms.clientsideelement.SmartContentClientSideElement

org.ametys.plugins.odfpilotage.clientsideelement.MCCWorkflowClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class MCCWorkflowClientSideElement
extends SmartContentClientSideElement

Client side element for MCC workflow buttons on a Program

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MCCWorkflowClientSideElement.MCCRole	Enumaration for MCC role

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
protected MCCWorkflowHelper	_mccWorkflowHelper	The MCC workflow helper
protected ODFHelper	_odfHelper	The ODF helper
protected PilotageHelper	_pilotageHelper	The pilotage helper
protected RulesManager	_rulesManager	Th erules manager

Fields inherited from class org.ametys.cms.clientsideelement.SmartContentClientSideElement

_contentHelper, _resolver, _smartHelper

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
MCCWorkflowClientSideElement()

Method Summary

Modifier and Type	Method	Description
LocalDate	getMinDateForMCCCFVUValidation(String programId)	Get minimun date for MCC CFVU validation
LocalDate	getMinDateForMCCOrgUnitValidation(String programId)	Get minimun date for MCC CFVU validation
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
Map<String,Object>	getStatus(String programItemId, String mccRole)	Get informations on contents' state
Map<String,Object>	invalidateMCCForCVFU(String programId)	Invalidate the MCC
Map<String,Object>	invalidateMentionMCC(String programId)	Invalidate the rules
Map<String,Object>	invalidateMentionRules(String programId)	Invalidate the rules
Map<String,Object>	invalidateOrgunitMCC(String programId)	Invalidate the MCC for orgunit level
void	service(ServiceManager manager)
Map<String,Object>	setMCCStatus(String containerId, boolean validated)	Set the MCC status of a container of type year
Map<String,Object>	setRulesStatus(String containerId, boolean validated)	Set the MCC status of a container of type year
Map<String,Object>	validateMCCForCVFU(String programId, String validationDate, String comment)	Validate the MCC
Map<String,Object>	validateMentionMCC(String programId, String validationDate, String comment)	Validate the rules
Map<String,Object>	validateMentionRules(String programId, String validationDate, String comment)	Validate the rules
Map<String,Object>	validateOrgunitMCC(String programId, String validationDate, String comment)	Validate the MCC to orgunit level

Methods inherited from class org.ametys.cms.clientsideelement.SmartContentClientSideElement

_getAllRightDescription, _getIncorrectWorkflowStepDescription, _getLockedDescription, _getNoModifiableDescription, _getNoRightDescription, _getWorkflowActionUnvailableDescription, _hasRight, _isAllRight, _isLocked, _isModifiable, _isWorkflowStepCorrect, _workflowAction, getContentDefaultParameters, getStatus

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, hasRight, setPluginInfo, toString

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, wait, wait, wait

Field Details

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_mccWorkflowHelper

protected MCCWorkflowHelper _mccWorkflowHelper

The MCC workflow helper

_pilotageHelper

protected PilotageHelper _pilotageHelper

The pilotage helper

_rulesManager

protected RulesManager _rulesManager

Th erules manager

Constructor Details

MCCWorkflowClientSideElement

public MCCWorkflowClientSideElement()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SmartContentClientSideElement

Throws:

ServiceException

getScripts

public List<ClientSideElement.Script> getScripts(boolean ignoreRights,
 Map<String,Object> contextParameters)

Description copied from interface: ClientSideElement

This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.

Specified by:

getScripts in interface ClientSideElement

Overrides:

getScripts in class StaticFileImportsClientSideElement

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

getStatus

public Map<String,Object> getStatus(String programItemId,
 String mccRole)

Get informations on contents' state

Parameters:

programItemId - the id of program item

mccRole - the MCC role

Returns:

informations on contents' state

validateMentionRules

public Map<String,Object> validateMentionRules(String programId,
 String validationDate,
 String comment)

Validate the rules

Parameters:

programId - the content id

validationDate - the date of validation

comment - the optional comment

Returns:

the result

invalidateMentionRules

public Map<String,Object> invalidateMentionRules(String programId)

Invalidate the rules

Parameters:

programId - the program id

Returns:

the result

validateMentionMCC

public Map<String,Object> validateMentionMCC(String programId,
 String validationDate,
 String comment)

Validate the rules

Parameters:

programId - the program id

validationDate - the date of validation

comment - the optional comment

Returns:

the result

invalidateMentionMCC

public Map<String,Object> invalidateMentionMCC(String programId)

Invalidate the rules

Parameters:

programId - the program id

Returns:

the result

getMinDateForMCCOrgUnitValidation

public LocalDate getMinDateForMCCOrgUnitValidation(String programId)

Get minimun date for MCC CFVU validation

Parameters:

programId - the content id

Returns:

the minimun date

validateOrgunitMCC

public Map<String,Object> validateOrgunitMCC(String programId,
 String validationDate,
 String comment)

Validate the MCC to orgunit level

Parameters:

programId - the content id

validationDate - the date of validation

comment - the optional comment

Returns:

the result

invalidateOrgunitMCC

public Map<String,Object> invalidateOrgunitMCC(String programId)

Invalidate the MCC for orgunit level

Parameters:

programId - the content id

Returns:

the result

getMinDateForMCCCFVUValidation

public LocalDate getMinDateForMCCCFVUValidation(String programId)

Get minimun date for MCC CFVU validation

Parameters:

programId - the program id

Returns:

the minimun date

validateMCCForCVFU

public Map<String,Object> validateMCCForCVFU(String programId,
 String validationDate,
 String comment)

Validate the MCC

Parameters:

programId - the program id

validationDate - the date of validation. Can be empty or null.

comment - the optional comment

Returns:

the result

invalidateMCCForCVFU

public Map<String,Object> invalidateMCCForCVFU(String programId)

Invalidate the MCC

Parameters:

programId - the content id

Returns:

the result

setMCCStatus

public Map<String,Object> setMCCStatus(String containerId,
 boolean validated)

Set the MCC status of a container of type year

Parameters:

containerId - the id of container

validated - true to validate MCC, false to invalidate

Returns:

the result

setRulesStatus

public Map<String,Object> setRulesStatus(String containerId,
 boolean validated)

Set the MCC status of a container of type year

Parameters:

containerId - the id of container

validated - true to validate MCC, false to invalidate

Returns:

the result