Package org.ametys.odf.schedulable

Class ArchiveEducationalBookletSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

org.ametys.cms.schedule.AbstractSendingMailSchedulable

org.ametys.odf.schedulable.EducationalBookletSchedulable

org.ametys.odf.schedulable.ArchiveEducationalBookletSchedulable

All Implemented Interfaces:

Schedulable, LogEnabled, PluginAware, Initializable, Component, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ArchiveEducationalBookletSchedulable

public class ArchiveEducationalBookletSchedulable
extends EducationalBookletSchedulable

Schedulable for archive educational booklet.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.odf.schedulable.EducationalBookletSchedulable

EducationalBookletSchedulable.EducationalBookletReport

Nested classes/interfaces inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_ARCHIVE_DATE	Scheduler parameter name of archive date
static final String	PARAM_WORKFLOW_ACTION_ID	Scheduler parameter name of edit workflow action id

Fields inherited from class org.ametys.odf.schedulable.EducationalBookletSchedulable

_contentWorkflowHelper, _EDUCATIONAL_BOOKLET_REPORT, _resolver, _sourceResolver, EDUCATIONAL_BOOKLET_DIR_NAME, PARAM_INCLUDE_SUBPROGRAMS, PARAM_PROGRAM_ITEM_ID

Fields inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_currentUserProvider, _i18nUtils, _mailSender, _sysadminMail, _userHelper

Fields inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

_acceptConcurrentExecution, _context, _description, _iconGlyph, _iconLarge, _iconMedium, _iconSmall, _id, _label, _parameters, _pluginName, _private, _schedulableParameterTypeExtensionPoint, _smanager, _startTime, _userManager, PROGRESSION_TRACKER

Constructor Summary

Constructors

Constructor	Description
ArchiveEducationalBookletSchedulable()

Method Summary

Modifier and Type	Method	Description
protected void	_generateProgramItemsEducationalBooklet(JobExecutionContext context, File bookletDirectory, Map<String,Object> pdfParameters)	Generate educational booklet for each program items
protected Binary	_getEducationalBookletAsBinary(File educationalBookletPDF, Content content, ZonedDateTime votedDate)	Build a binary object from the educational booklet file
protected String	_getMailBodyBaseKey()	The base key for mail bodies.
protected String	_getMailSubjectBaseKey()	The base key for mail subjects.

Methods inherited from class org.ametys.odf.schedulable.EducationalBookletSchedulable

_doExecute, _generateEducationalBookletZip, _generateFile, _generateProgramItemEducationalBookletPDF, _getDownloadLink, _getErrorMailBody, _getErrorMailSubject, _getProgramItemsI18nText, _getSuccessMailBody, _getSuccessMailSubject, _isMailBodyInHTML, service

Methods inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_getRecipient, _sendMail, execute, initialize

Methods inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

acceptConcurrentExecution, configure, contextualize, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, getParameters, getProgressionTracker, isPrivate, setPluginInfo

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

PARAM_ARCHIVE_DATE

public static final String PARAM_ARCHIVE_DATE

Scheduler parameter name of archive date

See Also:

• Constant Field Values

PARAM_WORKFLOW_ACTION_ID

public static final String PARAM_WORKFLOW_ACTION_ID

Scheduler parameter name of edit workflow action id

See Also:

• Constant Field Values

Constructor Details

ArchiveEducationalBookletSchedulable

public ArchiveEducationalBookletSchedulable()

Method Details

_generateProgramItemsEducationalBooklet

protected void _generateProgramItemsEducationalBooklet(JobExecutionContext context,
 File bookletDirectory,
 Map<String,Object> pdfParameters)

Description copied from class: EducationalBookletSchedulable

Generate educational booklet for each program items

Overrides:

_generateProgramItemsEducationalBooklet in class EducationalBookletSchedulable

Parameters:

context - the context

bookletDirectory - the booklet directory

pdfParameters - the parameters to generate PDF

_getEducationalBookletAsBinary

protected Binary _getEducationalBookletAsBinary(File educationalBookletPDF,
 Content content,
 ZonedDateTime votedDate)
                                         throws IOException

Build a binary object from the educational booklet file

Parameters:

educationalBookletPDF - the educational booklet file

content - the content

votedDate - the voted date for the educational booklet

Returns:

the binary

Throws:

IOException - if an error occurred

_getMailSubjectBaseKey

protected String _getMailSubjectBaseKey()

Description copied from class: EducationalBookletSchedulable

The base key for mail subjects.

Overrides:

_getMailSubjectBaseKey in class EducationalBookletSchedulable

Returns:

The prefix of an I18N key

_getMailBodyBaseKey

protected String _getMailBodyBaseKey()

Description copied from class: EducationalBookletSchedulable

The base key for mail bodies.

Overrides:

_getMailBodyBaseKey in class EducationalBookletSchedulable

Returns:

The prefix of an I18N key