Package org.ametys.odf.course

Class ShareableCourseStatusHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.course.ShareableCourseStatusHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

Direct Known Subclasses:

WebShareableCourseStatusHelper

public class ShareableCourseStatusHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for shareable course status

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShareableCourseStatusHelper.ShareableStatus	Enumeration for the shareable course status

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__NOTIFICATION_RIGHT_ID	The notification right id
private static String	__PROPOSE_RIGHT_ID	The propose right id
private static String	__PROPOSED_AUTHOR_METADATA	The metadata name for the author of the "proposed" state
private static String	__PROPOSED_DATE_METADATA	The metadata name for the date of the "proposed" state
private static String	__REFUSE_RIGHT_ID	The refusal right id
private static String	__REFUSED_AUTHOR_METADATA	The metadata name for the author of the "refused" state
private static String	__REFUSED_COMMENT_METADATA	The metadata name for the comment of the "refused" state
private static String	__REFUSED_DATE_METADATA	The metadata name for the date of the "refused" state
private static String	__VALIDATE_RIGHT_ID	The validate right id
private static String	__VALIDATED_AUTHOR_METADATA	The metadata name for the author of the "validated" state
private static String	__VALIDATED_DATE_METADATA	The metadata name for the date of the "validated" state
protected ContentHelper	_contentHelper	The content helper
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected I18nUtils	_i18nUtils	The i18n utils
protected ObservationManager	_observationManager	The observation manager
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected RightManager	_rightManager	The right manager
protected UserManager	_userManager	The user manager
static String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
ShareableCourseStatusHelper()

Method Summary

Modifier and Type	Method	Description
protected List<String>	_getBodyI18nParams(User user, Content content)	Get the i18n parameters of mail body text
protected String	_getContentUri(Content content)	Get the content uri
private String	_getFilterListAsString(Content content, String attribute)
protected String	_getFiltersText(Content content)	Get the list of filter as text for the mail body
protected List<String>	_getFooterI18nParams(User user, Content content)	Get the i18n parameters of mail footer text
protected String	_getMailBody(String bodyI18nKey, String footerI18nKey, User user, Content content, String comment)	Get the text body of mail
protected String	_getMailSubject(String subjectI18nKey, Content content)	Get the subject of mail
protected String	_getRequestUri()	Get the request URI.
protected List<String>	_getSubjectI18nParams(Content content)	Get the i18n parameters of mail subject
protected void	_notifyShareableCourseWorkflowModification(Content content)	Send a notification with the content modified event.
protected void	_sendNotificationMail(Content content, Set<UserIdentity> usersNotified, String comment, String mailSubjectKey, String mailBodyKey, String mailFooterKey)	Send mail to users
UserIdentity	getProposedStateAuthor(Content content)	Get 'proposed' state author
ShareableCourseStatusHelper.ShareableStatus	getShareableStatus(Content content)	Get the shareable status of the course
boolean	removeShareableWorkflow(ModifiableContent content)	Remove the shareable course workflow metadata.
void	service(ServiceManager manager)
boolean	setProposedStateAttribute(ModifiableContent content, LocalDate proposeDate, UserIdentity user)	Set the attribute for 'proposed' state
boolean	setRefusedStateAttribute(ModifiableContent content, LocalDate validationDate, UserIdentity user, String comment)	Set the attribute for 'validated' state
boolean	setValidatedStateAttribute(ModifiableContent content, LocalDate validationDate, UserIdentity user)	Set the attribute for 'validated' state
void	setWorkflowStateAttribute(ModifiableContent content, LocalDate validationDate, UserIdentity user, ShareableCourseStatusHelper.ShareableStatus status, String comment, boolean ignoreRights)	Set the workflow state attribute (date, login) 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 Detail

ROLE

public static final String ROLE

The component role.

__PROPOSED_DATE_METADATA

private static final String __PROPOSED_DATE_METADATA

The metadata name for the date of the "proposed" state

See Also:

Constant Field Values

__PROPOSED_AUTHOR_METADATA

private static final String __PROPOSED_AUTHOR_METADATA

The metadata name for the author of the "proposed" state

See Also:

Constant Field Values

__VALIDATED_DATE_METADATA

private static final String __VALIDATED_DATE_METADATA

The metadata name for the date of the "validated" state

See Also:

Constant Field Values

__VALIDATED_AUTHOR_METADATA

private static final String __VALIDATED_AUTHOR_METADATA

The metadata name for the author of the "validated" state

See Also:

Constant Field Values

__REFUSED_DATE_METADATA

private static final String __REFUSED_DATE_METADATA

The metadata name for the date of the "refused" state

See Also:

Constant Field Values

__REFUSED_AUTHOR_METADATA

private static final String __REFUSED_AUTHOR_METADATA

The metadata name for the author of the "refused" state

See Also:

Constant Field Values

__REFUSED_COMMENT_METADATA

private static final String __REFUSED_COMMENT_METADATA

The metadata name for the comment of the "refused" state

See Also:

Constant Field Values

__NOTIFICATION_RIGHT_ID

private static final String __NOTIFICATION_RIGHT_ID

The notification right id

See Also:

Constant Field Values

__PROPOSE_RIGHT_ID

private static final String __PROPOSE_RIGHT_ID

The propose right id

See Also:

Constant Field Values

__VALIDATE_RIGHT_ID

private static final String __VALIDATE_RIGHT_ID

The validate right id

See Also:

Constant Field Values

__REFUSE_RIGHT_ID

private static final String __REFUSE_RIGHT_ID

The refusal right id

See Also:

Constant Field Values

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_observationManager

protected ObservationManager _observationManager

The observation manager

_rightManager

protected RightManager _rightManager

The right manager

_userManager

protected UserManager _userManager

The user manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_contentHelper

protected ContentHelper _contentHelper

The content helper

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

Constructor Detail

ShareableCourseStatusHelper

public ShareableCourseStatusHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getShareableStatus

public ShareableCourseStatusHelper.ShareableStatus getShareableStatus(Content content)

Get the shareable status of the course

Parameters:

content - the content

Returns:

the shareable course status

setWorkflowStateAttribute

public void setWorkflowStateAttribute(ModifiableContent content,
                                      LocalDate validationDate,
                                      UserIdentity user,
                                      ShareableCourseStatusHelper.ShareableStatus status,
                                      String comment,
                                      boolean ignoreRights)

Set the workflow state attribute (date, login) to the content

Parameters:

content - the content

validationDate - the validation date

user - the user

status - the shareable course status

comment - the comment. Can be null

ignoreRights - true to ignore user rights

removeShareableWorkflow

public boolean removeShareableWorkflow(ModifiableContent content)

Remove the shareable course workflow metadata.

Parameters:

content - The content to clean

Returns:

true if the content has changed

setProposedStateAttribute

public boolean setProposedStateAttribute(ModifiableContent content,
                                         LocalDate proposeDate,
                                         UserIdentity user)

Set the attribute for 'proposed' state

Parameters:

content - the content

proposeDate - the proposed date

user - the user

Returns:

true if the content has changed.

setValidatedStateAttribute

public boolean setValidatedStateAttribute(ModifiableContent content,
                                          LocalDate validationDate,
                                          UserIdentity user)

Set the attribute for 'validated' state

Parameters:

content - the content

validationDate - the validation date

user - the login

Returns:

true if the content has changed.

setRefusedStateAttribute

public boolean setRefusedStateAttribute(ModifiableContent content,
                                        LocalDate validationDate,
                                        UserIdentity user,
                                        String comment)

Set the attribute for 'validated' state

Parameters:

content - the content

validationDate - the validation date

user - the login

comment - the comment. Can be null

Returns:

true if the content has changed.

getProposedStateAuthor

public UserIdentity getProposedStateAuthor(Content content)

Get 'proposed' state author

Parameters:

content - the content

Returns:

the 'proposed' state author

_notifyShareableCourseWorkflowModification

protected void _notifyShareableCourseWorkflowModification(Content content)

Send a notification with the content modified event.

Parameters:

content - The content to notify on

_sendNotificationMail

protected void _sendNotificationMail(Content content,
                                     Set<UserIdentity> usersNotified,
                                     String comment,
                                     String mailSubjectKey,
                                     String mailBodyKey,
                                     String mailFooterKey)

Send mail to users

Parameters:

content - the course modified

usersNotified - the list of user to notify

comment - the comment. Can be null

mailSubjectKey - the mail subject i18n key

mailBodyKey - the mail body i18n key

mailFooterKey - the i18n key for footer body

_getMailSubject

protected String _getMailSubject(String subjectI18nKey,
                                 Content content)

Get the subject of mail

Parameters:

subjectI18nKey - the i18n key to use for subject

content - the content

Returns:

the subject

_getSubjectI18nParams

protected List<String> _getSubjectI18nParams(Content content)

Get the i18n parameters of mail subject

Parameters:

content - the content

Returns:

the i18n parameters

_getMailBody

protected String _getMailBody(String bodyI18nKey,
                              String footerI18nKey,
                              User user,
                              Content content,
                              String comment)

Get the text body of mail

Parameters:

bodyI18nKey - the i18n key to use for body

footerI18nKey - the i18n key to use for footer body

user - the caller

content - the content

comment - the comment. Can be null

Returns:

the text body

_getBodyI18nParams

protected List<String> _getBodyI18nParams(User user,
                                          Content content)

Get the i18n parameters of mail body text

Parameters:

user - the caller

content - the content

Returns:

the i18n parameters

_getFooterI18nParams

protected List<String> _getFooterI18nParams(User user,
                                            Content content)

Get the i18n parameters of mail footer text

Parameters:

user - the caller

content - the content

Returns:

the i18n parameters

_getFiltersText

protected String _getFiltersText(Content content)

Get the list of filter as text for the mail body

Parameters:

content - the content

Returns:

the list of filter as text

_getFilterListAsString

private String _getFilterListAsString(Content content,
                                      String attribute)

_getContentUri

protected String _getContentUri(Content content)

Get the content uri

Parameters:

content - the content

Returns:

the content uri

_getRequestUri

protected String _getRequestUri()

Get the request URI.

Returns:

the full request URI.