Package org.ametys.plugins.odfpilotage.helper

Class PilotageStatusHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfpilotage.helper.PilotageStatusHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class PilotageStatusHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for ODF pilotage status

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PilotageStatusHelper.PilotageStatus	Enumeration for the pilotage status

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected ObservationManager	_observationManager	The observation manager
protected ODFHelper	_odfHelper	The odf helper
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected RightManager	_rightManager	The right manager
static final String	MENTION_VALIDATION_SUPER_RIGHT_ID	The super right for mention validation state
static final String	ORGUNIT_VALIDATION_SUPER_RIGHT_ID	The super right for orgunit validation state
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
PilotageStatusHelper()

Method Summary

Modifier and Type	Method	Description
protected void	_notifyPilotageWorkflowModification(Content content)	Send a notification with the content modified event.
int	comparePilotageStatus(Program program1, Program program2)	Compare two programs depends on their pilotage status Pilotage status order : NONE lower than MENTION_VALIDATED lower than ORGUNIT_VALIDATED lower than CFVU_VALIDATED lower than CFVU_VALIDATED lower than CFVU_MCC_VALIDATED -1 if pilotage status of program 1 is lower than pilotage status of program 2 0 if they have the same pilotage status 1 if pilotage status of program 1 is higher than pilotage status of program 2 -2 if we don't know
UserIdentity	getCFVUMCCValidationAuthor(Content content)	Get CFVU MCC validation author
String	getCFVUMCCValidationComment(Content content)	Get CFVU MCC validation comment
LocalDate	getCFVUMCCValidationDate(Content content)	Get CFVU MMC validation date
UserIdentity	getCFVUValidationAuthor(Content content)	Get CFVU validation author
String	getCFVUValidationComment(Content content)	Get CFVU validation comment
LocalDate	getCFVUValidationDate(Content content)	Get CFVU validation date
UserIdentity	getMentionValidationAuthor(Content content)	Get mention validation author
String	getMentionValidationComment(Content content)	Get mention validation comment
LocalDate	getMentionValidationDate(Content content)	Get mention validation date
UserIdentity	getOrgUnitValidationAuthor(Content content)	Get orgUnit validation author
String	getOrgUnitValidationComment(Content content)	Get orgUnit validation comment
LocalDate	getOrgUnitValidationDate(Content content)	Get orgUnit validation date
Set<Program>	getParentPrograms(ProgramItem programItem)	Get all program parent from the program item
Set<Program>	getParentProgramsWithPilotageStatus(ProgramItem programItem)	Get all program parent with a pilotage status from the program item
Program	getParentProgramWithHigherPilotageStatus(CoursePart coursePart)	Get parent program or it self from program item with the higher pilotage status.
Program	getParentProgramWithHigherPilotageStatus(ProgramItem programItem)	Get parent program or it self from program item with the higher pilotage status.
Map<String,Object>	getPilotageButtonInfo(String contentId)	Get the pilotage information status for a client side element.
PilotageStatusHelper.PilotageStatus	getPilotageStatus(Content content)	Get the pilotage status of the content
boolean	hasEditSuperRight(Program program)	Return true if the current user has the edit super right depend on the pilotage status of the program
boolean	removeCFVUMCCValidationAttribute(ModifiableDefaultContent content)	Remove validation attribute for 'CFVU MCC validated' state
boolean	removeCFVUValidationAttribute(ModifiableDefaultContent content)	Remove validation attribute for 'CFVU validated' state
boolean	removeMentionValidationAttribute(ModifiableDefaultContent content)	Remove validation attribute for 'mention validated' state
boolean	removeOrgUnitValidationAttribute(ModifiableDefaultContent content)	Remove validation attribute for 'orgunit validated' state
void	removePilotageStatus(ModifiableDefaultContent content, PilotageStatusHelper.PilotageStatus status)	Remove the validation attribute from the content
boolean	removePilotageWorkflow(ModifiableDefaultContent content)	Remove the pilotage workflow metadata.
protected boolean	saveContent(ModifiableDefaultContent content)	Save the content if needed, add a version (checkpoint) and move the Live label if the last version was validated.
void	service(ServiceManager manager)
boolean	setCFVUMCCValidationAttribute(ModifiableDefaultContent content, LocalDate validationDate, UserIdentity user, String comment)	Set the validation attribute for 'CFVU MCC validated' state
boolean	setCFVUValidationAttribute(ModifiableDefaultContent content, LocalDate validationDate, UserIdentity user, String comment)	Set the validation attribute for 'CFVU validated' state
boolean	setMentionValidationAttribute(ModifiableDefaultContent content, LocalDate validationDate, UserIdentity user, String comment)	Set the validation attribute for 'mention validated' state
boolean	setOrgUnitValidationAttribute(ModifiableDefaultContent content, LocalDate validationDate, UserIdentity user, String comment)	Set the validation attribute for 'orgunit validated' state
void	setValidationAttribute(ModifiableDefaultContent content, LocalDate validationDate, UserIdentity user, String comment, PilotageStatusHelper.PilotageStatus status)	Set the validation attribute (date, login, comment) to the content

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

The component role.

MENTION_VALIDATION_SUPER_RIGHT_ID

public static final String MENTION_VALIDATION_SUPER_RIGHT_ID

The super right for mention validation state

See Also:

• Constant Field Values

ORGUNIT_VALIDATION_SUPER_RIGHT_ID

public static final String ORGUNIT_VALIDATION_SUPER_RIGHT_ID

The super right for orgunit validation state

See Also:

• Constant Field Values

_odfHelper

protected ODFHelper _odfHelper

The odf helper

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_rightManager

protected RightManager _rightManager

The right manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_observationManager

protected ObservationManager _observationManager

The observation manager

Constructor Details

PilotageStatusHelper

public PilotageStatusHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getParentPrograms

public Set<Program> getParentPrograms(ProgramItem programItem)

Get all program parent from the program item

Parameters:

programItem - the program item

Returns:

the set of program parent

getParentProgramsWithPilotageStatus

public Set<Program> getParentProgramsWithPilotageStatus(ProgramItem programItem)

Get all program parent with a pilotage status from the program item

Parameters:

programItem - the program item

Returns:

the set of program parent

hasEditSuperRight

public boolean hasEditSuperRight(Program program)

Return true if the current user has the edit super right depend on the pilotage status of the program

Parameters:

program - the program

Returns:

true if the user has the super right

comparePilotageStatus

public int comparePilotageStatus(Program program1,
 Program program2)

Compare two programs depends on their pilotage status Pilotage status order : NONE lower than MENTION_VALIDATED lower than ORGUNIT_VALIDATED lower than CFVU_VALIDATED lower than CFVU_VALIDATED lower than CFVU_MCC_VALIDATED -1 if pilotage status of program 1 is lower than pilotage status of program 2 0 if they have the same pilotage status 1 if pilotage status of program 1 is higher than pilotage status of program 2 -2 if we don't know

Parameters:

program1 - program 1

program2 - progam 2

Returns:

the int compare number

getParentProgramWithHigherPilotageStatus

public Program getParentProgramWithHigherPilotageStatus(CoursePart coursePart)

Get parent program or it self from program item with the higher pilotage status. Program with pilotage status NONE are ignored, so can be null if there are no program with active pilotage status.

Parameters:

coursePart - the course part

Returns:

the program parent

getParentProgramWithHigherPilotageStatus

public Program getParentProgramWithHigherPilotageStatus(ProgramItem programItem)

Get parent program or it self from program item with the higher pilotage status. Program with pilotage status NONE are ignored, so can be null if there are no program with active pilotage status.

Parameters:

programItem - the program item

Returns:

the program parent

getPilotageButtonInfo

public Map<String,Object> getPilotageButtonInfo(String contentId)

Get the pilotage information status for a client side element. The button is enabled if the pilotage status of root programs is NONE or if the current user has super edit right on root program of higher status

Parameters:

contentId - the content id

Returns:

the pilotage information

getPilotageStatus

public PilotageStatusHelper.PilotageStatus getPilotageStatus(Content content)

Get the pilotage status of the content

Parameters:

content - the content

Returns:

the pilotage status

_notifyPilotageWorkflowModification

protected void _notifyPilotageWorkflowModification(Content content)

Send a notification with the content modified event.

Parameters:

content - The content to notify on

setValidationAttribute

public void setValidationAttribute(ModifiableDefaultContent content,
 LocalDate validationDate,
 UserIdentity user,
 String comment,
 PilotageStatusHelper.PilotageStatus status)

Set the validation attribute (date, login, comment) to the content

Parameters:

content - the content

validationDate - the validation date

user - the user

comment - the comment

status - the pilotage status

removePilotageStatus

public void removePilotageStatus(ModifiableDefaultContent content,
 PilotageStatusHelper.PilotageStatus status)

Remove the validation attribute from the content

Parameters:

content - the content

status - the pilotage status

setMentionValidationAttribute

public boolean setMentionValidationAttribute(ModifiableDefaultContent content,
 LocalDate validationDate,
 UserIdentity user,
 String comment)

Set the validation attribute for 'mention validated' state

Parameters:

content - the content

validationDate - the validation date

user - the user

comment - the comment

Returns:

true if the content has changed.

removeMentionValidationAttribute

public boolean removeMentionValidationAttribute(ModifiableDefaultContent content)

Remove validation attribute for 'mention validated' state

Parameters:

content - the content

Returns:

true if the content has changed.

setOrgUnitValidationAttribute

public boolean setOrgUnitValidationAttribute(ModifiableDefaultContent content,
 LocalDate validationDate,
 UserIdentity user,
 String comment)

Set the validation attribute for 'orgunit validated' state

Parameters:

content - the content

validationDate - the validation date

user - the user

comment - the comment

Returns:

true if the content has changed.

removeOrgUnitValidationAttribute

public boolean removeOrgUnitValidationAttribute(ModifiableDefaultContent content)

Remove validation attribute for 'orgunit validated' state

Parameters:

content - the content

Returns:

true if the content has changed.

setCFVUValidationAttribute

public boolean setCFVUValidationAttribute(ModifiableDefaultContent content,
 LocalDate validationDate,
 UserIdentity user,
 String comment)

Set the validation attribute for 'CFVU validated' state

Parameters:

content - the content

validationDate - the validation date

user - the login

comment - the comment

Returns:

true if the content has changed.

removeCFVUValidationAttribute

public boolean removeCFVUValidationAttribute(ModifiableDefaultContent content)

Remove validation attribute for 'CFVU validated' state

Parameters:

content - the content

Returns:

true if the content has changed.

setCFVUMCCValidationAttribute

public boolean setCFVUMCCValidationAttribute(ModifiableDefaultContent content,
 LocalDate validationDate,
 UserIdentity user,
 String comment)

Set the validation attribute for 'CFVU MCC validated' state

Parameters:

content - the content

validationDate - the validation date

user - the user

comment - the comment

Returns:

true if the content has changed.

removeCFVUMCCValidationAttribute

public boolean removeCFVUMCCValidationAttribute(ModifiableDefaultContent content)

Remove validation attribute for 'CFVU MCC validated' state

Parameters:

content - the content

Returns:

true if the content has changed.

getMentionValidationDate

public LocalDate getMentionValidationDate(Content content)

Get mention validation date

Parameters:

content - the content

Returns:

the validation date

getMentionValidationComment

public String getMentionValidationComment(Content content)

Get mention validation comment

Parameters:

content - the content

Returns:

the validation comment

getMentionValidationAuthor

public UserIdentity getMentionValidationAuthor(Content content)

Get mention validation author

Parameters:

content - the content

Returns:

the validation author

getOrgUnitValidationDate

public LocalDate getOrgUnitValidationDate(Content content)

Get orgUnit validation date

Parameters:

content - the content

Returns:

the validation date

getOrgUnitValidationComment

public String getOrgUnitValidationComment(Content content)

Get orgUnit validation comment

Parameters:

content - the content

Returns:

the validation comment

getOrgUnitValidationAuthor

public UserIdentity getOrgUnitValidationAuthor(Content content)

Get orgUnit validation author

Parameters:

content - the content

Returns:

the validation author

getCFVUValidationDate

public LocalDate getCFVUValidationDate(Content content)

Get CFVU validation date

Parameters:

content - the content

Returns:

the validation date

getCFVUValidationComment

public String getCFVUValidationComment(Content content)

Get CFVU validation comment

Parameters:

content - the content

Returns:

the validation comment

getCFVUValidationAuthor

public UserIdentity getCFVUValidationAuthor(Content content)

Get CFVU validation author

Parameters:

content - the content

Returns:

the validation author

getCFVUMCCValidationDate

public LocalDate getCFVUMCCValidationDate(Content content)

Get CFVU MMC validation date

Parameters:

content - the content

Returns:

the validation date

getCFVUMCCValidationComment

public String getCFVUMCCValidationComment(Content content)

Get CFVU MCC validation comment

Parameters:

content - the content

Returns:

the validation comment

getCFVUMCCValidationAuthor

public UserIdentity getCFVUMCCValidationAuthor(Content content)

Get CFVU MCC validation author

Parameters:

content - the content

Returns:

the validation author

removePilotageWorkflow

public boolean removePilotageWorkflow(ModifiableDefaultContent content)

Remove the pilotage workflow metadata.

Parameters:

content - The content to clean

Returns:

true if the content has changed

saveContent

protected boolean saveContent(ModifiableDefaultContent content)

Save the content if needed, add a version (checkpoint) and move the Live label if the last version was validated.

Parameters:

content - The content to save

Returns:

true if the content has changed